API Reference

Remove Contacts From All Sequences

post
https://api.whippy.co/v1/sequences/contacts/remove

Remove contacts from all sequences in a given organization.

A contact will only be removed from any sequence it exists in. The request's body accepts the list of contacts as to list in the parameters.

If any given contact doesn't exist in an organization, it will create a contact only for the current organization, but that contact won't have any impact on any sequence. The contacts will be tagged with an upload tag with a timestamp corresponding to the time of the request. Then the status of the contact will be updated to Finished.

The process will run in the background, therefore a 202 Accepted status is initially returned on success.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Remove Contacts From All Sequences Params

contacts
array of objects
required
length between 1 and 4000

List of contacts that would be removed to the sequence.

contacts*
address
object

Optional Address details of the Contact

birth_date
object

Birthday details of the Contact.

uuid

The ID of the channel from which the contact should receive messages by default.

string
length ≤ 255

Contact email

string

The external ID of a contact. It uniquely identifies a contact and can be useful for associating whippy contacts with external systems.

string

The language preference of the Contact

string
length ≤ 255

Contact name

string
required

Contact phone number

properties
object

Contact properties mapped to custom data. These properties are mapped to the custom object in the payload.

The properties keys should correspond to the keys of the custom properties that belong to the custom object.

Responses

Callback

Updated 6 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 months ago