Skip to main content
POST
/
users
/
sync
User Sync
curl --request POST \
  --url https://api.atlas.kitchen/admin/v1/users/sync \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Merchant-Id: <api-key>' \
  --data '
{
  "email": "<string>",
  "mobile_number": "<string>",
  "name": "<string>",
  "date_of_birth": "2023-12-25",
  "marketing_consent": true,
  "title": "<string>",
  "external_user_id": "<string>",
  "external_user_type": "<string>",
  "is_guest": true,
  "should_identify_guest": true
}
'
{
  "id": 123,
  "email": "<string>",
  "mobile_number": "<string>",
  "name": "<string>",
  "date_of_birth": "2023-12-25",
  "marketing_consent": true,
  "title": "<string>",
  "external_user_links": [
    {
      "external_user_id": "<string>",
      "external_user_type": "<string>"
    }
  ]
}

Authorizations

X-Api-Key
string
header
required

Your API key provided during onboarding. Example c2fb5ae6ea99c37d...

X-Merchant-Id
string
header
required

Your numeric merchant ID. Example 1

Body

application/json
email
string
mobile_number
string
name
string
date_of_birth
string<date>
title
string
external_user_id
string
external_user_type
string
is_guest
boolean
should_identify_guest
boolean

Response

Synced user

id
integer
email
string
mobile_number
string
name
string
date_of_birth
string<date> | null
title
string | null