Macros

Last updated 6 months ago

Was this helpful?

Get Macro

get

Retrieve information about a specific macro.

Authorizations

Path parameters

workspaceIdstringrequired

macroIdstring · uuidrequired

Macro UUID

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/workspaces/{workspaceId}/macros/{macroId}' \
  --header 'Authorization: Bearer jwt'

200

404

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "response": {
    "type": "text",
    "text": {
      "text": "text",
      "attachments": [
        {
          "mediaUrl": "https://example.com",
          "filename": "text",
          "inline": true
        }
      ],
      "actions": [
        {
          "type": "link",
          "link": {
            "text": "text",
            "url": "text"
          }
        }
      ],
      "metadata": {
        "subject": "text",
        "headers": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "whatsapp": {
          "previewUrl": true
        },
        "line": {
          "emoji": {
            "items": [
              {
                "index": 1,
                "productId": "text",
                "emojiId": "text",
                "length": 1
              }
            ]
          }
        },
        "telegram": {
          "parseMode": "Markdown"
        }
      }
    }
  },
  "language": "text",
  "usageCount": 1,
  "tags": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "status": "draft",
      "category": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "description": "text",
        "icon": "none",
        "emoji": "text",
        "createdAt": "text",
        "updatedAt": "text"
      },
      "agentCount": 1,
      "itemCount": 1,
      "macroCount": 1,
      "createdAt": "text",
      "updatedAt": "text",
      "deletedAt": "text",
      "lastUsed": {
        "addedToItemAt": "text",
        "addedToItemId": "123e4567-e89b-12d3-a456-426614174000",
        "removedFromItemAt": "text",
        "removedFromItemId": "123e4567-e89b-12d3-a456-426614174000"
      },
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "createdAt": "2025-03-28T18:26:19.961Z",
  "updatedAt": "2025-03-28T18:26:19.961Z",
  "actions": [
    {
      "type": "text",
      "params": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "source": {
        "macroId": "123e4567-e89b-12d3-a456-426614174000",
        "actionId": "123e4567-e89b-12d3-a456-426614174000"
      },
      "outcome": "OK",
      "cause": "text"
    }
  ]
}

Delete Macro

delete

Remove a specific macro.

Authorizations

Path parameters

workspaceIdstringrequired

macroIdstring · uuidrequired

Macro UUID

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/workspaces/{workspaceId}/macros/{macroId}' \
  --header 'Authorization: Bearer jwt'

204

404

No body

Successfully deleted

List Macros

get

Retrieve list of macros.

Authorizations

Path parameters

workspaceIdstringrequired

Query parameters

limitinteger · min: 1 · max: 100 · default: 10optional

Limits the number of results to return

pageTokenstring · max: 8000optional

Pagination token that keeps of track of the current position in the list

reverseboolean · default: falseoptional

Order in which to retrieve the results

sortstring · enum · default: "createdAt"optional

The field by which to sort macros.

Options: createdAt, updatedAt, name, language

qstringoptional

A full-text search parameter that searches for macros by name, response body, and/or tag name.

languagesstring · locale-bcp47[]optional

Filter macros by language. Multiple languages are combined with a logical OR.

tagIdsstring · uuid[]optional

Filter macros by tag IDs. Multiple tag IDs are combined with a logical AND.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/workspaces/{workspaceId}/macros' \
  --header 'Authorization: Bearer jwt'

200

422

{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "response": {
        "type": "text",
        "text": {
          "text": "text",
          "attachments": [
            {
              "mediaUrl": "https://example.com",
              "filename": "text",
              "inline": true
            }
          ],
          "actions": [
            {
              "type": "link",
              "link": {
                "text": "text",
                "url": "text"
              }
            }
          ],
          "metadata": {
            "subject": "text",
            "headers": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "whatsapp": {
              "previewUrl": true
            },
            "line": {
              "emoji": {
                "items": [
                  {
                    "index": 1,
                    "productId": "text",
                    "emojiId": "text",
                    "length": 1
                  }
                ]
              }
            },
            "telegram": {
              "parseMode": "Markdown"
            }
          }
        }
      },
      "language": "text",
      "usageCount": 1,
      "tags": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "description": "text",
          "status": "draft",
          "category": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "name": "text",
            "description": "text",
            "icon": "none",
            "emoji": "text",
            "createdAt": "text",
            "updatedAt": "text"
          },
          "agentCount": 1,
          "itemCount": 1,
          "macroCount": 1,
          "createdAt": "text",
          "updatedAt": "text",
          "deletedAt": "text",
          "lastUsed": {
            "addedToItemAt": "text",
            "addedToItemId": "123e4567-e89b-12d3-a456-426614174000",
            "removedFromItemAt": "text",
            "removedFromItemId": "123e4567-e89b-12d3-a456-426614174000"
          },
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      ],
      "createdAt": "2025-03-28T18:26:19.961Z",
      "updatedAt": "2025-03-28T18:26:19.961Z",
      "actions": [
        {
          "type": "text",
          "params": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "source": {
            "macroId": "123e4567-e89b-12d3-a456-426614174000",
            "actionId": "123e4567-e89b-12d3-a456-426614174000"
          },
          "outcome": "OK",
          "cause": "text"
        }
      ]
    }
  ],
  "nextPageToken": "text"
}

