PATCH /api/proactive/preferences

PATCH /api/proactive/preferences

Update Preferences

Authentication: Authorization: Bearer <key> or X-API-Key: <key>. Create keys at developers.cognitivx.io/keys.

Parameters

Name	In	Type	Required	Description
`X-Org-ID`	header	string \| null	No	-

Request body

A JSON request body is required.

Field	Type	Required	Description
`in_app_enabled`	boolean \| null	No	-
`telegram_enabled`	boolean \| null	No	-
`email_enabled`	boolean \| null	No	-
`web_push_enabled`	boolean \| null	No	-
`daily_cap`	integer \| null	No	-
`quiet_start`	integer \| null	No	-
`quiet_end`	integer \| null	No	-
`min_urgency`	string \| null	No	-
`signal_type_opt_ins`	object \| null	No	-

Example request

curl -X PATCH https://api.cognitivx.io/api/proactive/preferences \
  -H "Authorization: Bearer icog_..." \
  -H "Content-Type: application/json" \
  -d '{
    "in_app_enabled": null,
    "telegram_enabled": null,
    "email_enabled": false,
    "web_push_enabled": null,
    "daily_cap": null,
    "quiet_start": null,
    "quiet_end": null,
    "min_urgency": null,
    "signal_type_opt_ins": {}
  }'

Example response

200 application/json

{}

Responses

Status	Description
`200`	Success. Returns the response body shown below.
`422`	Request validation failed. `detail` lists each offending field.