Edit

[POST] .../v1/channel/edit

Edits a CRM channel. Use this method to update channel settings such as name, queue mode, routing strategy, SLA values, messages, rating settings and active flag. The method changes only fields present in the request, stores empty message strings as NULL, writes an action log record and sends the ChannelEdited webhook when a row is affected and returns row_affected with changed ids. The request body is required; id must be positive, name is limited to 200 characters and queue_mode or routing_strategy must not be Default when provided. The caller must have CRM channel edit permission; missing body, invalid id, denied access, missing channel, database failures, transaction failures and action-log errors are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Name Type Required Description
active Boolean Optional Indicates whether the channel is active.
end_message String Optional Conversation closing message. An empty string is stored as NULL.
first_response_sec Int32 Optional First response SLA in seconds.
id Int64 Required Channel ID.
name String Optional New channel name. Maximum length is 200 characters.
next_response_sec Int32 Optional Next response SLA in seconds.
off_hours_message String Optional Message shown outside working hours. An empty string is stored as NULL.
pause_on_waiting_client Boolean Optional Pauses SLA timers while the lead is waiting for the client.
queue_mode String Optional Queue mode: Pool or Direct. Allowed values: Default, Pool, Direct.
rating_enabled Boolean Optional Enables conversation rating.
rating_message String Optional Rating request text. An empty string is stored as NULL.
rating_negative_message String Optional Text shown after a negative rating. An empty string is stored as NULL.
rating_positive_message String Optional Text shown after a positive rating. An empty string is stored as NULL.
resolve_sec Int32 Optional Resolution SLA in seconds.
routing_strategy String Optional Routing strategy: RoundRobin, LeastLoaded or Manual. Allowed values: Default, RoundRobin, LeastLoaded, Manual.
start_message String Optional Greeting message. An empty string is stored as NULL.

Request Example

{
  "id": 3,
  "name": "Telegram support priority",
  "routing_strategy": "LeastLoaded",
  "first_response_sec": 180,
  "active": true
}

Response Parameters

Name Type Description
ok Boolean Indicates whether the request completed successfully.
result Update Update operation result.

Response Example

{
  "ok": true,
  "result": {
    "row_affected": 1,
    "ids": [
      3
    ]
  }
}