Create Macro

post

Add a new macro to a workspace.

Authorizations

Path parameters

workspaceIdstringrequired

Body

namestring · min: 1 · max: 255required

The user-defined display name of the macro.

responseall of | nullableoptional

languagestring · locale-bcp47optional

The optional user-defined language of the macro.

tagIdsstring · uuid[] · max: 25optional

The list of tag IDs to associate with the macro.

actionsobject[]optional

A list of macro actions to be executed. The order of actions may be changed by the service.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/workspaces/{workspaceId}/macros' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "response": {
      "type": "text",
      "text": {
        "text": "text",
        "attachments": [
          {
            "mediaUrl": "https://example.com",
            "filename": "text",
            "inline": true
          }
        ],
        "actions": [
          {
            "type": "link",
            "link": {
              "text": "text",
              "url": "text"
            }
          }
        ],
        "metadata": {
          "subject": "text",
          "headers": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "whatsapp": {
            "previewUrl": true
          },
          "line": {
            "emoji": {
              "items": [
                {
                  "index": 1,
                  "productId": "text",
                  "emojiId": "text",
                  "length": 1
                }
              ]
            }
          },
          "telegram": {
            "parseMode": "Markdown"
          }
        }
      }
    },
    "language": "text",
    "tagIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "actions": [
      {
        "type": "text",
        "params": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "source": {
          "macroId": "123e4567-e89b-12d3-a456-426614174000",
          "actionId": "123e4567-e89b-12d3-a456-426614174000"
        },
        "outcome": "OK",
        "cause": "text"
      }
    ]
  }'

201

404

409

422

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "response": {
    "type": "text",
    "text": {
      "text": "text",
      "attachments": [
        {
          "mediaUrl": "https://example.com",
          "filename": "text",
          "inline": true
        }
      ],
      "actions": [
        {
          "type": "link",
          "link": {
            "text": "text",
            "url": "text"
          }
        }
      ],
      "metadata": {
        "subject": "text",
        "headers": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "whatsapp": {
          "previewUrl": true
        },
        "line": {
          "emoji": {
            "items": [
              {
                "index": 1,
                "productId": "text",
                "emojiId": "text",
                "length": 1
              }
            ]
          }
        },
        "telegram": {
          "parseMode": "Markdown"
        }
      }
    }
  },
  "language": "text",
  "usageCount": 1,
  "tags": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "status": "draft",
      "category": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "description": "text",
        "icon": "none",
        "emoji": "text",
        "createdAt": "text",
        "updatedAt": "text"
      },
      "agentCount": 1,
      "itemCount": 1,
      "macroCount": 1,
      "createdAt": "text",
      "updatedAt": "text",
      "deletedAt": "text",
      "lastUsed": {
        "addedToItemAt": "text",
        "addedToItemId": "123e4567-e89b-12d3-a456-426614174000",
        "removedFromItemAt": "text",
        "removedFromItemId": "123e4567-e89b-12d3-a456-426614174000"
      },
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "createdAt": "2025-03-28T18:26:19.961Z",
  "updatedAt": "2025-03-28T18:26:19.961Z",
  "actions": [
    {
      "type": "text",
      "params": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "source": {
        "macroId": "123e4567-e89b-12d3-a456-426614174000",
        "actionId": "123e4567-e89b-12d3-a456-426614174000"
      },
      "outcome": "OK",
      "cause": "text"
    }
  ]
}

Successfully created

Update Macro

patch

Modify fields of a specific macro.

Authorizations

Path parameters

workspaceIdstringrequired

macroIdstring · uuidrequired

Macro UUID

Body

namestring | nullableoptional

The user-defined display name of the macro.

responseall of | nullableoptional

languagestring · locale-bcp47 | nullableoptional

The optional user-defined language of the macro.

tagIdsstring · uuid[] · max: 25optional

The list of tag IDs to associate with the macro. An empty list will remove all tags.

actionsobject[]optional

A list of macro actions to be executed. The order of actions may be changed by the service.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url '/workspaces/{workspaceId}/macros/{macroId}' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "response": {
      "type": "text",
      "text": {
        "text": "text",
        "attachments": [
          {
            "mediaUrl": "https://example.com",
            "filename": "text",
            "inline": true
          }
        ],
        "actions": [
          {
            "type": "link",
            "link": {
              "text": "text",
              "url": "text"
            }
          }
        ],
        "metadata": {
          "subject": "text",
          "headers": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "whatsapp": {
            "previewUrl": true
          },
          "line": {
            "emoji": {
              "items": [
                {
                  "index": 1,
                  "productId": "text",
                  "emojiId": "text",
                  "length": 1
                }
              ]
            }
          },
          "telegram": {
            "parseMode": "Markdown"
          }
        }
      }
    },
    "language": "text",
    "tagIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "actions": [
      {
        "type": "text",
        "params": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "source": {
          "macroId": "123e4567-e89b-12d3-a456-426614174000",
          "actionId": "123e4567-e89b-12d3-a456-426614174000"
        },
        "outcome": "OK",
        "cause": "text"
      }
    ]
  }'

