Update notification preferences snapshot

PATCH/v1/settings/notifications

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Request body

requiredapplication/json

settingsSettingsNotificationItem[] | nullrequired

Show properties

Array of SettingsNotificationItem

descriptionstringrequired

enabledbooleanrequired

keystringrequired

labelstringrequired

Responses

200OK

itemsSettingsNotificationItem[] | nullrequired

Show properties

Array of SettingsNotificationItem

descriptionstringrequired

enabledbooleanrequired

keystringrequired

labelstringrequired

400Bad Request

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

401Unauthorized

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

403Forbidden

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

422Unprocessable Entity

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

500Internal Server Error

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

Request

curl -X PATCH "/v1/settings/notifications" \
  -H "Content-Type: application/json" \
  -d '{
  "settings": [
    {
      "description": "string",
      "enabled": true,
      "key": "string",
      "label": "string"
    }
  ]
}'

const response = await fetch("/v1/settings/notifications", {
  method: "PATCH",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "settings": [
    {
      "description": "string",
      "enabled": true,
      "key": "string",
      "label": "string"
    }
  ]
})
});

import requests

response = requests.patch(
    "/v1/settings/notifications",
    headers={
        "Content-Type": "application/json"
    },
    json={
  "settings": [
    {
      "description": "string",
      "enabled": True,
      "key": "string",
      "label": "string"
    }
  ]
},
)

Response

{
  "items": [
    {
      "description": "string",
      "enabled": true,
      "key": "string",
      "label": "string"
    }
  ]
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}