Skip to content

Create channel profile

POST/omnichannel/channel-profiles

Creates a new channel profile that links a channel type to routing configuration, queue assignment, workload capacity, and a supervising user. Channel profiles are referenced by conversations to determine how they are distributed to agents.

Request

Request body

Content type application/json (required).

FieldTypeRequiredDescription
namestringYes

Human-readable display name for the profile.

Max length: 180

channelstringYes

The channel type this profile handles.

One of: "email", "web_chat", "sms", "whatsapp", "voice", "social", "internal"

channel_config_idintegerNo

ID of the channel adapter configuration to bind.

queue_namestringNo

Logical queue name used by the routing engine.

Max length: 120

fallback_channelstringNo

Channel to fall back to if this channel is unavailable.

One of: "email", "web_chat", "sms", "whatsapp", "voice", "social", "internal"

routing_modestringNo

One of: "capacity", "priority", "round_robin" · Default: "capacity"

default_prioritystringNo

One of: "low", "normal", "high", "urgent" · Default: "normal"

workload_capacityintegerNo

Default: 20 · Minimum: 1 · Maximum: 500

quality_thresholdnumberNo

Default: 80 · Minimum: 0 · Maximum: 100

supervisor_user_idintegerNo
is_activebooleanNo

Default: true

settings_jsonstringNo

JSON object with provider-specific channel settings.

Example

{
  "name": "Enterprise Email Support",
  "channel": "email",
  "channel_config_id": 1,
  "queue_name": "enterprise_email",
  "fallback_channel": "sms",
  "routing_mode": "round_robin",
  "default_priority": "high",
  "workload_capacity": 30,
  "quality_threshold": 85,
  "supervisor_user_id": 2,
  "is_active": true
}

Responses

201 Channel profile created

Content type application/json, object · OmnichannelChannelProfileV1.

FieldTypeRequiredDescription
idintegerNo

Auto-incremented primary key.

namestringNo

Human-readable display name for the profile.

channelstringNo

The channel type this profile handles.

One of: "email", "web_chat", "sms", "whatsapp", "voice", "social", "internal"

channel_config_idinteger, nullableNo

ID of the underlying channel adapter configuration.

queue_namestring, nullableNo

Queue identifier used by the routing engine.

routing_modestringNo

Algorithm used to distribute conversations to agents.

One of: "capacity", "priority", "round_robin"

default_prioritystringNo

Default priority assigned to conversations routed through this profile.

One of: "low", "normal", "high", "urgent"

workload_capacityintegerNo

Maximum number of simultaneous conversations an agent in this queue can handle.

Minimum: 1 · Maximum: 500

quality_thresholdnumber (float)No

Minimum quality score (0-100) before a conversation is flagged for review.

Minimum: 0 · Maximum: 100

supervisor_user_idinteger, nullableNo

ID of the user who supervises this queue.

is_activebooleanNo

Whether this profile is currently accepting conversations.

422 Validation failed — check channel enum or foreign key IDs

Example request

curl -X POST "https://{tenant}.faciotech.net/api/v1/omnichannel/channel-profiles" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"name": "Enterprise Email Support", "channel": "email", "channel_config_id": 1, "queue_name": "enterprise_email", "fallback_channel": "sms", "routing_mode": "round_robin", "default_priority": "high", "workload_capacity": 30, "quality_threshold": 85, "supervisor_user_id": 2, "is_active": true}'
Loading