OMomniapp
Users

Create or update email-only user

Changed on
post/api/v1/users/email-only

Request

  • Base URL
    https://omniapp.co (the document declares no server; this is the origin it was published from)
  • URL
    https://omniapp.co/api/v1/users/email-only
  • Auth
    HTTP bearer

Request body

emailstring email required

Email address for the user

userAttributesobject

User attributes to set, keyed by attribute name. A value is a string, a number, a boolean, or an array of those for a multi-value attribute; null, "" or [] removes the attribute. Attributes not named are left unchanged. A boolean is stored as "true" or "false", so only a string-type attribute accepts it. A number is accepted only for a number-type attribute and is stored as a string, so send anything beyond the JSON safe integer range (2^53 - 1) as a string or it loses precision before Omni sees it.

Example request

{
  "email": "user@example.com"
}

Response

Email-only user created or updated successfully

emailstring email required

Email address of the created user

userIdstring uuid required

ID of the created user

Example response

{
  "email": "user@example.com"
}

Changes

  • f848cf0d4cdbRevision changes
    • breaking

      request body became required

    • info

      request property / list-of-types was widened by adding types array to media type application/json