orchestrator
2024.10
false
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
API reference for retrieving a specific message template by template ID via the Identity API.
Returns a message template, based on the template ID.
API Endpoint
GET https://{yourDomain}/{organizationName}/identity/api/MessageTemplate/{templateId}
Scopes
Requires the following scopes:
- PM.MessageTemplate
- PM.MessageTemplate.Read
Request Headers
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
Path Parameters
| Path param | Data type | Description |
|---|---|---|
templateId (required) | String | The ID of message template you want to retrieve. |
Responses
200 OK
Returns the message template information, such as message ID, the message title, and the content.
{
"id": 0,
"name": "string",
"value": "string"
}
{
"id": 0,
"name": "string",
"value": "string"
}