Update transmitter

PUT {{baseUrl}}/api/transmitters/:id

Update all of the information for a specific transmitter. 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 transmitter ID using GET /transmitters. You pass the transmitter ID in the path of the request. You provide the information used to update the specific transmitter in the body parameter of the request.

Request Params

KeyDatatypeRequiredDescription
fieldsnullComma-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.

Request Body

{"name"=>"Test email transmitter(Updated)", "description"=>"A email transmitter", "deliveryType"=>"email", "emailTransmitterProperties"=>{"senderDisplayName"=>"MicroStrategy Distribution Services", "senderEmailAddress"=>"DistributionServices@MicroStrategy.com", "replyToDisplayName"=>"MicroStrategy Distribution Services", "replyToEmailAddress"=>"DistributionServices@MicroStrategy.com"}}

HEADERS

KeyDatatypeRequiredDescription
X-MSTR-AuthTokenstring(Required) Authorization token