Add a contact to an account

POST/accounts/{storeId}/contacts

Requires scope: write:contacts

Parameters

ParameterInTypeDescription
storeIdrequiredpathstring
Idempotency-KeyrequiredheaderstringStable logical request ID required for every machine mutation; exact retries replay and changed inputs conflict.

Request body

FieldTypeAllowed valuesDescription
first_namestringany string
last_namestringany string
namestringany string
rolestringany string
emailstringany string
email_permission_statusstringunknownconfirmedwithdrawnConfirmed only when the recipient gave permission; discovery or verification is insufficient.
email_permission_sourcestringdirect_requestwebsite_formeventexisting_relationshipimported_consentother
email_permission_confirmed_atstringany string
email_permission_notestringany string

Responses

StatusDescription
201Created
400Invalid body
401Missing or invalid API key
403Key lacks the required scope
404Account not found
429Rate limit exceeded (see Retry-After)
Is this page helpful?