Skip to main content
POST
Request a profile data export

Authorizations

x-api-key
string
header
required

Unified API key for server-side SDK and API integrations

Body

application/json
profileId
string<uuid>

The Profile's ID.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
email
string<email>

The Profile's email, instead of profileId. Matched without regard to case.

Pattern: ^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

Response

Default Response

created
boolean
required

False when the Profile already had an export pending or running; that request is returned instead of starting another.

request
object
required