User Sync

POST

/users/sync

Synchronizes or creates a user profile and linking them with external system identifiers.

Returns a user profile matched by email, creating one if it doesn't exist, and permanently links it to your external system ID (which can't be changed once set).

Request

Authorization

Add parameter in header

X-Api-Key

Example:

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

Query Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.atlas.kitchen/admin/v1/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

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

Modified at 2025-05-26 05:17:36

Outlet Stocks