Contacts
Create or update a contact
Creates a new contact or updates an existing one (upsert).
Lookup order:
- If _id is provided, finds by ID.
- Otherwise finds by first email address.
- If no match is found, creates a new contact.
Body formats — either native or legacy (capitalized keys) are accepted:
Native: firstname, lastname, email (string or array), phone (array of {number, type}), typeId, contactType, isCompany, title, company, imageUrl, customFields
Legacy: "First Name", "Last Name", Email, "Mobile Phone", "Work Phone", "Home Phone", "Contact Type", Title, Company
Returns the enriched contact with custom fields populated by their type definitions.
post/api/contacts
Request
- Base URLhttps://core-api.getaptly.com
- Auth
- API key in header x-token
- or API key in header Authorization
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Request body
Response
Contact created or updated.
Changes
No recorded changes to this operation across all 1 revision of this API.