For the complete documentation index, see llms.txt. This page is also available as Markdown.

Create user

You can create a user by calling the POST /consents/users endpoint and providing basic information on the user as well as custom metadata that you want to associate with the user.

You can provide following information on users:

  • Organization user ID: a free-form user ID that is specific to your organization and that is used to identify the user within your organization. This could be an email address, a CRM ID, etc. It can be used to query users and events.

  • Metadata: a free-form object with any custom metadata that you want to associate with the user

  • Consents: the consent status of the user for purposes, preferences, channels and vendors for GDPR regulation

Example

POST /consents/users?organization_id={organization_id}

BODY
{
  "organization_user_id": "user@domain.com",
  
  "metadata": {
    ... free-form object with user metadata
  }
}

Last updated