Remove Sequence Contacts

post

https://api.whippy.co/v1/sequences/{id}/contacts/remove

Remove contacts from the sequence.

A contact will only be removed if it exists in the sequence, The sequence_id taken from the url It accepts the list of contacts as to list in the parameters.

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

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

Path Params

string

required

Sequence ID

Body Params

Remove Sequence Contacts 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.

default_channel_id

uuid

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

string

length ≤ 255

Contact email

external_id

string

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

language

string

The language preference of the Contact

name

string

length ≤ 255

Contact name

phone

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

Language

Credentials

Header

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

202Sequence

400Bad Request

401Not Authenticated

404Not Found

422Unprocessable Entity