(DELETE) Delete partners

Delete one or more partners using soft delete.

Endpoint

DELETE /api/partners

Delete one or more partners (soft delete). Accepts an array of partner IDs to delete.

Endpoint text
DELETE /api/partners

Authentication

Requires authentication with an API key that has the linksWrite scope.

Request Body

The request body must be an array of partner IDs (UUIDs) to delete.

You can delete up to 10,000 partners in a single request. Requests above 10,000 IDs are rejected.

ParameterTypeRequiredDescription
body (body)array<string>YesArray of partner IDs (UUIDs) to delete. All IDs must be valid and belong to your workspace.

Request Size

Ensure the request body contains at least one valid partner ID.

Examples

Request cURL
curl -X DELETE "https://hoko.to/api/partners" \
  -H "Authorization: Bearer <API_KEY>" \
  -H "Content-Type: application/json" \
  -d '[
    "550e8400-e29b-41d4-a716-446655440000"
  ]'
Request JavaScript
const response = await fetch("https://hoko.to/api/partners", {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer <API_KEY>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify([
    "550e8400-e29b-41d4-a716-446655440000"
  ])
});
const result = await response.json();
Response json
{
  "deletedIds": [
    "550e8400-e29b-41d4-a716-446655440000"
  ]
}