Bulk manage email-only users

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": "iamagoodblob@blobsrus.co"
    },
    {
      "email": "blobmanager@blobsrus.co"
    }
  ]
}
'

{
  "results": [
    {
      "email": "iamagoodblob@blobsrus.co",
      "userId": "1e23dadc-961b-4a21-b36b-17168130fc3f"
    },
    {
      "email": "blobmanager@blobsrus.co",
      "userId": "e9d19f71-0b59-4f8e-8343-a75d30576d28"
    }
  ]
}

{
  "error": "<response_code>",
  "message": "<error_reason>"
}

{
  "error": "<response_code>",
  "message": "<error_reason>"
}

{
  "error": "<response_code>",
  "message": "<error_reason>"
}

POST

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": "iamagoodblob@blobsrus.co"
    },
    {
      "email": "blobmanager@blobsrus.co"
    }
  ]
}
'

{
  "results": [
    {
      "email": "iamagoodblob@blobsrus.co",
      "userId": "1e23dadc-961b-4a21-b36b-17168130fc3f"
    },
    {
      "email": "blobmanager@blobsrus.co",
      "userId": "e9d19f71-0b59-4f8e-8343-a75d30576d28"
    }
  ]
}

{
  "error": "<response_code>",
  "message": "<error_reason>"
}

{
  "error": "<response_code>",
  "message": "<error_reason>"
}

{
  "error": "<response_code>",
  "message": "<error_reason>"
}

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

Show child attributes

Response

Email-only users created or updated successfully.

results

object[]

An array of created or updated email-only users.

Show child attributes

Manage email-only user

List schedule recipients

⌘I

Getting started

AI APIs

API token APIs

Connection APIs

Content APIs

Dashboard APIs

Document APIs

Folder APIs

Label APIs

Model APIs

Query APIs

Schedule APIs

Upload APIs

User APIs

User group APIs

Bulk manage email-only users

Authorizations

Body

Response