Sign in
End User Accounts

Create an end-user account

Create an end-user account for a tenant.

post/v2/{tenant_slug}/enduseraccounts

Path parameters

tenant_slugstring required

Tenant DNS slug (lowercase letters, digits, and hyphens; 3-100 characters).

Example:demo-retail

Tenant DNS slug (lowercase letters, digits, and hyphens; 3-100 characters).

Request body

tenant_idstring uuid required

Identifier of the tenant that owns this account

website_account_idstring

Identifier of the end user's website account; defaults to UNKNOWN when the account cannot be resolved

crm_account_idstring nullable

Optional identifier linking this account to a record in the tenant's CRM system

is_blockedboolean

True when the account is blocked from accessing services

is_quarantinedboolean

True when the account is quarantined pending manual review

is_fraudulentboolean

True when the account has been confirmed as fraudulent

last_session_updated_onstring date-time nullable

Time the most recent session for this account was updated (RFC 3339 / ISO 8601 UTC)

Example request

{
  "tenant_id": "00000000-0000-4000-8000-000000000000",
  "website_account_id": "account-abc123"
}

Response

Created

Example response

{
  "data": {
    "tenant_id": "00000000-0000-4000-8000-000000000000",
    "website_account_id": "account-abc123",
    "crm_account_id": "crm-abc456",
    "last_session_updated_on": "2024-01-15T10:30:00Z"
  }
}