Skip to content

Create contact

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

POST /v1/contacts

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

Request body

Content-Type: application/json

  • profileId (string) required
  • name (string) required
  • email (string)
  • company (string)
  • tags (array)
  • isSubscribed (boolean)
  • notes (string)
  • accountId (string) — Optional. Creates a channel if provided with platform + platformIdentifier
  • platform (string)
  • platformIdentifier (string)
  • displayIdentifier (string)

Responses

200 — Contact created

  • success (boolean)
  • contact (object)
  • channel (object) — Created when accountId, platform, and platformIdentifier are provided
  • warning (string)

401

409 — Duplicate contact