Skip to content
Home/
REST API Reference
/
/
Macro

Macro

A macro is a pre-defined response template (saved reply) that can be used to quickly reply to conversations.

typestring

String representing the object's type. Always has the value macro.

Value:"macro"
Example:"macro"
idstring

The unique identifier for the macro.

Example:"123"
namestring

The name of the macro.

Example:"Order Status Update"
bodystring

The body of the macro in HTML format with placeholders transformed to XML-like format.

Example:"<p>Hi <attribute key=\"user.name\" default=\"there\"/>, your order is ready!</p>"
body_textstring

The plain text version of the macro body with original Intercom placeholder format.

Example:"Hi {{user.name|fallback:\"there\"}}, your order is ready!"
created_atstring, (date-time)

The time the macro was created in ISO 8601 format.

Example:"2025-07-17T11:18:08.000Z"
updated_atstring, (date-time)

The time the macro was last updated in ISO 8601 format.

Example:"2025-07-17T15:30:24.000Z"
visible_tostring

Who can view this macro.

Enum:"everyone""specific_teams"
Example:"everyone"
visible_to_team_idsArray of strings

The team IDs that can view this macro when visible_to is set to specific_teams.

Example:
[
  "456",
  "789"
]
available_onArray of strings

Where the macro is available for use.

Items Enum:"inbox""messenger"
Example:
[
  "inbox",
  "messenger"
]
{
  "type": "macro",
  "id": "123",
  "name": "Order Status Update",
  "body": "<p>Hi <attribute key=\"user.name\" default=\"there\"/>, your order is ready!</p>",
  "body_text": "Hi {{user.name|fallback:\"there\"}}, your order is ready!",
  "created_at": "2025-07-17T11:18:08.000Z",
  "updated_at": "2025-07-17T15:30:24.000Z",
  "visible_to": "everyone",
  "visible_to_team_ids": [
    "456",
    "789"
  ],
  "available_on": [
    "inbox",
    "messenger"
  ]
}