Skip to content
UpVoiced Docs

API reference

End users

Personal-data deletion requests for one of your end users.

Set up the SDK client used in the examples

API key or Dashboard session:

import { UpVoiced } from '@upvoiced/sdk';

const apiKey = process.env['UPVOICED_API_KEY']; // uv_live_… (Settings → API keys)
const workspace = process.env['UPVOICED_WORKSPACE_ID']; // sent as X-Workspace
if (!apiKey || !workspace) throw new Error('Set UPVOICED_API_KEY and UPVOICED_WORKSPACE_ID.');
const upvoiced = new UpVoiced({ apiKey, workspace });

curl examples read $UPVOICED_API_KEY and $UPVOICED_WORKSPACE_IDfrom your shell. MCP examples are the tools/call request an MCP client sends to the MCP server with the same API key.

GET/v1/end-users/{id}/deletion

State of the latest deletion request of an end-user (owner/admin)

Authentication
API key or Dashboard session; API key scope admin
Operation id
getEndUserDeletion
Path parameters
NameTypeRequired
idstring (uuid)Yes
Headers
NameTypeRequired
x-workspacestring (uuid)Yes
Response 200: 7 fields
Response 200 (application/json)
NameTypeRequired
idstring (uuid)Yes
end_user_idstring (uuid)Yes
status"pending" | "processing" | "completed"Yes
source"operator" | "end_user" | "system"Yes
requested_atstring (date-time)Yes
due_atstring (date-time)Yes
completed_atstring (date-time) | nullYes

Errors: 400, 401, 403, 404, 409, 413, 422, 429, 500, 503, all in the standard error shape.

curl
curl 'https://api.upvoiced.com/v1/end-users/0190f5e2-4c1d-7a3b-8c2d-5e6f7a8b9c0d/deletion' \
  -H "Authorization: Bearer $UPVOICED_API_KEY" \
  -H "X-Workspace: $UPVOICED_WORKSPACE_ID"
TypeScript SDK
const data = await upvoiced.get('/v1/end-users/{id}/deletion', { path: { id: '0190f5e2-4c1d-7a3b-8c2d-5e6f7a8b9c0d' } });
MCP

No MCP tool for this operation. The MCP server covers the everyday reads and writes.

POST/v1/end-users/{id}/deletion

GDPR/LGPD deletion of an end-user: anonymized within 24 h (owner/admin)

Authentication
API key or Dashboard session; API key scope admin
Operation id
requestEndUserDeletion
Idempotency
Send an Idempotency-Key to make retries safe.
Path parameters
NameTypeRequired
idstring (uuid)Yes
Headers
NameTypeRequired
x-workspacestring (uuid)Yes
idempotency-keystringpattern ^[A-Za-z0-9_.:-]{8,128}$No
Response 202: 7 fields
Response 202 (application/json)
NameTypeRequired
idstring (uuid)Yes
end_user_idstring (uuid)Yes
status"pending" | "processing" | "completed"Yes
source"operator" | "end_user" | "system"Yes
requested_atstring (date-time)Yes
due_atstring (date-time)Yes
completed_atstring (date-time) | nullYes

Errors: 400, 401, 403, 404, 409, 413, 422, 429, 500, 503, all in the standard error shape.

curl
curl -X POST 'https://api.upvoiced.com/v1/end-users/0190f5e2-4c1d-7a3b-8c2d-5e6f7a8b9c0d/deletion' \
  -H "Authorization: Bearer $UPVOICED_API_KEY" \
  -H "X-Workspace: $UPVOICED_WORKSPACE_ID" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'
TypeScript SDK
const data = await upvoiced.post('/v1/end-users/{id}/deletion', {
  path: { id: '0190f5e2-4c1d-7a3b-8c2d-5e6f7a8b9c0d' },
  body: {},
});
MCP

No MCP tool for this operation. The MCP server covers the everyday reads and writes.