Skip to main content
POST
Finish or pause everyone at an account
Acts on every contact at one company — the “we just booked a meeting there, stop emailing the rest” case. Send dry_run: true first: this can touch a lot of people at once.

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
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"

action
enum<string>
required
Available options:
finish,
pause
scope
enum<string>
required

sequence limits it to one sequence; team covers every sequence the team runs.

Available options:
sequence,
team
contact
string

Identify the account by one of contact, domain or company_name.

domain
string
company_name
string
sequence
string

Required when scope is sequence.

days
number

Pause length in days, when action is pause.

reason
string
dry_run
boolean

Return how many would be affected, and change nothing.

Response

Success.

The outcome of an action. Shape varies by endpoint — for example enable returns the sequence and how many enrollments it activated, and a bulk verb returns how many rows it moved.