Remove Contact From List

Options

List Id

Id of the list

Body

Emails adresses OR IDs of the contacts OR 'all' true

Request body which must comply to the following JSON Schema:

{
  "oneOf" : [ {
    "type" : "object",
    "properties" : {
      "emails" : {
        "maxItems" : 150,
        "minItems" : 1,
        "type" : "array",
        "description" : "**Required if 'all' is false and 'ids' is empty.** Emails to remove from a list. You can pass a **maximum of 150 emails** for removal in one request.\n",
        "items" : {
          "type" : "string",
          "description" : "Email to remove from a list",
          "format" : "email",
          "example" : "john.smith@contact.com"
        }
      }
    }
  }, {
    "type" : "object",
    "properties" : {
      "ids" : {
        "maxItems" : 150,
        "minItems" : 1,
        "type" : "array",
        "description" : "**Required if 'all' is false and 'emails' is empty.** IDs to remove from a list. You can pass a **maximum of 150 IDs** for removal in one request.\n",
        "items" : {
          "type" : "integer",
          "description" : "ID to remove from a list",
          "format" : "int64",
          "example" : 10
        }
      }
    }
  }, {
    "type" : "object",
    "properties" : {
      "all" : {
        "type" : "boolean",
        "description" : "**Required if 'emails' and 'ids' are empty.** Remove all existing contacts from a list. A process will be created in this scenario. You can fetch the process details to know about the progress\n",
        "example" : true
      }
    }
  } ]
}

Result Format

Specify how the response should be mapped to the table output. The following formats are available:

Raw Response: Returns the raw response in a single row with the following columns:

• body: Response body
• status: HTTP status code

Views

This node has no views

Workflows

• No workflows found

Links

• No links available

Developers