Send Profile Register Event

The Profile Register API allows you to send information about newly registered profiles to Releva. Unlike the Profile Update API, this API should be called at the time a user completes their registration.

Imporant: If you have a “subscribe to marketing” checkbox on your user registration page, please also call the Profile Subscribe API to mark the newly created users as subscribed. Alternatively, call the Profile Update API to send us a subscribe date and a registration date with a single request.

Request Parameters #

You may perform requests to the API using the following curl equivalent:

curl -H 'Content-Type: application/json' -H 'Authorization: Bearer <secretKey>' -XPOST https://releva.ai/api/v0/register -d'{
    "id": "custId1234",
    "email": "info@releva.ai",
    "firstName": "Georgi",
    "lastName": "Georgiev",
    "phoneNumber": "+359....",
    "tags": [
        "availabe",
        "acceptingMessages"
    ],
    "birthday": "1989-11-15"
}'

The profile Object #

A successful response will return HTTP Status 202 with an empty response body ({}).

Response Format #

An error response will return a HTTP 4xx or 5xx status code and have the following structure:

{
  "message": "A description of the error and how to fix it, if it's a client error."
}