Skip to main content
POST
Create a rules-of-engagement policy
Condition and action types come from /v2/sequencer/policies/catalog, which is the live vocabulary — this endpoint does not pin a copy of it. Preview the rules before saving.

Authorizations

x-api-key
string
header
required

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

Body

application/json
name
string
required
user_id
string
required

The team member authoring the policy.

description
string
rules
object[]
outcome_rules
object[]
crm_refresh_hours
number
default:24

How stale a cached CRM snapshot may be before a CRM-backed rule refreshes it.

Response

Success.

A rules-of-engagement policy.

_id
string

24-character hexadecimal id.

Example:

"507f1f77bcf86cd799439011"

name
string
description
string | null
is_default
boolean

Applied to any sequence that does not name its own.

crm_refresh_hours
integer
rules
object[]
outcome_rules
object[]