Logo
MicroStrategy REST API API Documentation

Send subscription

POST {{baseUrl}}/api/v2/subscriptions/:id/send

Send the existing subscription immediately. You obtain the authorization token needed to execute the request using POST /auth/login; You pass the authorization token in the request header. You obtain the project ID using GET /projects.You identify the project by specifying the project ID in the request; You identify the subscription by specifying the subscription ID in the request; you obtain the subscription ID using GET /subscriptions/. You provide the information to send the subscription ID in the path parameter of the request. If the content is prompted and user wants to update answers, user can answer prompts and then provide a list of content id and instance id as body.

 

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



Curl
curl -X POST 'baseUrl/api/v2/subscriptions/:id/send?fields=' -H 'X-MSTR-AuthToken: authToken' -H 'X-MSTR-ProjectID: projectId' -H 'Content-Type: application/json'

ENDPOINTS