Skip to content

Area: Developers

POST

Record a registration

Path
/register
Auth
Secret key · server only
POST
/register
curl --request POST \
--url https://releva.ai/api/v0/register \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "id": "DEMO-CUST-1001", "email": "maria@example.com", "firstName": "Maria", "lastName": "Example", "tags": [ "registered-online" ], "birthday": "1990-05-17" }'

Call when a customer completes sign-up. Creates or updates the profile and sets registeredAt to the current time (every call re-stamps it). tags replaces the profile’s tags. Consent is not changed. Unknown fields are ignored.

Media typeapplication/json

At least one of id, email or phoneNumber is required. Unknown fields are ignored.

object
id
string
email
string format: email
phoneNumber

International form (+359888000101) or national form (0888000101). National numbers and values with spaces or dashes (5-15 characters) are converted to +<digits> with the dialling code of the domain’s country before validation. The result must match ^\+\d{1,31}$.

string
<= 32 characters
firstName
string
lastName
string
tags

Replaces the profile’s tags.

Array<string>
birthday

YYYY-MM-DD only.

string format: date

Example

{
"id": "DEMO-CUST-1001",
"email": "maria@example.com",
"firstName": "Maria",
"lastName": "Example",
"tags": [
"registered-online"
],
"birthday": "1990-05-17"
}

Accepted for asynchronous processing.

Media typeapplication/json
object
0

Example

{}

Authentication or validation error.

Media typeapplication/json
object
message
required

Human-readable error. Several validation errors are joined with a space.

string

Examples

{
"message": "At least one of (id",
"email": null,
"phoneNumber) is required!": null
}

The domain is disabled.

Media typeapplication/json
object
message
required

Human-readable error. Several validation errors are joined with a space.

string

Example

{
"message": "Domain is disabled. Please reach out to support@releva.ai to enable it."
}

Request body larger than 800 KB.

Media typeapplication/json
object
message
required

Human-readable error. Several validation errors are joined with a space.

string

Example

{
"message": "request entity too large"
}

Unexpected server error.

Media typeapplication/json
object
message
required

Human-readable error. Several validation errors are joined with a space.

string

Example

{
"message": "An internal error occurred."
}