Skip to main content
POST
TypeScript

Authorizations

Authorization
string
header
required

Project-bound Apollo Signal API key. Keys begin with ap_signal_ and must carry the permission shown on the operation.

Path Parameters

projectId
string
required

The project to create the contact in.

Body

application/json

Email address, optional name, and optional custom property values.

Contact profile, custom fields, and initial audience memberships.

email
string<email>
required

Project-unique contact email address.

firstName
string

Optional contact first name.

lastName
string

Optional contact last name.

phone
string

Optional phone number stored on the contact profile.

properties
Map<String,String> · object

Custom property key/value pairs for this project. Defaults to an empty object.

segments
SegmentRef · object[]

Segments to join when the contact is created. Defaults to an empty list.

topics
TopicSubscriptionBody · object[]

Explicit topic preferences to set at creation. Defaults to an empty list.

unsubscribed
boolean
default:false

Whether the contact is globally unsubscribed. Defaults to false.

Response

Contact created.

createdAt
string
required
email
string
required
id
string
required
object
string
required
projectId
string
required
properties
Map<String,String> · object
required
segments
string[]
required
topics
TopicSubscriptionResponse · object[]
required
unsubscribed
boolean
required
updatedAt
string
required
firstName
string
lastName
string
phone
string
profileImageUrl
string