User Sync - Atlas Open API

Request

Authorization

Add parameter in header

X-Api-Key

Example:

X-Api-Key: ********************

Query Params

email

string

required

The user's email address

Example:

Email address

mobile_number

string

required

The user's phone number with country code (like +65)

Example:

Mobile number

name

string

required

The user's complete name

Example:

Full name

date_of_birth

string

optional

When the user was born, written as YYYY-MM-DD

Example:

Date of birth

marketing_consent

string

optional

Whether the user agrees to receive marketing messages

Example:

Marketing consent

title

string

optional

How to address the user (like Mr, Ms, Dr)

Example:

Title

external_user_id

string

required

A unique ID from your system to identify this user - this is required and cannot be changed once set

Example:

External user id

external_user_type

string

required

What kind of external system you're using (like 'google')

Example:

External user type

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://api.atlas.kitchen/users/sync?email=Email address&mobile_number=Mobile number&name=Full name&date_of_birth=Date of birth&marketing_consent=Marketing consent&title=Title&external_user_id=External user id&external_user_type=External user type' \
--header 'X-Api-Key;'

Responses

🟢200Success

application/json

Body

id

integer

required

email

string

required

mobile_number

string

required

name

string

required

date_of_birth

string

required

marketing_consent

boolean

required

title

string

required

external_user_links

array [object {2}]

required

external_user_id

string

optional

external_user_type

string

optional

Example

{
  "id": 123,
  "email": "john.doe@example.com",
  "mobile_number": "+1234567890",
  "name": "John Doe",
  "date_of_birth": "1990-01-01",
  "marketing_consent": true,
  "title": "Mr.",
  "external_user_links": [
    {
      "external_user_id": "ext_123",
      "external_user_type": "facebook"
    }
  ]
}

🔴500Server Error

🟠401Unauthorized