Skip to main content
POST
/
v1
/
users
/
email-only
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"
}
'
{
  "email": "iamagoodblob@blobsrus.co",
  "userId": "9e8719d9-276a-4964-9395-a493189a247c"
}
Creates or updates an email-only user. An email-only user is a recipient of a delivery that isn’t associated with an Omni account. If Omni matches the provided email to an existing email-only user, the user will be updated according to the userAttributes in the request body.
Need to include multiple email-only users? Use the Create or update multiple email-only users endpoint.

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
​
email
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.

​
email
string<email>

The email address of the created or updated user.

​
userId
string<uuid>

The unique identifier of the email-only user.