Skip to main content
POST
Make a policy the team default
Makes one policy the team default: the rules every sequence without a policy of its own follows. The previous default stays as an ordinary policy.

Good to know

  • This changes behavior across the team within about a minute. Check List rules-of-engagement policies for how many sequences use the default, and preview its rules first.
  • Calling it on the policy that is already the default changes nothing.
  • Only the team owner or an admin can change the default.

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.

Headers

Idempotency-Key
string

Makes this write safe to retry. Send a unique value, such as a UUID, and send the same value again when you retry the same request. A retry with the same key and the same request (method, path including the query string, and JSON body) returns the original successful response without acting twice. The same key with a different body or path returns 409, and so does a retry while the first request is still running; that one is safe to repeat after a moment. A request that fails frees its key, so a retry runs the write again: after a 5xx on a create, confirm with a GET before retrying. Keys are kept for 24 hours and are scoped to your team.

Path Parameters

id
string
required

24-character policy id.

Body

application/json
user_id
string
required

The team member this call acts as. Must be an active member of the team the API key belongs to.

Example:

"507f1f77bcf86cd799439011"

Response

The policy, now the default.

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>