Skip to main content
POST
email.contact-list.contacts.remove

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$
Pramaan-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

Body

application/json
list
string
required

The contact list's name, as email.contact-lists.list shows it.

Required string length: 1 - 100
Pattern: ^(?:[^\p{Cc}\p{Zl}\p{Zp}]|\t)*$
emails
string[]
required

Up to 100 contact addresses to add.

Required array length: 1 - 100 elements
Required string length: 1 - 320
Pattern: ^(?:[^\p{Cc}\p{Zl}\p{Zp}]|\t)*$

Response

The result

list
string
required

The list's name.

count
number
required

How many addresses were sent to the list.