Skip to main content
POST
Add a contact to an account

Authorizations

Authorization
string
header
required

API key issued per entity via Settings > Developers > API Keys. Each key carries scopes (e.g. orders:read, products:write). Bearer token format: Authorization: Bearer ark_live_ent_Test keys use ark_test_ent_. Both are issued per entity
via Settings > Developers > API Keys.

Headers

Idempotency-Key
string
Maximum string length: 255

Path Parameters

id
string<uuid>
required

Body

application/json

Contact payload accepted by both standalone contact endpoints and the atomic-create path in POST /v1/accounts.

Field aliases (all paths, all operations):

  • role accepted as alias for title (public API convenience)
  • phone_main accepted as alias for phone

FIX 2026-05-15 (NEW-GAP-API-V1-ADDRESS-AND-CONTACT-FIELD-MAPPING-INCONSISTENT): Aliases now work in standalone POST/PATCH endpoints (previously only worked in atomic-create).

first_name
string | null
last_name
string | null
email
string | null
phone
string | null

Phone number. Also accepted as phone_main (alias).

phone_main
string | null

Alias for phone.

title
string | null

Job title or role. Also accepted as role (alias).

role
string | null

Alias for title.

website
string | null
is_primary
boolean

Response

Contact created

data
object

A person contact associated with an account.