Revoke consent | Saperly Docs

Soft-revokes consent for a phone number. Records are preserved for audit purposes. When line_id is omitted, revokes every active consent for (user, phone_number) in the caller’s API-key environment. The response is always an array, even for single revocations, reflecting the multi-line semantics.

1	const url = 'https://saperly.com/api/v1/consent?phone_number=%2B15551234567';
2	const options = {
3	method: 'DELETE',
4	headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
5	body: '{}'
6	};
7
8	try {
9	const response = await fetch(url, options);
10	const data = await response.json();
11	console.log(data);
12	} catch (error) {
13	console.error(error);
14	}

1	{
2	"consents": [
3	{
4	"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
5	"phone_number": "+15551234567",
6	"line_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
7	"consent_type": "implied_inbound",
8	"status": "revoked",
9	"granted_at": "2024-01-10T08:15:00Z",
10	"revoked_at": "2024-01-15T09:30:00Z"
11	}
12	],
13	"count": 1
14	}

Authentication

Query parameters

Response

Errors