Skip to main content
POST
Approve held enrollments in bulk
Approves up to 500 enrollments a rule of engagement is holding for approval. Each one goes through Approve a held enrollment, with the same permission checks and the same result: it starts its cadence or, if its sequence is off, waits in pending until the sequence is turned on.
The ids are processed one at a time, and one failure does not stop the rest. failed gives each refusal’s reason: note is recorded on each approval decision and its approval_granted event. A repeat reports the already-approved ids under failed, so send an Idempotency-Key and reuse it when you retry.

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.

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"

ids
string[]
required

Enrollment ids, 1 to 500.

Maximum array length: 500
note
string

Bulk approve and bulk reject record it on each approval decision and timeline event. Bulk finish and move accept it but do not store it.

Maximum string length: 500

Response

How many succeeded, and why each of the others did not. Returned even when every id failed.

The outcome of a bulk enrollment action. The ids are processed one at a time, in the order sent, and one failure does not stop the rest.

ok
integer
required

How many ids the action succeeded for.

failed
object[]
required

Every id the action did not succeed for, in the order sent.

reassigned
integer

Bulk reassign only: the same number as ok.