end-users

Delete End Users

Changed on

Delete one end user of the calling service key, or a page of those created before a time.

Requires a service key, and exactly one of external_id and created_before. external_id deletes that end user, any id, one containing '/' included, and answers 404 when it has none. created_before deletes up to limit of the oldest end users created before then; call again until deleted is 0. An end user's telemetry and agent traces are erased with it. The end user's row and spend are kept: a request naming it again revives it with what it had spent, so deleting one cannot clear its budget. A deleted end user is neither listed nor counted.

delete/api/v1/end-users

Request

  • The document declares no server URL.
  • Auth: one of:
    • API key in header Otari-Key
    • API key in header x-api-key

Query parameters

external_idstring nullable

Delete the end user the service names with this user value.

created_beforestring date-time nullable

Delete the end users created before this time, oldest first, up to limit of them.

limitinteger

The most end users one call deletes with created_before.

Response

Successful Response

deletedinteger required

End users deleted by this call. A page as full as the limit may leave more.

Changes