Skip to content

Update subscription
Stable

Request

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

Fully replaces an existing legacy report subscription with a new configuration, including an updated recipient list and subscription state. Use PUT when you need to overwrite the complete subscription record — supply email_ids (required) and optionally is_subscribed; omitted fields will be cleared.

About Update Report Subscription (Full)

PUT performs a full replacement of the subscription resource identified by subscription_id. Unlike PATCH (which supports partial updates), PUT requires email_ids and overwrites all editable fields. Subscriptions are part of the legacy Daily and Custom Reports system and do not exist in the current Reports API. Use PATCH if you only need to change a single field.

Security
esper_cloud_api_apiKey
Path
subscription_idintegerrequired

A integer value identifying the subscription.

Bodyapplication/jsonrequired
email_idsArray of strings, (email)required
is_subscribedboolean
cURL
curl -i -X PUT \
  '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"
}