Skip to main content
POST
Send people to a destination now

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

idempotency-key
string

Any client-chosen key, a uuid for example. Sending the same request twice with the same key has one effect and returns the same response twice; the same key with a different body returns 409.

Required string length: 1 - 255
Example:

"3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d"

Path Parameters

id
string
required

Where to send, by name or id from list_destinations.

Required string length: 1 - 200

Body

application/json
view
string

Send everyone in this People view (at most 250), as it lists them now.

Required string length: 1 - 200
person_ids
string[]

The id of up to 100 people, from search_people or get_person.

Required array length: 1 - 100 elements
Pattern: ^\S{1,200}$
confirm_id
string

The confirm_id of a needs_confirmation answer: commits what that answer summarised.

Response

The result, or without confirm_id first a needs_confirmation answer: nothing happened yet.

destination
object
required
view
object | null
required
to_send
integer
required

How many people are sent.

queued
integer
required

How many this call queued.

skipped
object[]
required

Who is not sent and why. At most 25 listed; skipped_total counts all.

skipped_total
integer
required
effects
string[]
required

What this send does, in plain words.

app_url
string
required