Policy

Update policy

post/policy/{policyId}/update

Request

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

Path parameters

policyIdstring required

The ID of the policy to update

Request body

aliasstring nullable

The unique alias for the instance

namestring

The associated name

descriptionstring

The associated description

metaMeta

Meta data information

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'

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

Response

The policy was updated successfully

idstring required

The ID of the updated policy

Changes

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