Skip to main content

Get Message Template

Returns a message template, based on the template ID.

API Endpoint

GET {accessURL}/{organizationName}/identity_/api/MessageTemplate/{templateId}

Replace {accessURL} in all endpoint paths with the base URL for your cloud platform:

Cloud platformAccess URL
Test Cloudhttps://cloud.uipath.com/
Test Cloud Public Sectorhttps://govcloud.uipath.us/
Test Cloud Dedicatedhttps://{customURL}.dedicated.uipath.com/

Scopes

Requires the following scopes:

  • PM.MessageTemplate
  • PM.MessageTemplate.Read

Request Headers

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