Delete a client's signal detection
Remove one signal detection of a client's workspace.
Removes one signal detection of the named client. Once deleted, it no longer appears in Query a client's signal detections or counts, and no longer resolves by ID.
Route
DELETE/api/v3/partner/workspaces/{partner_workspace_id}/signals/{signal_id}
Path parameters
| Parameter | Type | Description |
|---|---|---|
| partner_workspace_id | string | Your own ID for the client workspace, as you chose it at creation. URL-encode it in the path. |
| signal_id | integer | ID of the signal detection. |
Example request
curl -X DELETE "https://api.getsillage.com/api/v3/partner/workspaces/ws_123/signals/101" \
-H "Authorization: Bearer $SILLAGE_MASTER_KEY"Success response
Status: 200 OK
{
"data": {
"id": 101,
"deleted": true
}
}Response fields
| Field | Type | Description |
|---|---|---|
| data.id | integer | ID of the signal detection that was deleted. |
| data.deleted | boolean | Always true. |
Errors
| Status | Meaning |
|---|---|
| 401 | The master key is missing or invalid. |
| 404 | No workspace found for this partner_workspace_id, or no signal detection matches this ID. |
| 422 | signal_id is not a valid ID. Also returned when partner_workspace_id is invalid, or a query parameter is sent: this route takes none, and errors names the parameter. |
| 429 | Rate limit exceeded. |
| 500 | An unexpected server error occurred. |
Error responses use RFC 9457 problem documents with Content-Type: application/problem+json. type is always about:blank; code tells one problem from another, detail says what went wrong this time, and errors names the field at fault.