Skip to main content
PATCH
Update a rules-of-engagement policy
Changes a policy’s name, description, CRM refresh window, scenarios or reactions.
rules and outcome_rules replace the whole list. A rule you leave out is deleted. Read the policy first, edit the list, and send all of it back with each rule’s id.

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.
  • Invalid rules return 400 with every problem listed in errors. Renaming to a name already used on the team returns 409.

Authorizations

x-api-key
string
header
required

Team-scoped API key generated in the Salesfinity dashboard under Settings → Connections → API & Webhooks. A missing or invalid key returns HTTP 403.

Path Parameters

id
string
required

24-character policy id.

Body

application/json
user_id
string
required

The team member making the change. Must be an active member of the team, and the team owner or an admin.

name
string

Unique on the team. Must not be empty.

Maximum string length: 120
description
string
Maximum string length: 2000
rules
object[]

Replaces every scenario. Send the full list, keeping each rule's id. Up to 100.

Maximum array length: 100
outcome_rules
object[]

Replaces every reaction. Send the full list, keeping each rule's id. Up to 50.

Maximum array length: 50
crm_refresh_hours
number

Whole hours, 1 to 168. How old a contact's stored CRM data may be before a CRM-backed rule refreshes it.

Required range: 1 <= x <= 168

Response

The updated policy.

A rules-of-engagement policy.

_id
string

24-character hexadecimal id.

Example:

"507f1f77bcf86cd799439011"

team
string

Team id.

name
string

Unique on the team.

description
string | null
is_default
boolean

The policy every sequence that names none of its own runs under. Exactly one per team.

crm_refresh_hours
integer

How old a contact's stored CRM data may be, in hours, before a CRM-backed rule refreshes it.

rules
object[]

Scenarios, in evaluation order.

outcome_rules
object[]

Reactions.

sequence_count
integer

Only on GET /v2/sequencer/policies: sequences running under this policy. The default also counts every sequence that names no policy.

created_by
string

Who created it. Absent on the default policy the team started with.

updated_by
string

Who changed it last.

created_at
string<date-time>
updated_at
string<date-time>