Skip to main content
PATCH
Update a contact list

Authorizations

X-API-Key
string
header
required

An organization API key, prefixed bk_live_. Takes precedence over Authorization when both are sent. The key is bound to one organization, and the scopes it was issued with are enforced per endpoint.

Headers

X-Organization-Id
string<uuid>

Required when authenticating with an access token. Optional with an API key, whose own organization binding is authoritative; a value contradicting it is refused with 403.

Path Parameters

id
string
required

Body

application/json
name
string
Required string length: 1 - 255
description
string
Maximum string length: 1000
status
enum<string>
Available options:
active,
inactive,
archived
preferredChannels
enum<string>[]
Available options:
email,
sms,
imessage,
telegram,
push,
whatsapp
tags
string[]
isDefault
boolean

Response

success
boolean
required
Example:

true

message
string
required
data
object
required