Automation Suite API guide

Last updated Nov 11, 2025

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 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"
}

On this page

API Endpoint
Scopes
Request Headers
Path Parameters
Responses
200 OK

Was this page helpful?

PREVIOUSMessage Template

NEXTUpdate a Message Template

Support and Services

Get The Help You Need

UiPath Academy

Learning RPA - Automation Courses

UiPath Forum

UiPath Community Forum

Trust and Security

Cookies Policy