Package com.intercom.api.resources.unstable.macros

Class RawMacrosClient

java.lang.Object

com.intercom.api.resources.unstable.macros.RawMacrosClient

public class RawMacrosClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
RawMacrosClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
IntercomHttpResponse<java.util.Optional<Macro>>	getMacro(GetMacroRequest request)	You can fetch a single macro (saved reply) by its ID.
IntercomHttpResponse<java.util.Optional<Macro>>	getMacro(GetMacroRequest request, RequestOptions requestOptions)	You can fetch a single macro (saved reply) by its ID.
IntercomHttpResponse<MacroList>	listMacros()	You can fetch a list of all macros (saved replies) in your workspace for use in automating responses.
IntercomHttpResponse<MacroList>	listMacros(ListMacrosRequest request)	You can fetch a list of all macros (saved replies) in your workspace for use in automating responses.
IntercomHttpResponse<MacroList>	listMacros(ListMacrosRequest request, RequestOptions requestOptions)	You can fetch a list of all macros (saved replies) in your workspace for use in automating responses.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

clientOptions

protected final ClientOptions clientOptions

Constructor Detail

RawMacrosClient

public RawMacrosClient(ClientOptions clientOptions)

Method Detail

listMacros

public IntercomHttpResponse<MacroList> listMacros()

You can fetch a list of all macros (saved replies) in your workspace for use in automating responses.

The macros are returned in descending order by updated_at.

Pagination

This endpoint uses cursor-based pagination via the starting_after parameter. The cursor is a Base64-encoded JSON array containing [updated_at, id] of the last item from the previous page.

Placeholder Transformation

The API transforms Intercom placeholders to a more standard XML-like format:

• From: {{user.name | fallback: 'there'}}
• To: <attribute key="user.name" default="there"/>

listMacros

public IntercomHttpResponse<MacroList> listMacros(ListMacrosRequest request)

You can fetch a list of all macros (saved replies) in your workspace for use in automating responses.

The macros are returned in descending order by updated_at.

Pagination

This endpoint uses cursor-based pagination via the starting_after parameter. The cursor is a Base64-encoded JSON array containing [updated_at, id] of the last item from the previous page.

Placeholder Transformation

The API transforms Intercom placeholders to a more standard XML-like format:

• From: {{user.name | fallback: 'there'}}
• To: <attribute key="user.name" default="there"/>

listMacros

public IntercomHttpResponse<MacroList> listMacros(ListMacrosRequest request,
                                                  RequestOptions requestOptions)

You can fetch a list of all macros (saved replies) in your workspace for use in automating responses.

The macros are returned in descending order by updated_at.

Pagination

This endpoint uses cursor-based pagination via the starting_after parameter. The cursor is a Base64-encoded JSON array containing [updated_at, id] of the last item from the previous page.

Placeholder Transformation

The API transforms Intercom placeholders to a more standard XML-like format:

• From: {{user.name | fallback: 'there'}}
• To: <attribute key="user.name" default="there"/>

getMacro

public IntercomHttpResponse<java.util.Optional<Macro>> getMacro(GetMacroRequest request)

You can fetch a single macro (saved reply) by its ID. The macro will only be returned if it is visible to the authenticated user based on its visibility settings.

Visibility Rules

A macro is returned based on its visible_to setting:

• everyone: Always visible to all team members
• specific_teams: Only visible if the authenticated user belongs to one of the teams specified in visible_to_team_ids

If a macro exists but is not visible to the authenticated user, a 404 error is returned.

Placeholder Transformation

The API transforms Intercom placeholders to a more standard XML-like format in the body field:

• From: {{user.name | fallback: 'there'}}
• To: <attribute key="user.name" default="there"/>

Default values in placeholders are HTML-escaped for security.

getMacro

public IntercomHttpResponse<java.util.Optional<Macro>> getMacro(GetMacroRequest request,
                                                                RequestOptions requestOptions)

You can fetch a single macro (saved reply) by its ID. The macro will only be returned if it is visible to the authenticated user based on its visibility settings.

Visibility Rules

A macro is returned based on its visible_to setting:

• everyone: Always visible to all team members
• specific_teams: Only visible if the authenticated user belongs to one of the teams specified in visible_to_team_ids

If a macro exists but is not visible to the authenticated user, a 404 error is returned.

Placeholder Transformation

The API transforms Intercom placeholders to a more standard XML-like format in the body field:

• From: {{user.name | fallback: 'there'}}
• To: <attribute key="user.name" default="there"/>

Default values in placeholders are HTML-escaped for security.