UiPath Documentation
automation-cloud
latest
false
Automation Cloud API guide

Get Message Template by Name

API endpoint that returns message templates filtered by name, using the PM.MessageTemplate scope.

Returns message templates, filtered by name.

API Endpoint

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

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

Cloud platformAccess URL
Automation Cloudhttps://cloud.uipath.com/
Automation Cloud Public Sectorhttps://govcloud.uipath.us/
Automation 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'
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'

Query Parameters

ParamData typeDescription
nameStringThe name of the message template.

Responses

200 OK

Returns the message templates filtered by their names.

{
  "id": 0,
  "name": "string",
  "value": "string"
}
{
  "id": 0,
  "name": "string",
  "value": "string"
}
  • API Endpoint
  • Scopes
  • Request Headers
  • Query Parameters
  • Responses
  • 200 OK

Was this page helpful?

Connect

Need help? Support

Want to learn? UiPath Academy

Have questions? UiPath Forum

Stay updated