Bulk delete email-only users

curl --request DELETE \
  --url https://{instance}.omniapp.co/api/v1/users/email-only/bulk \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "userIds": [
    "9e8719d9-276a-4964-9395-a493e1ba5f64"
  ]
}
'

{
  "deleted": [
    {
      "email": "user@example.com",
      "userId": "9e8719d9-276a-4964-9395-a493e1ba5f64"
    }
  ],
  "notFound": {
    "emails": [
      "unknown@example.com"
    ],
    "userIds": []
  }
}

{
  "detail": "<string>",
  "status": 400
}

{
  "detail": "Unauthorized: Missing or invalid API key",
  "status": 401
}

{
  "detail": "<string>",
  "status": 403
}

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

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

DELETE

users

email-only

bulk

curl --request DELETE \
  --url https://{instance}.omniapp.co/api/v1/users/email-only/bulk \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "userIds": [
    "9e8719d9-276a-4964-9395-a493e1ba5f64"
  ]
}
'

{
  "deleted": [
    {
      "email": "user@example.com",
      "userId": "9e8719d9-276a-4964-9395-a493e1ba5f64"
    }
  ],
  "notFound": {
    "emails": [
      "unknown@example.com"
    ],
    "userIds": []
  }
}

{
  "detail": "<string>",
  "status": 400
}

{
  "detail": "Unauthorized: Missing or invalid API key",
  "status": 401
}

{
  "detail": "<string>",
  "status": 403
}

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

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

Authorizations

Authorization

string

header

required

Can be either an Organization API Key or Personal Access Token (PAT).

Include in the Authorization header as: Bearer YOUR_TOKEN

Body

application/json

Option 1
Option 2

emails

string<email>[]

required

Email addresses of the email-only users to delete

Minimum array length: 1

Example:

["user@example.com"]

userIds

string<uuid>[]

IDs of the email-only users to delete. Use the List email-only users endpoint to retrieve IDs.

Example:

["9e8719d9-276a-4964-9395-a493e1ba5f64"]

Response

The email-only users that were deleted, and any identifiers that didn't match an email-only user in your organization.

deleted

object[]

required

The email-only users that were deleted

Show child attributes

notFound

object

required

Requested identifiers that didn't match an email-only user in the organization

Show child attributes

Getting started

Who am I?

Administration APIs

AI APIs

App APIs

Connection APIs

Content APIs

Dashboard APIs

Document APIs

Embed APIs

Folder APIs

Label APIs

Model APIs

Query APIs

Schedule APIs

Upload APIs

User APIs

User group APIs

Bulk delete email-only users

Authorizations

Body

Response