AI Connect OSAI Connect OS Documentation
Contacts

Contacts

Create, read, update, and upsert contacts via /api/v1/contacts.

Base path

https://api.aiconnectos.com/v1/contacts

Custom fields

Custom fields are keyed by the field's UUID, not its key. Fetch the field UUID from GET https://api.aiconnectos.com/v1/custom-fields (in the dashboard for now - public API endpoint coming soon) before writing to customFields.

Fields

FieldTypeNotes
iduuidAI Connect OS-issued.
externalIdstring?Your system's id, for upserts via matchOn: "externalId".
firstNamestring?
lastNamestring?
emailstring?Validated, normalized to lowercase.
phonestring?E.164 format required.
companyIduuid?FK to companies.
tagsstring[]Free-form. Reused tags are auto-suggested in UI.
customFieldsobjectUUID-keyed JSON.
sourcestring?Attribution string (e.g. "meta-lead-ad", "calendly-import").
createdAtiso8601
updatedAtiso8601

Deletes are soft

DELETE hides the record from listings but keeps it for 30 days for audit. Permanent deletion requires the dashboard's privacy tooling.

On this page