Skip to main content
POST
Create an assignment policy

Authorizations

api_access_token
string
header
required

This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can be saved by an external system when user is created via API, to perform activities on behalf of the user.

Path Parameters

id
integer
required

The numeric ID of the account

Body

application/json
assignment_policy
object
required

The policy to create or update.

Response

Success

id
integer

The numeric ID of the policy.

name
string

The policy name, unique within the account.

description
string | null

What the policy is for.

assignment_order
string

How conversations are handed out. round_robin on every plan; further orders may be available on yours.

conversation_priority
enum<string>

Which waiting conversation is handed out first.

Available options:
earliest_created,
longest_waiting
fair_distribution_limit
integer

How many conversations one agent may be given inside the window.

fair_distribution_window
integer

The window, in seconds, the limit is measured over.

enabled
boolean

Whether the policy is in force.

assigned_inbox_count
integer

How many inboxes currently use this policy.