Update Signal

Updates an existing Signal.

Update a signal.

post

Path parameters

idstringRequired

The id of the signal.

Header parameters

sessionTokenstringRequired

Session authentication token.

keyManagerTokenstringOptional

Key Manager authentication token.

Body

namestringOptional

Signal name

querystringOptional

The query used to define this signal. The query is defined as "field:value" pairs combined by the operators "AND" or "OR". Supported fields are (case-insensitive): "author", "hashtag" and "cashtag". MUST contain at least one "hashtag" or "cashtag" definition.

visibleOnProfilebooleanOptional

Whether the signal is visible on its creator's profile

companyWidebooleanOptional

Whether the signal is a push signal

Responses

200

Signal updated.

application/json

Responseall of

400

Client error, see response body for further details.

application/json

401

Unauthorized: Session tokens invalid.

application/json

403

Forbidden: Caller lacks necessary entitlement.

application/json

451

Compliance Issues found in signal

application/json

500

Server error, see response body for further details.

application/json

post

HTTPcURLJavaScriptPython

POST /agent/v1/signals/{id}/update HTTP/1.1
Host: youragentURL.symphony.com
sessionToken: text
Content-Type: application/json
Accept: */*
Content-Length: 73

{
  "name": "text",
  "query": "text",
  "visibleOnProfile": true,
  "companyWide": true
}

{
  "name": "text",
  "query": "text",
  "visibleOnProfile": true,
  "companyWide": true,
  "id": "text",
  "timestamp": 1
}

Request Example

curl -X POST \
  https://acme.symphony.com/agent/v1/signals/5a8da7edb9d82100011d508f/update \
  -H 'content-type: application/json' \
  -H 'sessiontoken: SESSION_TOKEN' \
  -H 'keymanagertoken: KEYMANAGER_TOKEN' \
  -d '{
    "name": "hashtag only",
    "query": "HASHTAG:hash",
    "visibleOnProfile": false,
    "companyWide": false
   }'

🚧 Known Limitations

• To update a company-wide signal, the requesting user needs to have the canCreatePushedSignals entitlement.

• To update a normal signal, the requesting user needs to be the owner of the signal.

• To send numeric cashtags as signals, add a * before the number, for example, $*122450.