200

404

422

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "response": {
    "type": "text",
    "text": {
      "text": "text",
      "attachments": [
        {
          "mediaUrl": "https://example.com",
          "filename": "text",
          "inline": true
        }
      ],
      "actions": [
        {
          "type": "link",
          "link": {
            "text": "text",
            "url": "text"
          }
        }
      ],
      "metadata": {
        "subject": "text",
        "headers": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "whatsapp": {
          "previewUrl": true
        },
        "line": {
          "emoji": {
            "items": [
              {
                "index": 1,
                "productId": "text",
                "emojiId": "text",
                "length": 1
              }
            ]
          }
        },
        "telegram": {
          "parseMode": "Markdown"
        }
      }
    }
  },
  "language": "text",
  "usageCount": 1,
  "tags": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "status": "draft",
      "category": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "description": "text",
        "icon": "none",
        "emoji": "text",
        "createdAt": "text",
        "updatedAt": "text"
      },
      "agentCount": 1,
      "itemCount": 1,
      "macroCount": 1,
      "createdAt": "text",
      "updatedAt": "text",
      "deletedAt": "text",
      "lastUsed": {
        "addedToItemAt": "text",
        "addedToItemId": "123e4567-e89b-12d3-a456-426614174000",
        "removedFromItemAt": "text",
        "removedFromItemId": "123e4567-e89b-12d3-a456-426614174000"
      },
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "createdAt": "2025-03-28T18:26:19.961Z",
  "updatedAt": "2025-03-28T18:26:19.961Z",
  "actions": [
    {
      "type": "text",
      "params": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "source": {
        "macroId": "123e4567-e89b-12d3-a456-426614174000",
        "actionId": "123e4567-e89b-12d3-a456-426614174000"
      },
      "outcome": "OK",
      "cause": "text"
    }
  ]
}

Successfully updated

Get Macro with variable substitutions applied.

post

Retrieves the macro with variable substitutions applied to the response body.

Authorizations

Path parameters

workspaceIdstringrequired

macroIdstring · uuidrequired

Macro UUID

Body

itemIdstring · uuidoptional

The ID of the feed item to source variables from. May be omitted where no feed item exists.

contactIdstring · uuidoptionalDeprecated

The ID of the contact to source variables from. If not provided, the macro will attempt to find a contact from the feed item.

contactone ofoptional

The ID of the contact to source variables from. If not provided, the macro will attempt to find a contact from the feed item.

actionsobject[]optional

A list of macro actions to be executed. The order of actions may be changed by the service.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/workspaces/{workspaceId}/macros/{macroId}/preview' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{
    "itemId": "123e4567-e89b-12d3-a456-426614174000",
    "contactId": "123e4567-e89b-12d3-a456-426614174000",
    "contact": {
      "id": "123e4567-e89b-12d3-a456-426614174000"
    },
    "actions": [
      {
        "type": "text",
        "params": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "source": {
          "macroId": "123e4567-e89b-12d3-a456-426614174000",
          "actionId": "123e4567-e89b-12d3-a456-426614174000"
        },
        "outcome": "OK",
        "cause": "text"
      }
    ]
  }'

200

404

422

{
  "response": {
    "type": "text",
    "text": {
      "text": "text",
      "attachments": [
        {
          "mediaUrl": "https://example.com",
          "filename": "text",
          "inline": true
        }
      ],
      "actions": [
        {
          "type": "link",
          "link": {
            "text": "text",
            "url": "text"
          }
        }
      ],
      "metadata": {
        "subject": "text",
        "headers": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "whatsapp": {
          "previewUrl": true
        },
        "line": {
          "emoji": {
            "items": [
              {
                "index": 1,
                "productId": "text",
                "emojiId": "text",
                "length": 1
              }
            ]
          }
        },
        "telegram": {
          "parseMode": "Markdown"
        }
      }
    }
  },
  "actions": [
    {
      "type": "text",
      "params": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "source": {
        "macroId": "123e4567-e89b-12d3-a456-426614174000",
        "actionId": "123e4567-e89b-12d3-a456-426614174000"
      },
      "outcome": "OK",
      "cause": "text"
    }
  ]
}

Get Macro

Delete Macro

List Macros

Create Macro

Show child attributes

Show child attributes

Show child attributes

Update Macro

Show child attributes

Show child attributes

Show child attributes

Get Macro with variable substitutions applied.

Show child attributes

Show child attributes

Show child attributes