Skip to main content
PATCH
Update agent rules

Authorizations

Authorization
string
header
required

Access token issued by gs.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.

Team-SID
string
header
required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Path Parameters

sid
string
required

The agent (ub_ag_…).

Required string length: 18
Pattern: ^ub_ag_

Body

application/json

Request body of update_agent_rules.

reply_words
object

The length band per channel, in words.

meeting_ask
enum<string>

How it asks for the meeting: suggest_call_link_on_request (default: a call suggested in one line, the link only when they ask or say yes), ask_their_time (their time asked for, no link), suggest_call_with_link (the call with the link in the same message).

Available options:
suggest_call_link_on_request,
ask_their_time,
suggest_call_with_link
confirm_named_time
boolean

Default true: a time they name is confirmed in one line and nothing else is asked; a person puts it on the calendar.

answer_then_call
boolean

Default true: a question before the call is answered in short, then the ask.

acknowledge_low_signal
boolean

Default true: a lead who only says thanks gets one friendly line and the thread resumes its workflow.

reply_delay_minutes
object

The wait before a reply on autopilot, a uniform pick between the two, in minutes, 0..60; default 1 to 2.

quiet_hours
object

When no reply goes, in the lead's zone (the workspace's today); default 22:00 to 07:00. from equal to to is never quiet.

weekends
boolean

Default true: it replies on weekends; false keeps the weekend quiet.

followups
integer

How many follow-ups when the lead goes quiet, 0..6; default 3 (the corpus: blocks climb with the fourth).

Required range: 0 <= x <= 6
followup_days
integer

Days between them, 1..14; default 4.

Required range: 1 <= x <= 14
something_new
boolean

Default true: every follow-up brings something new (a proof, a shorter ask, an easy way out), never a bump.

checks
object

The checks before it sends, each on (default) or off. Stop after a no is the platform's and always on.

Response

update success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
update
item
object
required
updated_fields
string[]
required
previous_values
object
required
meta
object
required
kept_fields
string[]

The fields this write did not change because the person's own value stands on them (stamped person); read the item for what landed.