Documentation | Tenants › Bulk › Bulk Delete Tenants

Tenants

tenants

Methods

Delete A Tenant -> string

delete/v1/tenants/{tenant_id}

Delete a tenant

Get A Tenant ->

Tenant

get/v1/tenants/{tenant_id}

Get a tenant

List Tenants -> EntriesCursor<

Tenant

get/v1/tenants

List tenants

Set A Tenant ->

Tenant

put/v1/tenants/{tenant_id}

Set a tenant

Domain types

InlineTenantRequest = string |

TenantRequest

An inline tenant request

Tenant = { id, __typename }

A tenant entity

TenantRequest = { id, channel_data, preferences, 1 more... }

A tenant to be set in the system

Tenants

Bulk

tenants.bulk

Methods

Bulk Delete Tenants ->

BulkOperation

post/v1/tenants/bulk/delete

Bulk delete tenants

Parameters

tenant_ids: Array<string>

The IDs of the tenants to delete

Response fields

BulkOperation

Request example

curl https://api.knock.app/v1/tenants/bulk/delete \
    -X POST \
    -H "Authorization: Bearer $KNOCK_API_KEY" \
    -d '{}'

200Example

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "__typename": "BulkOperation",
  "estimated_total_rows": 1000,
  "inserted_at": "2024-05-22T12:00:00Z",
  "name": "Bulk operation name",
  "processed_rows": 0,
  "status": "queued",
  "success_count": 0,
  "updated_at": "2024-05-22T12:00:00Z",
  "completed_at": null,
  "error_count": 0,
  "error_items": [
    {
      "id": "id",
      "collection": "collection"
    }
  ],
  "failed_at": null,
  "started_at": null
}

Bulk Set Tenants ->

BulkOperation

post/v1/tenants/bulk/set

Bulk set tenants