Skip to main content
POST
Create a human ownership policy revision

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

account_id
integer
required

The numeric ID of the account

Body

application/json
quiet_minutes
integer

How long the agent stays quiet after a teammate replies; 15 minutes through 7 days. Default 720.

Required range: 15 <= x <= 10080
auto_return
boolean

Whether the agent automatically takes the conversation back.

wait_trigger_minutes
integer | null

Optional customer-wait trigger, 5–1440 minutes; null disables it. Inert when auto_return is false.

Required range: 5 <= x <= 1440
alert_enabled
boolean

Whether to alert selected account members when the customer has waited.

alert_minutes
integer | null

Optional alert delay, 5–1440 minutes; null disables it. Required when alert_enabled is true and must be less than wait_trigger_minutes when both are set.

Required range: 5 <= x <= 1440
alert_recipient_user_ids
integer[]

Array of positive user IDs that belong to this account. At most 50 distinct members are stored; repeated IDs are normalized to one sorted entry.

Required range: x >= 1
return_mode
enum<string>

Agent behavior when it returns.

Available options:
answer,
answer_with_follow_up,
escalate
reason
string | null

Optional change reason; at most 500 characters.

Maximum string length: 500

Response

The newly appended revision. This operation does not edit an existing revision.

revision
integer
required

Current revision number; 0 means the account has not saved a revision.

quiet_minutes
integer
required

How long the agent stays quiet after a teammate replies; 15 minutes through 7 days. Default 720.

Required range: 15 <= x <= 10080
auto_return
boolean
required

Whether the agent automatically takes the conversation back. Default true.

wait_trigger_minutes
integer | null
required

Optional customer-wait trigger, 5–1440 minutes; null disables it. Default null. Inert when auto_return is false.

Required range: 5 <= x <= 1440
alert_enabled
boolean
required

Whether to alert selected account members when the customer has waited. Default false.

alert_minutes
integer | null
required

Optional alert delay, 5–1440 minutes; null disables it. Default null. Required when alert_enabled is true and must be less than wait_trigger_minutes when both are set.

Required range: 5 <= x <= 1440
alert_recipient_user_ids
integer[]
required

Up to 50 distinct IDs of members of this account. Stored sorted and unique. Default empty list.

Maximum array length: 50
Required range: x >= 1
return_mode
enum<string>
required

Agent behavior when it returns: answer (default), answer_with_follow_up, or escalate.

Available options:
answer,
answer_with_follow_up,
escalate
reason
string | null
required

Optional change reason; at most 500 characters and must not contain a NUL byte. Default null.

Maximum string length: 500
updated_at
string<date-time> | null
required

Time the current revision was created; null for revision 0.

updated_by
object | null
required

Author if still a member of the account, otherwise null.

previous_revision
integer | null
required

Revision this version follows; null for revision 1.

actor_role
enum<string>
required
Available options:
administrator,
system