MicroStrategy REST API API Documentation
Create a contact group
POST {{baseUrl}}/api/contactGroups
Create a new contact group.You obtain the authorization token needed to execute the request using POST /auth/login.You pass the authorization token in the request header.You provide the information used to create a contact group 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 | |
Content-Type
|
string |
RESPONSES
status Created
| {
"name": "New contact group",
"id": "6A6CB24E6DC140B0B085649CE9216BDA",
"description": "Contact group description",
"enabled": true,
"linkedUser": {
"name": "San Francisco Manager",
"id": "B6CC2CA24D83B68D80BFB4A86832FC0D"
},
"members": [
{
"name": "San Francisco Music Manager",
"id": "59CCFDF44EAA434CF3B2059143278064",
"description": "",
"enabled": true,
"type": "contact"
}
],
"memberships": []
} |
Curl
curl -X POST 'baseUrl/api/contactGroups?fields=' -H 'X-MSTR-AuthToken: authToken' -H 'Content-Type: application/json' -d '{"linkedUser":{"id":"B6CC2CA24D83B68D80BFB4A86832FC0D"},"members":[{"name":"San Francisco Music Manager","id":"59CCFDF44EAA434CF3B2059143278064","type":"contact"}],"name":"New contact group","description":"Contact group description"}'
ENDPOINTS