subscribe_to_notifications
Endpoint#
| Property | Value |
|---|---|
| Type | mutation |
| Method | POST |
| Path | /api/external/v1/subscribe_to_notifications |
| Handler | OperatelyWeb.Api.Mutations.SubscribeToNotifications |
Authentication#
- Requires a valid API token.
- Requires a write-enabled token.
- Read-only tokens return
403.
Inputs#
| Field | Type | Required | Nullable | Default |
|---|---|---|---|---|
id | id primitive (encoded as string) | Yes | No | - |
type | subscription_parent_type enum (project_check_in, project_retrospective, goal_update, message, resource_hub_document, resource_hub_file, resource_hub_link, comment_thread, project, milestone, project_task) | Yes | No | - |
Outputs#
This endpoint has no output fields.
cURL Example#
Copied
curl --request POST \
--url "https://app.operately.com/api/external/v1/subscribe_to_notifications" \
--header "Authorization: Bearer ${OPERATELY_API_TOKEN}" \
--header "Content-Type: application/json" \
--data '{"id":"value", "type":"project_check_in"}'