Skip to main content
POST
/
v1
/
users
/
email-only
/
bulk
curl --request POST \
  --url https://{instance}.omniapp.co/api/v1/users/email-only/bulk \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "users": [
    {
      "email": "[email protected]"
    },
    {
      "email": "[email protected]"
    }
  ]
}
'
{
  "results": [
    {
      "email": "[email protected]",
      "userId": "1e23dadc-961b-4a21-b36b-17168130fc3f"
    },
    {
      "email": "[email protected]",
      "userId": "e9d19f71-0b59-4f8e-8343-a75d30576d28"
    }
  ]
}

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
​
users
object[]
required

An array of user objects, which includes email and userAttributes properties. Up to 20 users can be included in each request.

Maximum array length: 20

Response

Email-only users created or updated successfully.

​
results
object[]

An array of created or updated email-only users.