Intercom API (unofficial showcase)
GET/macros/{id}

Retrieve a macro

Retrieves a single macro (saved reply) by its identifier. The macro is returned only when its visibility settings allow the authenticated user to view it. The response transforms placeholders in body to an XML-like format and HTML-escapes their default values.

2 parameters
idstringrequired
The unique identifier of the macro to retrieve.
Intercom-Versionstringoptional
The Intercom API version to use. Supported versions include the listed values; defaults to 2.17 when omitted.
Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

4 status codes
200Returns the macro object, including its name, HTML body with transformed placeholders, plain-text body, visibility settings, and timestamps.
typestringoptional
String representing the object's type. Always has the value `macro`.
Allowed:macro
idstringoptional
The unique identifier for the macro.
namestringoptional
The name of the macro.
bodystringoptional
The body of the macro in HTML format with placeholders transformed to XML-like format.
body_textstringoptional
The plain text version of the macro body with original Intercom placeholder format.
created_atstringoptional
The time the macro was created in ISO 8601 format.
updated_atstringoptional
The time the macro was last updated in ISO 8601 format.
visible_tostringoptional
Who can view this macro.
Allowed:everyonespecific_teams
visible_to_team_idsarray<string>optional
The team IDs that can view this macro when visible_to is set to specific_teams.
available_onarray<string>optional
Where the macro is available for use.
401Returned when the request is unauthorized.

One documented failure

  • unauthorized

    Access Token Invalid

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects
403Returned when the request lacks the required OAuth scope.

One documented failure

  • forbidden

    You do not have the required scope (read_conversations) to access this resource

    OAuth token lacks read_conversations scope

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects
404Returned when the macro does not exist or is not accessible to the authenticated user.

One documented failure

  • not_found

    Macro not found

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects

Error handling

A 401 is returned when the request is unauthorized. A 403 is returned when the request lacks the required OAuth scope. A 404 is returned when the macro does not exist or is not visible to the authenticated user; the id path parameter must identify an accessible macro.