Skip to main content
PATCH
Change one person in a batch

Authorizations

Authorization
string
header
required

Authenticate with a Bearer token: API key, OAuth token, or session token.

Path Parameters

id
string<uuid>
required

Campaign ID.

batch_id
string<uuid>
required

Enrollment batch ID.

recipient_id
string<uuid>
required

The person's recipient_id in the batch (not their person_id).

Body

application/json
email
string<email>

Send to this email instead.

add_email_to_person
boolean

Save email to the person's profile when it isn't one of their emails. A batch can't send to an address without saving it, so without this an email not on the profile leaves the person needs_input (email_not_on_person).

variable_values
object

Values to set for this person, merged into the ones already given. An empty string removes a value.

blank_variables
string[]

Variables to leave out for this person, dropping any value given for them. Replaces the list already given.

Maximum array length: 100
Required string length: 1 - 100
overrides
enum<string>[]

Enroll despite these blocks: company_do_not_contact (works at a company marked do not contact) or duplicate_enrollment (already in this campaign at another email, or finished it before). Needs override_reason here or on the batch. Ignored when the person has neither block. A blocked person (unsubscribed, bounced, marked do not contact, or still in this campaign at the same email) cannot be overridden, and passing overrides for them fails the whole request with OVERRIDE_NOT_ALLOWED. To re-enroll someone at the same email, stop their enrollment first.

Maximum array length: 2
Available options:
company_do_not_contact,
duplicate_enrollment
override_reason
string | null

Why the block is being overridden. Stored on the enrollment.

Required string length: 1 - 1000
steps
object[]

Final text for this person's steps, with no {{variables}} left. Edited steps keep this text even when variables change.

Maximum array length: 20
excluded
boolean

Leave this person out of the batch, or put them back.

Response

Person updated

success
enum<boolean>
required
Available options:
true
data
object
required