Skip to content

Area: Developers

POST

Export a profile's data

Path
/profiles/exports
Auth
Secret key · server only
POST
/profiles/exports
curl --request POST \
--url https://releva.ai/api/v0/profiles/exports \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "email": "maria@example.com", "sendToEmail": "privacy@demo-store.example.com" }'

Starts an asynchronous export of everything Releva holds about one person: profile rows, devices, events and attribution records, including those of profiles merged into it. When it is ready, a download link (valid for 7 days) is e-mailed to sendToEmail. Pass exactly one of email, profileId or phoneNumber.

Media typeapplication/json

Exactly one of email, profileId or phoneNumber is required (checked after validation).

object
sendToEmail
required

Receives the download link.

string format: email
email
string format: email
profileId
string
phoneNumber

+ followed by the international dialling code and number, digits only (2-32 characters).

string
/^\+\d{1,31}$/

Example

{
"email": "maria@example.com",
"sendToEmail": "privacy@demo-store.example.com"
}

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": "The 'sendToEmail' field is required."
}

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."
}