orchestrator
2025.10
true
Orchestrator API guide
- Getting started
- Authentication
- Swagger definition
- Orchestrator APIs
- Alerts Requests
- Assets requests
- Calendars requests
- Environments requests
- Folders requests
- Generic Tasks requests
- Jobs requests
- Libraries requests
- License requests
- Packages requests
- Permissions requests
- Personal workspaces requests
- Processes requests
- Queue Items requests
- Queue retention policy requests
- Robots requests
- Roles requests
- Schedules requests
- Settings requests
- Storage bucket requests
- Tasks requests
- Task Catalogs requests
- Task Forms requests
- Tenants requests
- Transactions requests
- Users requests
- Webhooks requests
- Platform Management APIs
- Get Message Template
- Update a Message Template
- Get Message Template by Name
Overview of the Update Message Template endpoint, including required scopes and request structure
Updates an existing message template, by the template ID.
API Endpoint
PUT https://{yourDomain}/identity/api/MessageTemplate/{templateId}
Scopes
Requires the following scopes:
- PM.MessageTemplate
- PM.MessageTemplate.Write
Request Headers
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
Path Parameters
| Param | Data type | Description |
|---|---|---|
templateId (required) | String | The ID of message template you want to update. |
Request Body
The request body contains the message ID and the new content.
{
"id": 0,
"value": "string"
}
{
"id": 0,
"value": "string"
}
Responses
200 OK
The message template gets updated and returns the new information.
{
"id": 0,
"name": "string",
"value": "string"
}
{
"id": 0,
"name": "string",
"value": "string"
}