Remove members from a list
DELETE
/api/v2/flare/contact-lists/{id}/contacts
curl --request DELETE \ --url https://api.sipstack.com/api/v2/flare/contact-lists/example/contacts \ --header 'Content-Type: application/json' \ --header 'x-api-key: <x-api-key>' \ --data '{ "contactIds": [ "1f2e6b7c-8a90-4c1d-9e2f-0a1b2c3d4e5f", "2a3b4c5d-6e7f-4809-a1b2-c3d4e5f60718" ] }'import requests
url = "https://api.sipstack.com/api/v2/flare/contact-lists/example/contacts"
payload = { "contactIds": ["1f2e6b7c-8a90-4c1d-9e2f-0a1b2c3d4e5f", "2a3b4c5d-6e7f-4809-a1b2-c3d4e5f60718"] }headers = { "x-api-key": "<x-api-key>", "Content-Type": "application/json"}
response = requests.delete(url, json=payload, headers=headers)
print(response.json())const url = 'https://api.sipstack.com/api/v2/flare/contact-lists/example/contacts';const options = { method: 'DELETE', headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'}, body: '{"contactIds":["1f2e6b7c-8a90-4c1d-9e2f-0a1b2c3d4e5f","2a3b4c5d-6e7f-4809-a1b2-c3d4e5f60718"]}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}import axios from 'axios';
const options = { method: 'DELETE', url: 'https://api.sipstack.com/api/v2/flare/contact-lists/example/contacts', headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'}, data: { contactIds: ['1f2e6b7c-8a90-4c1d-9e2f-0a1b2c3d4e5f', '2a3b4c5d-6e7f-4809-a1b2-c3d4e5f60718'] }};
try { const { data } = await axios.request(options); console.log(data);} catch (error) { console.error(error);}Removes contacts from the list. Requires contacts:write. 404 when the list isn’t your organization’s.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” id
required
string
Request Body required
Section titled “Request Body required ” Media type application/json
Add or remove contacts from a list. Adds are idempotent (duplicates ignored); removes of a non-member are a no-op.
object
contactIds
required
Array<string>
Example
[ "1f2e6b7c-8a90-4c1d-9e2f-0a1b2c3d4e5f", "2a3b4c5d-6e7f-4809-a1b2-c3d4e5f60718"]Responses
Section titled “ Responses ”Members removed.
Media type application/json
object
success
boolean
Example generated
{ "success": true}contactIds must be a non-empty array.
Media type application/json
Inline error shape used by the messaging API and management endpoints.
object
success
boolean
error
string
Example
{ "success": false, "error": "Recipient phone number (to) is required"}Missing or invalid API key.
Media type application/json
Inline error shape used by the messaging API and management endpoints.
object
success
boolean
error
string
Example
{ "success": false, "error": "Recipient phone number (to) is required"}List not found in your organization.
Media type application/json
Inline error shape used by the messaging API and management endpoints.
object
success
boolean
error
string
Example
{ "success": false, "error": "Recipient phone number (to) is required"}