Signals API - Clients

Delete a user

  • Sandbox: available
  • Staging: available
  • Production: unknown
DELETE
/v1/signals/api/user/{id}

Revokes the credential at once and drops its undelivered webhook events.

Through ovok

  • Who can call it: Manager apps, and users whose access policy grants the capabilities.
  • Capabilities, all required: signals_webhooks:delete. Project admins have every capability; client applications get no admin bypass.
  • Only subscribers are deleted through ovok.
  • It can reach any patient of your project without naming one, so it is for callers that reach every patient: project admins, manager or submitter apps, and anyone whose Patient access has no criteria.

Authorization

headerAuthorizationBearer <JWT>

Path Parameters

id*string

Response Body

Deleted: the id of the user that is gone.

application/json
  1. response
_id*string
id*string
Example Request
curl -X DELETE 'https://api.sandbox.ovok.com/v1/signals/api/user/string'
Example Response
{  "_id": "string",  "id": "string"}