Update a rules-of-engagement policy
Changes a policy; rules and outcome_rules each replace the whole list when sent.
Send only the fields to change. When you send rules or outcome_rules, include every rule you want to keep, with its id, so the history that refers to it stays attached, and with its sequences, or it starts applying to every sequence.
Rules are validated as on create, and a failure returns 400 with errors. The change applies to every sequence that runs under the policy, including all sequences on the default, at their next enrollment or step check, within about a minute. Preview rule changes first.
The conditions prior_calls (called at least N times in the last N days), last_call_result (their most recent call’s result) and had_call_result (any of their latest 100 calls got a result) read every dial to the person, from any list in the dialer or any sequence. Results are named by the id from GET /v1/dispositions.
The action route_to_sequence (enrollment scope only, params.sequence required) starts a person in another sequence instead of this one, and both sequences record why. The target must be one of your team’s sequences that is not archived, and cannot be one the rule itself is limited to. Someone already routed is not routed again, and someone the target cannot take is skipped with the reason.
Each rule and reaction can list the sequences it applies to, up to 50. Leave it out, or send [], for every sequence that uses the policy.
Only the team owner or an admin can change policies. Renaming to a name already used on the team returns 409. Acts as user_id. Counts against the Sequencer writes rate limit.
Good to know
- The change applies to every sequence running under the policy, including all sequences on the team default, within about a minute. Preview rule changes first with Preview a draft rule set.
- Only the team owner or an admin can change policies.
- The call-history conditions,
route_to_sequenceand per-rulesequenceswork as described on Create a rules-of-engagement policy. - Invalid rules return 400 with every problem listed in
errors. Renaming to a name already used on the team returns 409.
Authorizations
Team-scoped API key generated in the Salesfinity dashboard under Settings → Connections → API & Webhooks. A missing or invalid key returns HTTP 403.
Path Parameters
24-character policy id.
Body
The team member making the change. Must be an active member of the team, and the team owner or an admin.
Unique on the team. Must not be empty.
1202000Replaces every scenario. Send the full list, keeping each rule's id and sequences. Up to 100.
100Replaces every reaction. Send the full list, keeping each rule's id and sequences. Up to 50.
50Whole hours, 1 to 168. How old a contact's stored CRM data may be before a CRM-backed rule refreshes it.
1 <= x <= 168Response
The updated policy.
A rules-of-engagement policy.
24-character hexadecimal id.
"507f1f77bcf86cd799439011"
Team id.
Unique on the team.
The policy every sequence that names none of its own runs under. Exactly one per team.
How old a contact's stored CRM data may be, in hours, before a CRM-backed rule refreshes it.
Scenarios, in evaluation order.
Reactions.
Only on GET /v2/sequencer/policies: sequences running under this policy. The default also counts every sequence that names no policy.
Who created it. Absent on the default policy the team started with.
Who changed it last.