Tenants

Set a tenant

Changed on

Sets a tenant within an environment, performing an upsert operation. Any existing properties will be merged with the incoming properties.

put/v1/tenants/{id}

Request

  • Base URL: https://api.knock.app
  • URL: https://api.knock.app/v1/tenants/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

The unique identifier for the tenant.

Query parameters

resolve_full_preference_settingsboolean

When true, merges environment-level default preferences into the tenant's settings.preference_set field before returning the response. Defaults to false.

Request body

namestring nullable

An optional name for the tenant.

Example request

{
  "name": "Jurassic Park",
  "settings": {
    "branding": {
      "icon_url": "https://example.com/trex_silhouette_icon.png",
      "logo_url": "https://example.com/amber_fossil_logo.png",
      "primary_color": "#DF1A22",
      "primary_color_contrast": "#FFDE00"
    }
  }
}

Response

OK

__typenamestring required

The typename of the schema.

idstring required

The unique identifier for the tenant.

namestring nullable

An optional name for the tenant.

Example response

{
  "__typename": "Tenant",
  "id": "tenant_jp123",
  "name": "Jurassic Park",
  "settings": {
    "branding": {
      "dark_icon_url": "https://example.com/trex_silhouette_icon_dark.png",
      "dark_logo_url": "https://example.com/amber_fossil_logo_dark.png",
      "dark_primary_color": "#FFFFFF",
      "dark_primary_color_contrast": "#000000",
      "icon_url": "https://example.com/trex_silhouette_icon.png",
      "logo_url": "https://example.com/amber_fossil_logo.png",
      "primary_color": "#DF1A22",
      "primary_color_contrast": "#FFDE00"
    },
    "preference_set": {
      "categories": {
        "safety": {
          "channel_types": {
            "email": true,
            "push": true
          }
        }
      },
      "channel_types": {
        "email": true,
        "in_app_feed": true,
        "push": true
      },
      "id": "default",
      "workflows": {
        "park_alert": {
          "channel_types": {
            "email": true,
            "push": true
          }
        }
      }
    }
  }
}

Changes

  • 6f88a4142e34Revision changes
    • info

      added the new optional request property ///////

    • info

      added the new optional request property ///////

    • info

      added the new optional request property ///////

    • info

      added the new optional request property ///////

    • info

      added the new optional request property ///////

    • info

      added the new optional request property ///////

  • fcba175ebc76Revision changes
    • breaking

      the request property /// became not nullable

    • breaking

      the /// request property type changed from boolean to no type

    • breaking

      the //// response's property type changed from boolean to no type for status

    • info

      added subschema #1 subschema #3 to the /// request property anyOf list

    • info

      added subschema #1 subschema #3 to the //// response property anyOf list for the response status