Skip to main content
PATCH
Update Channel Binding

Authorizations

Authorization
string
header
required

Use a JWT bearer token or a Veryfront API key in the Authorization header.

Path Parameters

project_reference
string
required
binding_id
string<uuid>
required

Body

application/json
name
string
Required string length: 1 - 255
assistant_id
string
Minimum string length: 1
respond_to
enum<string>
Available options:
mentions,
direct_messages,
all
allowed_channels
string[]
Maximum array length: 250
Required string length: 1 - 255
welcome_message
string | null
Maximum string length: 4000
error_message
string | null
Maximum string length: 4000
max_response_tokens
integer | null
Required range: 0 < x <= 65536
runtime_target_kind
enum<string>
Available options:
main_branch,
environment,
preview_branch
target_environment_id
string<uuid> | null
target_branch_id
string<uuid> | null

Response

Updated channel binding

id
string<uuid>
required
project_id
string<uuid>
required
platform
enum<string>
required
Available options:
slack
enabled
boolean
required
platform_team_id
string | null
required
platform_bot_id
string | null
required
respond_to
enum<string>
required
Available options:
mentions,
direct_messages,
all
allowed_channels
string[]
required
status
enum<string>
required
Available options:
connected,
needs_reauth,
error
runtime_target_kind
enum<string>
required
Available options:
main_branch,
environment,
preview_branch
resolved_target
object
required
created_at
string
required
updated_at
string
required
binding_id
string<uuid>
installation_id
string<uuid> | null
name
string | null
assistant_id
string | null
Minimum string length: 1
workspace_name
string | null
welcome_message
string | null
error_message
string | null
max_response_tokens
integer | null
Required range: x > 0
target_environment_id
string<uuid> | null
target_branch_id
string<uuid> | null