Documentation | Tenants › Set A Tenant

API Reference

Bulk Operations

Delete a tenant

Tenants

tenants

Methods

Delete A Tenant -> string

delete/v1/tenants/{tenant_id}

Delete a tenant

Get A Tenant ->

get/v1/tenants/{tenant_id}

Get a tenant

List Tenants -> EntriesCursor<

>

get/v1/tenants

List tenants

Set A Tenant ->

put/v1/tenants/{tenant_id}

Set a tenant

Parameters

tenant_id: string

Response fields

Request example

curl https://api.knock.app/v1/tenants/$TENANT_ID \
    -X PUT \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $KNOCK_API_KEY" \
    -d '{
      "channel_data": {
        "97c5837d-c65c-4d54-aa39-080eeb81c69d": {
          "data": {
            "tokens": [
              "push_token_xxx"
            ]
          }
        }
      },
      "preferences": {
        "default": {}
      }
    }'

200Example

{
  "id": "tenant_123",
  "__typename": "Tenant"
}

Domain types

InlineTenantRequest = string |

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

Bulk

tenants.bulk

Methods

Bulk Delete Tenants ->

post/v1/tenants/bulk/delete

Bulk delete tenants

Bulk Set Tenants ->

post/v1/tenants/bulk/set

Bulk set tenants