Sign in

v1

latestOpenAPI 3.1.02026-07-2618690613.4 KB
Schedule recipients

Manage email-only user

Create or update 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.

<Tip> Need to include multiple email-only users? Use the [Create or update multiple email-only users](/api/schedule-recipients/bulk-manage-email-only-users) endpoint. </Tip>
post/v1/users/email-only

Request body

emailstring email required

The user's email address.

userAttributesobject

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.

emailstring email

The email address of the created or updated user.

userIdstring uuid

The unique identifier of the email-only user.