Create Or Bulk Upsert Contacts

POST /v2/partner/contacts

Required scopes

partner:contacts:write

Tokens missing any required scope return 401 scope_missing. See Auth & Scopes for issuance.

Operation

Operation ID createOrBulkUpsertContacts
Tags Audience

Parameters

Name In Type Description
X-Operator-Override header string Comma-separated override flags. Standard set: destructive, bulk, force, bypass_validation=<validator>, dry_run.

Request body

Required

oneOf<items | object>

Responses

201
Created
object
FieldTypeDescription
id *idUUID v4.
type *enum (1)
contact
team_id *idUUID v4.
unique_idstring
name_firststring
name_laststring
name_titlestring
name_suffixstring
emailstring
phone_homestring
phone_mobilestring
phone_workstring
addressstring
address2string
citystring
statestring
post_codestring
countystring
countrystring
birthdatestring (date)ISO 8601 date 'YYYY-MM-DD'.
timezonetimezoneIANA timezone identifier (e.g. America/Chicago). UTC offsets rejected.
sms_verified *boolean
sms_opted_in *boolean
sms_authorized *boolean
sms_unsubscribed *boolean
email_verified *boolean
email_opted_in *boolean
email_authorized *boolean
email_unsubscribed *boolean
meta_public *object
inserted_at *updated_atRFC 3339 / ISO 8601 timestamp.
updated_at *updated_atRFC 3339 / ISO 8601 timestamp.
last_seen_atupdated_atRFC 3339 / ISO 8601 timestamp.
active_journey_ids *id[]
completed_objective_keys *string[]
403
Forbidden (override required, scope insufficient, resource-level).
object
FieldTypeDescription
errors *object[]

Example request

POST https://api.digitalonboarding.com/v2/partner/contacts
Authorization: Bearer <partner-token>
Content-Type: application/json
Idempotency-Key: <uuid-v4>

{ /* request body matching schema above */ }