ASasksyllable
channels.targets

Edit Channel Target

Changed on

Update channel target by ID.

Stop running experiments and delete drafts on the target before changing its linked agent.

put/api/v1/channels/{channel_id}/targets/{target_id}

Request

  • Base URL
    https://api.syllable.cloud
  • URL
    https://api.syllable.cloud/api/v1/channels/{channel_id}/targets/{target_id}
  • Auth
    API key in header Syllable-API-Key

Path parameters

channel_idinteger required
target_idinteger required

Target record ID, rather than a phone number

Request body

agent_idinteger required

The internal ID of the agent associated with the channel target

channel_idinteger required

The internal ID of the channel associated with the channel target

targetstring required

The name of the channel target. Must correspond to an organization-level target (available targets can be fetched from /channels/available-targets).

target_mode'voice' | 'chat' | 'sms' | 'email' | 'whatsapp' required

Available modes (communication methods) for channel targets.

fallback_targetstring nullable

The fallback for the channel target (currently only supported for "voice" mode)

is_testboolean

Whether the channel target is intended for testing. If true, any sessions created through this target will be labeled as a test session (i.e., will not be included in dashboard data and can easily be filtered out in the Sessions screen in the SyllableConsole).

idinteger required

The internal ID of the channel target

Example request

{
  "agent_id": 1,
  "channel_id": 1,
  "target": "+19995551234",
  "fallback_target": "+19995551235",
  "is_test": true,
  "id": 1
}

Response

Successful Response

agent_idinteger required

The internal ID of the agent associated with the channel target

channel_idinteger required

The internal ID of the channel associated with the channel target

targetstring required

The name of the channel target. Must correspond to an organization-level target (available targets can be fetched from /channels/available-targets).

target_mode'voice' | 'chat' | 'sms' | 'email' | 'whatsapp' required

Available modes (communication methods) for channel targets.

fallback_targetstring nullable

The fallback for the channel target (currently only supported for "voice" mode)

is_testboolean

Whether the channel target is intended for testing. If true, any sessions created through this target will be labeled as a test session (i.e., will not be included in dashboard data and can easily be filtered out in the Sessions screen in the SyllableConsole).

idinteger required

The internal ID of the channel target

channel_namestring required

The name of the channel associated with the channel target

updated_atstring date-time required

Timestamp of the most recent update to the channel target

last_updated_bystring required

Email of the user who last updated the channel target

a2p_verifiedboolean nullable

Twilio US A2P messaging-path configuration snapshot from the last explicit verify; null if never checked.

Changes

  • b9ac2e8b5b7bRevision changes
    • info

      added the optional property to the response with the status

  • 6b90a73b857fRevision changes
    • warning

      for the path request parameter target_id, the max was set to 2147483647.00

    • warning

      for the path request parameter target_id, the min was set to -2147483648.00