(DELETE) Delete partners
Delete one or more partners using soft delete.
Endpoint
DELETE /partners
Delete one or more partners (soft delete). Accepts an array of partner IDs to delete.
Endpoint text
DELETE /partnersAuthentication
Requires an authorized credential with permission for partnersWrite. API keys are one supported credential; eligible OAuth or authenticated sessions may also authorize this operation.
Request Body
The request body must be an array of partner IDs (ULIDs) to delete.
You can delete up to 10,000 partners in a single request. Requests above 10,000 IDs are rejected.
Request Size
Ensure the request body contains at least one valid partner ID.
Examples
Request cURL
curl -X DELETE "https://api.hoko.to/partners" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json" \
-d '[
"<partner_id>"
]'Request JavaScript
const response = await fetch('https://api.hoko.to/partners', {
method: 'DELETE',
headers: {
Authorization: 'Bearer <API_KEY>',
'Content-Type': 'application/json'
},
body: JSON.stringify(['<partner_id>'])
});
const result = await response.json();Response json
{
"deletedIds": ["<partner_id>"]
}