Skip to main content
PATCH
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

Project identifier. For API-key authentication, it must match the project bound to the key.

contactId
string
required

Contact identifier in this project.

Body

application/json

Fields to update.

Mutable contact fields; the email address cannot be changed.

firstName
string

Replacement first name.

lastName
string

Replacement last name.

phone
string

Replacement phone number.

properties
Map<String,String> · object

Replacement custom property map.

unsubscribed
boolean

Replacement global unsubscribe state.

Response

Updated contact.

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