Skip to main content
PATCH
/
api
/
signals
/
{id}
Update signal
curl --request PATCH \
  --url https://app.outlit.ai/api/signals/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "kind": "EVENT_MATCH",
  "name": "Workspace inactive",
  "description": null,
  "definition": {
    "grain": "customer",
    "subjectResolver": "event_customer",
    "eventNames": [
      "workspace_inactive"
    ],
    "propertyConditions": [],
    "conditionMode": "ALL"
  }
}
'
{
  "ok": true,
  "commandId": "<string>",
  "commandVersion": 123,
  "correlationId": "<string>",
  "result": {
    "operationId": "<string>",
    "status": "<string>",
    "resources": [
      {
        "type": "<string>",
        "id": "<string>"
      }
    ],
    "data": {
      "signal": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "key": "<string>",
        "name": "<string>",
        "description": "<string>",
        "definition": "<unknown>",
        "schemaVersion": "<string>",
        "configHash": "<string>",
        "archivedAt": "2023-11-07T05:31:56Z",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    },
    "warnings": [
      "<string>"
    ],
    "auditId": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Outlit API key using the Bearer ok_... format.

Path Parameters

​
id
string<uuid>
required

Signal ID.

Body

application/json
​
kind
string
required
Allowed value: "EVENT_MATCH"
​
name
string
required
Required string length: 1 - 120
​
definition
object
required
​
description
string | null
Maximum string length: 1000

Response

Signal was updated.

​
ok
boolean
required
​
commandId
string
required
Allowed value: "signal.update"
​
commandVersion
integer
required
​
correlationId
string
required
​
result
object
required