Create contact
Creates a new contact in the project. Contacts represent email recipients and can hold custom properties, segment memberships, and topic subscription preferences. If a contact with the same email already exists the request returns 409.
Requirements
- Permission:
contacts:write. - Project access: the path project must match the API key’s project.
- HTTP rate limit: 200 requests per 60 seconds per API key.
Authorizations
Project-bound Apollo Signal API key. Keys begin with ap_signal_ and must carry the permission shown on the operation.
Path Parameters
The project to create the contact in.
Body
Email address, optional name, and optional custom property values.
Contact profile, custom fields, and initial audience memberships.
Project-unique contact email address.
Optional contact first name.
Optional contact last name.
Optional phone number stored on the contact profile.
Custom property key/value pairs for this project. Defaults to an empty object.
Segments to join when the contact is created. Defaults to an empty list.
Explicit topic preferences to set at creation. Defaults to an empty list.
Whether the contact is globally unsubscribed. Defaults to false.
Response
Contact created.