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
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
Request Request Example
Shell
JavaScript
Java
Swift
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;'
