Remove contacts from a list

DELETEhttps://api.norreach.app/v1/lists/{id}/members

Takes up to 1 000 contacts off a list (send their ids in the body). The contacts themselves stay.

contacts:writeOperation id: remove_list_members

DELETE/lists/{id}/members

curl -X DELETE "https://api.norreach.app/v1/lists/{id}/members" \
  -H "Authorization: Bearer $NORREACH_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "contact_ids": [
    "7d1c3b2a-5e4f-4a1b-9c8d-0e1f2a3b4c5d"
  ]
}'

Remove contacts from a list

{
  "object": "list_members_change",
  "list_id": "9b2f7e1d-3c4a-4b5d-8e6f-7a8b9c0d1e2f",
  "removed": 1
}

Authorizations

Authorizationstringheaderrequired

Bearer authentication: send Authorization: Bearer <key>, with an API key or an OAuth access token. The key needs the scope contacts:write. API keys and scopes

Path parameters

idstring (uuid)pathrequired

An id (UUID).

Headers

Idempotency-Keystringheader

Any unique string (≤ 255). The same key with the same request returns the first answer for 24 hours.

Body

application/json

contact_idsstring (uuid)[]required

Response

200application/json— Remove contacts from a list

object"list_members_change"required

list_idstring (uuid)required

An id (UUID).

addedinteger

removedinteger

not_foundstring (uuid)[]

Ids that aren't contacts of this workspace (nothing was done with them).

Errors

Errors are application/problem+json with a stable code.

Status	Code	Meaning
400	`bad_request`	The request couldn't be read.
400	`unknown_field`	The request has a field this operation doesn't know.
401	`unauthorized`	A valid API key is required.
403	`insufficient_scope`	This API key doesn't have the scope this operation needs.
403	`feature_not_enabled`	The API isn't switched on for this workspace.
404	`not_found`	That doesn't exist.
409	`idempotency_in_progress`	A request with this Idempotency-Key is still running.
413	`too_large`	The request body is too large.
422	`validation_failed`	The request has invalid fields.
422	`idempotency_mismatch`	This Idempotency-Key was used with a different request.
429	`rate_limited`	Too many requests. Slow down and try again.
500	`server_error`	Something went wrong on our side.
503	`unavailable`	The API isn't available right now. Try again shortly.

DELETE/lists/{id}/members

curl -X DELETE "https://api.norreach.app/v1/lists/{id}/members" \
  -H "Authorization: Bearer $NORREACH_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "contact_ids": [
    "7d1c3b2a-5e4f-4a1b-9c8d-0e1f2a3b4c5d"
  ]
}'

Remove contacts from a list

{
  "object": "list_members_change",
  "list_id": "9b2f7e1d-3c4a-4b5d-8e6f-7a8b9c0d1e2f",
  "removed": 1
}