Skip to main content
PUT
/
notifications
/
preferences
/
{clientId}
Set notification preferences
curl --request PUT \
  --url https://api.sftpsync.io/notifications/preferences/{clientId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "preferences": [
    {
      "isEnabled": true,
      "recipients": [
        "<string>"
      ]
    }
  ]
}
'
[
  {
    "id": "<string>",
    "clientId": "<string>",
    "isEnabled": true,
    "recipients": [
      "<string>"
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "workspaceId": "<string>",
    "metadata": {}
  }
]

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
clientId
string
required

Connection id.

Body

application/json
​
preferences
object[]
required
Minimum array length: 1

Response

200 - application/json

Updated preferences

​
id
string
required
​
clientId
string
required

The connection this preference is scoped to.

​
eventType
enum<string>
required
Available options:
PIPELINE_RUN_FAILED,
PIPELINE_RUN_SUCCEEDED
​
channel
enum<string>
required
Available options:
EMAIL,
SLACK,
SMS
​
isEnabled
boolean
required
​
recipients
string[]
required
​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
workspaceId
string
​
metadata
object