POST
Create or get a customer

Authorizations

Authorization
string
header
required

Your API key, sent as Authorization: Bearer <key>. Create keys in the Cerium dashboard. Keep them on your servers only.

Body

application/json
name
string
required
Maximum string length: 255
Example:

"Ada Obi"

email
string<email>
required
Maximum string length: 320
Example:

"ada@example.com"

externalId
string

Your own id for this customer. With the email, it decides whether this is a customer you already sent: the same externalId, or the same email, is the same customer.

Pattern: ^[A-Za-z0-9._:@+-]{1,128}$
Example:

"user_8271"

phone
string

International format.

Pattern: ^\+[1-9]\d{6,14}$
Example:

"+2348012345678"

device
object

A push-notification device to add to the customer.

Response

You had already sent this customer. It is returned unchanged.

message
string
status
string
Example:

"success"

data
object