Sign in
Contacts

Create contact

Create a new contact. Optionally create a platform channel in the same request by providing accountId, platform, and platformIdentifier.

post/v1/contacts

Request body

profileIdstring required
namestring required
emailstring
companystring
tagsstring[]
isSubscribedboolean
notesstring
accountIdstring

Optional. Creates a channel if provided with platform + platformIdentifier

platform'instagram' | 'facebook' | 'telegram' | 'twitter' | 'bluesky' | 'reddit' | 'whatsapp' | 'slack' | 'sms'

Channel platform. Only the enum values support contact channels; any other platform is rejected with code platform_not_supported.

platformIdentifierstring
displayIdentifierstring

Response

Contact created

successboolean
warningstring

Changes