Report Subscription - Creates a subscription by report ID

Creates a new subscription for the specified report identified by its ID.

post

/reports/{reportId}/subscriptions

Authorizations

Path parameters

reportIdstring uuidrequired

Enter ID of the report for which the subscription is being created.

Query parameters

versionstring

The requested API version

Header parameters

embedfast-user-idstring

Optional User Id

embedfast-user-emailstring

Optional User Email

Body

application/jsontext/jsonapplication/*+json

subscriptionNamenullable string

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the subscriptionName property.

bookmarkStatenullable string

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the bookmarkState property.

schedulenullable string

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the schedule property.

subscribersnullable string[]

A public property of type list of string that has both a getter and a setter method, which allows for getting and setting the value of the subscribers property.

subjectnullable string

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the subject property.

contentnullable string

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the content property.

isActiveboolean

A public property of type bool that has both a getter and a setter method, which allows for getting and setting the value of the isActive property.

reportPageNamenullable string

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the reportPage property.

startDateTimestring date-time

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the StartDateTime property.

endDateTimestring date-time

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the EndDateTime property.

timeZonenullable string

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the TimeZone(IST etc) property.

reportParameternullable object[]

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the ReportParameter property.

hasAttachmentboolean

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the HasAttachment property.

Responses

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/reports/{reportId}/subscriptions' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"subscriptionName":"Monthly Report Subscription","bookmarkState":"Active","schedule":"0 0 1 * *","subscribers":["[e-mail]","[e-mail]"],"subject":"Monthly Report Summary","content":"This is the content of the monthly report subscription.","isActive":true,"reportPageName":"Sales Dashboard","startDateTime":"2024-09-01T09:00:00","endDateTime":"2024-09-30T18:00:00","timeZone":"(UTC+05:30) Chennai, Kolkata, Mumbai, New Delhi","reportParameter":[{"name":"Parameter1","value":"Value1"},{"name":"Parameter2","value":"Value2"}],"hasAttachment":true}'

201

400

401

403

404

500

201

{
  "reportSubscriptionId": "123e4567-e89b-12d3-a456-426614174000",
  "subscriptionName": "text",
  "reportId": "123e4567-e89b-12d3-a456-426614174000",
  "bookmarkState": "text",
  "createdByUserId": "123e4567-e89b-12d3-a456-426614174000",
  "createdByUserEmail": "text",
  "schedule": "text",
  "subscribers": [
    "text"
  ],
  "subject": "text",
  "content": "text",
  "isActive": true,
  "reportPageName": "text",
  "startDateTime": "2025-02-06T12:41:51.310Z",
  "endDateTime": "2025-02-06T12:41:51.310Z",
  "timeZone": "text",
  "reportParameter": [
    {
      "name": "text",
      "value": "text"
    }
  ],
  "hasAttachment": true,
  "reportParameters": "text"
}

Success: Successfully created a new subscription.