Skip to content

Partially update subscription
Stable

Request

⚠️ Legacy feature. Android only. Daily and Custom Reports are a legacy feature, and report subscriptions are not part of the current reporting system. For current reporting needs, use the Reports API: GET /report/v0/report-types, POST /report/v0/reports, and GET /report/v0/reports/{report_id}.

Partially updates a legacy report subscription, allowing changes to recipient email addresses or subscription state without replacing the full record. Use PATCH when you need to modify only email_ids or is_subscribed — fields omitted from the request body are left unchanged.

About Partial Update Report Subscription

PATCH supports sparse updates to a subscription record. Unlike PUT (full replacement), PATCH lets you supply only the fields to change, making it preferred for toggling is_subscribed or making targeted recipient list changes. Subscriptions are part of the legacy Daily and Custom Reports system and do not exist in the current Reports API.

Security
esper_cloud_api_apiKey
Path
subscription_idintegerrequired

A integer value identifying the subscription.

Bodyapplication/json
email_idsArray of strings, (email)
is_subscribedboolean
cURL
curl -i -X PATCH \
  'https://api.esper.io/_mock/openapi/enterprise/report/subscription/{subscription_id}/' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "email_ids": [
      "user@example.com"
    ],
    "is_subscribed": true
  }'

Responses

successful operation

Bodyapplication/json
idinteger
email_idsArray of strings, (email)
is_subscribedboolean
created_onstring, (date-time)
updated_onstring, (date-time)
Response
{
  "id": 0,
  "email_ids": [
    "user@example.com"
  ],
  "is_subscribed": true,
  "created_on": "2019-08-24T14:15:22Z",
  "updated_on": "2019-08-24T14:15:22Z"
}