Skip to content

edit_subscriptions_list

Endpoint#

PropertyValue
Typemutation
MethodPOST
Path/api/external/v1/edit_subscriptions_list
HandlerOperatelyWeb.Api.Mutations.EditSubscriptionsList

Authentication#

  • Requires a valid API token.
  • Requires a write-enabled token.
  • Read-only tokens return 403.

Inputs#

FieldTypeRequiredNullableDefault
idstringNoYes-
typestringNoYes-
send_notifications_to_everyonebooleanNoYes-
subscriber_idsarray of stringNoYes-

Outputs#

This endpoint has no output fields.

cURL Example#

Copied
curl --request POST \
  --url "https://app.operately.com/api/external/v1/edit_subscriptions_list" \
  --header "Authorization: Bearer ${OPERATELY_API_TOKEN}" \
  --header "Content-Type: application/json" \
  --data '{"id":"value", "send_notifications_to_everyone":true, "subscriber_ids":["value"], "type":"value"}'