Manage email-only user

curl --request POST \ --url https://{instance}.omniapp.co/api/v1/users/email-only \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "email": "iamagoodblob@blobsrus.co" } '

Authorizations

Authorization

string

header

required

Requires an Organization API Key. Personal Access Tokens (PATs) are not supported for this endpoint.

Include in the Authorization header as: Bearer ORGANIZATION_API_KEY

Body

application/json

string<email>

required

The user's email address.

userAttributes

object

An object defining the user's user attributes. Attributes are represented as key/value pairs, where the keys map to the IDs of user attributes (the Reference column in the User attributes page) defined in Omni.

When providing user attributes, note that:

omni_user_timezone is the only supported system attribute
Values must match the user attribute's specified type. For example, number attribute values must be numbers such as 1, 10, etc.
Multi-value attributes should be provided using arrays. For example: ["US","EU"] or [1, 10]

To unset attributes:

null values
"" - Empty strings for string attributes
[] - Empty arrays for multi-value attributes

Response

Email-only user created or updated successfully.

string<email>

The email address of the created or updated user.

userId

string<uuid>

The unique identifier of the email-only user.

Getting started

Endpoints

Manage email-only user

Authorizations

Body

Response