Logo
MicroStrategy REST API API Documentation

Create an instance to update prompt answer that is used to create a subscription for a prompted content

POST {{baseUrl}}/api/subscriptions/:subscriptionId/content/:contentId/instances

Creates an instance for a given content of the subscription. This endpoint returns the ID, and status of the instance.This instance id is then used to update a subscription using PUT /subscriptions/{id}. You obtain the authorization token needed to execute the request using POST /auth/login; you obtain the project ID using GET /projects.You pass the authorization token and the project ID 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 obtain the content ID using GET /subscriptions/ or GET /subscriptions/{subscriptionId}.

 

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




RESPONSES

status Created

{ "id": "D73B9F3411E5C9E00EE20080EFE55B9E", "status": 1, "instanceId": "CC3122CD1B4241229D27BD97F5B56BEF" }



Curl
curl -X POST 'baseUrl/api/subscriptions/:subscriptionId/content/:contentId/instances?fields=' -H 'X-MSTR-AuthToken: authToken' -H 'X-MSTR-ProjectID: projectId'

ENDPOINTS