Update Signal

Updates an existing Signal.

Update a signal.

post

/v1/signals/{id}/update

Path parameters

idstringrequired

The id of the signal.

Header parameters

sessionTokenstringrequired

Session authentication token.

keyManagerTokenstring

Key Manager authentication token.

Body

namestring

Signal name

querystring

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.

visibleOnProfileboolean

Whether the signal is visible on its creator's profile

companyWideboolean

Whether the signal is a push signal

Responses

application/json

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'youragentURL.symphony.com/agent/v1/signals/{id}/update' \
  --header 'sessionToken: text' \
  --header 'Content-Type: application/json'

200

400

401

403

451

500

200

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

Signal updated.

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.