Remove contacts from a list

Same body as adding.

DELETE/v1/lists/{id}/contacts

Path Parameters

idstringrequired

Body Parameters

contact_idsarray of string
phone_numbersarray of string

Details

The contacts stay contacts.

Responses

200JSON object
What changed
401Error
Missing, malformed, or revoked API key
402Error
Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged
404Error
No such list
429Error
Rate limit or quota exceeded

Response Fields

objectlist_membership_change
list_idstring
removedinteger
unchangedinteger
not_foundarray of string

Errors

Every error has the same JSON shape, and request_id matches the X-Request-Id response header. Errors lists every code and what to do about it.

401
Missing, malformed, or revoked API key
402
Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged
404
No such list
429
Rate limit or quota exceeded

const res = await fetch('https://api.jointextkit.com/v1/lists/lst_a1B2c3D4e5F6/contacts', {
  method: 'DELETE',
  headers: {
    Authorization: `Bearer ${process.env.TEXTKIT_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "contact_ids": [
      "ct_a1B2c3D4e5F6"
    ],
    "phone_numbers": [
      "+14155550132"
    ]
  }),
});

if (!res.ok) throw new Error((await res.json()).error.message);
const data = await res.json();

Response 200

{
  "object": "list_membership_change"
}