Report Subscription - Update an existing subscription

Update an existing subscription

put
Authorizations
Path parameters
reportSubscriptionIdstring · uuidRequired

Expects id of an existing subscription

reportIdstring · uuidRequired

Expects id of an existing report

Query parameters
versionstringOptional

The requested API version

Default: 1.0
Header parameters
embedfast-user-idstringOptional

Optional User Id

embedfast-user-emailstringOptional

Optional User Email

Body

Class for representing a request to create a new subscription for a report.

subscriptionNamestring | nullableOptional

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.

bookmarkStatestring | nullableOptional

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.

schedulestring | nullableOptional

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.

subscribersstring[] | nullableOptional

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.

subjectstring | nullableOptional

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.

contentstring | nullableOptional

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.

isActivebooleanOptional

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.

reportPageNamestring | nullableOptional

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-timeOptional

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-timeOptional

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.

timeZonestring | nullableOptional

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.

hasAttachmentbooleanOptional

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
200
Success
put
PUT /reports/{reportId}/subscriptions/{reportSubscriptionId} HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 339

{
  "subscriptionName": "text",
  "bookmarkState": "text",
  "schedule": "text",
  "subscribers": [
    "text"
  ],
  "subject": "text",
  "content": "text",
  "isActive": true,
  "reportPageName": "text",
  "startDateTime": "2025-06-27T18:17:31.900Z",
  "endDateTime": "2025-06-27T18:17:31.900Z",
  "timeZone": "text",
  "reportParameter": [
    {
      "name": "text",
      "value": "text"
    }
  ],
  "hasAttachment": true
}
{
  "message": "Success Message",
  "statusCode": 200
}

Last updated