orchestrator
2024.10
false
UiPath logo, featuring letters U and I in white

Orchestrator API guide

Last updated Mar 24, 2026

Get Message Template

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 paramData typeDescription
templateId (required)StringThe 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"
}
  • API Endpoint
  • Scopes
  • Request Headers
  • Path Parameters
  • Responses
  • 200 OK

Was this page helpful?

Connect

Need help? Support

Want to learn? UiPath Academy

Have questions? UiPath Forum

Stay updated