API v3 is live and in beta: expect possible malfunctions and breaking changes in the coming days. If you find a bug, please report it to your Sillage contact.

Delete a signal detection

Remove one signal detection of your workspace.

Removes one signal detection of your workspace. Once deleted, it no longer appears in Query signal detections or counts, and no longer resolves by ID.

Route

DELETE/api/v3/signals/{signal_id}

Access modes

Use a workspace API key. The workspace is inferred from the key.

Authorization: Bearer sk_live_...

Path parameters

ParameterTypeDescription
signal_idintegerID of the signal detection.

Example request

curl -X DELETE "https://api.getsillage.com/api/v3/signals/101" \
  -H "Authorization: Bearer $SILLAGE_API_KEY"

Success response

Status: 200 OK

{
  "data": {
    "id": 101,
    "deleted": true
  }
}

Response fields

FieldTypeDescription
data.idintegerID of the signal detection that was deleted.
data.deletedbooleanAlways true.

Errors

StatusMeaning
401The API key is missing or invalid.
404No signal detection matches this ID.
422signal_id is not a valid ID, or a query parameter is sent: this route takes none, and errors names the parameter.
429Rate limit exceeded.
500An 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.

On this page