API Reference

Update a Person's notification channel settings

patch
https://api.wingspan.app/v3/platform/persons//notification-channel-settings

Updates notification channel settings. Omitted channel flags keep their current values. If overrides is present, it replaces the full override list; an empty array clears it. Each override must set exactly one of handle or group. Forced-delivery templates ignore channel preferences.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Unique identifier of a Person.

Body Params

Updates notification channel settings. Omitted channel flags keep their current values. If overrides is present, it replaces the full override list; an empty array clears it.

defaultChannels
object

Channel settings to update. Omitted flags keep their current values.

overrides
array of objects
overrides
Headers
string
length between 1 and 255
^[\x21-\x7e]{1,255}$

Optional idempotency token for authenticated POST and PATCH requests. Reusing the same key and body returns the cached response for 24 hours, except credential operations that explicitly document a 409 because one-time secret material is never cached; reusing it with a different body returns 409 IdempotencyKeyConflict. Use 1-255 printable ASCII characters.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 4 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json

Updated 4 months ago

Did this page help you?