Policy

Fetch a policy

get/policy/{policyId}/fetch

Request

  • Base URL: https://api.chatbotkit.com/api/v1
  • URL: https://api.chatbotkit.com/api/v1/policy/{policyId}/fetch
  • Auth: HTTP bearer

Path parameters

policyIdstring required

The ID of the policy to retrieve

Response

The policy was fetched successfully

aliasstring nullable

The unique alias for the instance

namestring

The associated name

descriptionstring

The associated description

metaMeta

Meta data information

idstring required

The instance ID

createdAtnumber required

The timestamp (ms) when the instance was created

updatedAtnumber required

The timestamp (ms) when the instance was updated

blueprintIdstring nullable

The ID of the blueprint

botIdstring

The ID of the bot this policy applies to. When omitted the policy is global and applies to every bot.

type'retention' | 'usage' required

The policy type

state'enabled' | 'disabled'

The lifecycle state of a resource - toggle it on/off without deleting it

configobject

The policy configuration as JSON

Changes

No recorded changes to this operation across all 1 revision of this API.