MicroStrategy REST API API Documentation
Update subscription
PUT {{baseUrl}}/api/subscriptions/:id
Update all of the information for a specific subscription. You obtain the authorization token needed to execute the request using POST /auth/login; you pass the authorization token in the request header. You identify the subscription by specifying the subscription ID in the path of the request; you obtain the subscription ID using GET /subscriptions/. You provide the information used to update the subscription in the body parameter of the request.
Body
PARAM
| Key | Datatype | Required | Description |
fields
|
null | Comma-separated, top-level field whitelist that allows the client to selectively retrieve part of the response model. If specified, extra filtering is applied, and for top-level object (if root model is an array, each array element), only the listed fields are kept in the response. For example, "id,elements" keeps only the "id" field and whole "elements" array field, omitting all other fields in the top-level response model. |
HEADERS
| Key | Datatype | Required | Description |
X-MSTR-AuthToken
|
string | (Required) Authorization token | |
X-MSTR-ProjectID
|
string | (Required) Project ID | |
Content-Type
|
string |
RESPONSES
status OK
| {
"id": "BC9B243CF04FD0E989CB77856A762396",
"multipleContents": false,
"name": "Test Subscription",
"editable": true,
"allowDeliveryChanges": false,
"allowPersonalizationChanges": false,
"allowUnsubscribe": false,
"dateCreated": "2022-03-28T19:49:50+0000",
"dateModified": "2022-03-28T20:01:47+0000",
"owner": {
"id": "7FC05A65473CE2FD845CE6A1D3F13233",
"name": "MSTR User"
},
"schedules": [
{
"id": "E24F501E802911E1BBCB892C4924019B",
&q Curl curl -X PUT 'baseUrl/api/subscriptions/:id?fields=' -H 'X-MSTR-AuthToken: authToken' -H 'X-MSTR-ProjectID: projectId' -H 'Content-Type: application/json' -d '{"name":"Test Subscription","contents":[{"id":"D73B9F3411E5C9E00EE20080EFE55B9E","name":"Tutorial Home","type":"document","personalization":{"compressed":false,"formatMode":"DEFAULT","formatType":"PDF"}}],"schedules":[{"id":"E24F501E802911E1BBCB892C4924019B","name":"Personal View","type":"unknown"}],"recipients":[{"id":"54F3D26011D2896560009A8E67019608","name":"Administrator","isGroup":false,"type":"user","includeType":"TO","childSubscriptionId":"7283682811E5CA909DFA0080EFB579EC"}],"delivery":{"mode":"HISTORY_LIST","historyList":{"doNotCreateUpdateCaches":false,"overwriteOlderVersion":true,"reRunHl":false}}}' ENDPOINTS |