Pular para o conteúdo
Healthing CRM

Update Channel

PUT
/api/v1/channels/{channel_id}

Update a channel’s configuration.

Authorizations

Seção intitulada “Authorizations ”

Parameters

Seção intitulada “ Parameters ”

Path Parameters

Seção intitulada “Path Parameters ”
channel_id
required
Channel Id
integer

Header Parameters

Seção intitulada “Header Parameters ”
x-tenant-id
Any of:
integer

Request Body required

Seção intitulada “Request Body required ”
ChannelUpdate

Schema for updating a Channel.

object
name
Any of:
string
>= 1 characters <= 255 characters
is_active
Any of:
boolean
is_default
Any of:
boolean
config
Any of:
object
auto_reply_enabled
Any of:
boolean
auto_reply_message
Any of:
string
<= 1000 characters
business_hours_enabled
Any of:
boolean
business_hours
Any of:
BusinessHours

Business hours configuration.

object
monday
Any of:
DaySchedule

Schedule for a single day.

object
enabled
Enabled
boolean
default: true
start
Start
string
default: 09:00 /^\d{2}:\d{2}$/
end
End
string
default: 18:00 /^\d{2}:\d{2}$/
tuesday
Any of:
DaySchedule

Schedule for a single day.

object
enabled
Enabled
boolean
default: true
start
Start
string
default: 09:00 /^\d{2}:\d{2}$/
end
End
string
default: 18:00 /^\d{2}:\d{2}$/
wednesday
Any of:
DaySchedule

Schedule for a single day.

object
enabled
Enabled
boolean
default: true
start
Start
string
default: 09:00 /^\d{2}:\d{2}$/
end
End
string
default: 18:00 /^\d{2}:\d{2}$/
thursday
Any of:
DaySchedule

Schedule for a single day.

object
enabled
Enabled
boolean
default: true
start
Start
string
default: 09:00 /^\d{2}:\d{2}$/
end
End
string
default: 18:00 /^\d{2}:\d{2}$/
friday
Any of:
DaySchedule

Schedule for a single day.

object
enabled
Enabled
boolean
default: true
start
Start
string
default: 09:00 /^\d{2}:\d{2}$/
end
End
string
default: 18:00 /^\d{2}:\d{2}$/
saturday
Any of:
DaySchedule

Schedule for a single day.

object
enabled
Enabled
boolean
default: true
start
Start
string
default: 09:00 /^\d{2}:\d{2}$/
end
End
string
default: 18:00 /^\d{2}:\d{2}$/
sunday
Any of:
DaySchedule

Schedule for a single day.

object
enabled
Enabled
boolean
default: true
start
Start
string
default: 09:00 /^\d{2}:\d{2}$/
end
End
string
default: 18:00 /^\d{2}:\d{2}$/
out_of_hours_message
Any of:
string
<= 1000 characters
assignment_mode
Any of:
AssignmentModeEnum

How conversations are assigned to agents.

string
Allowed values: manual round_robin least_busy
default_assignee_id
Any of:
integer
sla_enabled
Any of:
boolean
sla_first_response_minutes
Any of:
integer
>= 1 <= 1440
sla_resolution_minutes
Any of:
integer
>= 1 <= 10080

Responses

Seção intitulada “ Responses ”

200

Seção intitulada “200 ”

Successful Response

ChannelResponse

Schema for Channel response.

object
name
required
Name

Friendly name for the channel

string
>= 1 characters <= 255 characters
channel_type
required

Type of channel

string
Allowed values: api whatsapp email telegram webchat
id
required
Id
integer
status
required
ChannelStatusEnum

Status of a channel connection.

string
Allowed values: active inactive connecting error
config
required
Config
object
is_active
required
Is Active
boolean
is_default
required
Is Default
boolean
auto_reply_enabled
required
Auto Reply Enabled
boolean
auto_reply_message
Any of:
string
business_hours_enabled
required
Business Hours Enabled
boolean
business_hours
Any of:
object
out_of_hours_message
Any of:
string
assignment_mode
required
AssignmentModeEnum

How conversations are assigned to agents.

string
Allowed values: manual round_robin least_busy
default_assignee_id
Any of:
integer
sla_enabled
required
Sla Enabled
boolean
sla_first_response_minutes
Any of:
integer
sla_resolution_minutes
Any of:
integer
total_conversations
required
Total Conversations
integer
total_messages_sent
required
Total Messages Sent
integer
total_messages_received
required
Total Messages Received
integer
connected_at
Any of:
string format: date-time
disconnected_at
Any of:
string format: date-time
last_error
Any of:
string
webhook_url
Any of:
string
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time

422

Seção intitulada “422 ”

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string