Macros

List Macros

Retrieve list of macros.

GET/workspaces/{workspaceId}/macros

Authorization

useraccessKey

Path parameters

workspaceId*string

Query parameters

Response

200422

OK

Body

application/json

results*array of Macro (object)

nextPageTokenstring

The token that can be passed as pageToken in URL to retrieve the next set of results. If missing, no more results to display.

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/macros', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

200422

{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "response": {
        "type": "text",
        "text": {
          "text": "text",
          "attachments": [
            {
              "mediaUrl": "https://example.com",
              "filename": "text",
              "inline": false
            }
          ],
          "actions": [
            {
              "type": "link",
              "link": {
                "text": "text",
                "url": "text"
              }
            }
          ],
          "metadata": {
            "subject": "text",
            "whatsapp": {
              "previewUrl": false
            },
            "line": {
              "emoji": {
                "items": [
                  {
                    "index": 0,
                    "productId": "text",
                    "emojiId": "text",
                    "length": 0
                  }
                ]
              }
            },
            "telegram": {
              "parseMode": "Markdown"
            }
          }
        }
      },
      "language": "text",
      "usageCount": 0,
      "tags": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "description": "text",
          "status": "draft",
          "category": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "name": "text",
            "description": "text",
            "emoji": "text",
            "createdAt": "text",
            "updatedAt": "text"
          },
          "agentCount": 0,
          "itemCount": 0,
          "macroCount": 0,
          "createdAt": "text",
          "updatedAt": "text",
          "deletedAt": "text",
          "lastUsed": {
            "addedToItemAt": "text",
            "addedToItemId": "123e4567-e89b-12d3-a456-426614174000",
            "removedFromItemAt": "text",
            "removedFromItemId": "123e4567-e89b-12d3-a456-426614174000"
          }
        }
      ],
      "createdAt": "2024-12-22T01:59:35.785Z",
      "updatedAt": "2024-12-22T01:59:35.785Z",
      "actions": [
        {
          "type": "text",
          "source": {
            "macroId": "123e4567-e89b-12d3-a456-426614174000",
            "actionId": "123e4567-e89b-12d3-a456-426614174000"
          },
          "outcome": "OK",
          "cause": "text"
        }
      ]
    }
  ],
  "nextPageToken": "text"
}

Create Macro

Add a new macro to a workspace.

POST/workspaces/{workspaceId}/macros

Authorization

useraccessKey

Path parameters

workspaceId*string

Body

application/json

name*string

The user-defined display name of the macro.

responseMessageBody

languagestring (locale-bcp47)

The optional user-defined language of the macro.

tagIdsarray of string (uuid)

The list of tag IDs to associate with the macro.

actionsMacroActions (array of MacroAction (object))

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

Response

201404409422

Successfully created

Body

application/json

id*string (uuid)

name*string

The user-defined display name of the macro.

responseMessageBody

languagestring (locale-bcp47)

The optional user-defined language of the macro.

usageCountinteger

tagsarray of Tag (object)

createdAt*string (date-time)

updatedAt*string (date-time)

actionsMacroActions (array of MacroAction (object))

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

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/macros', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text"
    }),
});
const data = await response.json();

Response

201404409422

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "response": {
    "type": "text",
    "text": {
      "text": "text",
      "attachments": [
        {
          "mediaUrl": "https://example.com",
          "filename": "text",
          "inline": false
        }
      ],
      "actions": [
        {
          "type": "link",
          "link": {
            "text": "text",
            "url": "text"
          }
        }
      ],
      "metadata": {
        "subject": "text",
        "whatsapp": {
          "previewUrl": false
        },
        "line": {
          "emoji": {
            "items": [
              {
                "index": 0,
                "productId": "text",
                "emojiId": "text",
                "length": 0
              }
            ]
          }
        },
        "telegram": {
          "parseMode": "Markdown"
        }
      }
    }
  },
  "language": "text",
  "usageCount": 0,
  "tags": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "status": "draft",
      "category": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "description": "text",
        "emoji": "text",
        "createdAt": "text",
        "updatedAt": "text"
      },
      "agentCount": 0,
      "itemCount": 0,
      "macroCount": 0,
      "createdAt": "text",
      "updatedAt": "text",
      "deletedAt": "text",
      "lastUsed": {
        "addedToItemAt": "text",
        "addedToItemId": "123e4567-e89b-12d3-a456-426614174000",
        "removedFromItemAt": "text",
        "removedFromItemId": "123e4567-e89b-12d3-a456-426614174000"
      }
    }
  ],
  "createdAt": "2024-12-22T01:59:35.785Z",
  "updatedAt": "2024-12-22T01:59:35.785Z",
  "actions": [
    {
      "type": "text",
      "source": {
        "macroId": "123e4567-e89b-12d3-a456-426614174000",
        "actionId": "123e4567-e89b-12d3-a456-426614174000"
      },
      "outcome": "OK",
      "cause": "text"
    }
  ]
}

Get Macro

Retrieve information about a specific macro.

GET/workspaces/{workspaceId}/macros/{macroId}

Authorization

useraccessKey

Path parameters

workspaceId*string

macroId*string (uuid)

Macro UUID

Response

200404

ok

Body

application/json

id*string (uuid)

name*string

The user-defined display name of the macro.

responseMessageBody

languagestring (locale-bcp47)

The optional user-defined language of the macro.

usageCountinteger

tagsarray of Tag (object)

createdAt*string (date-time)

updatedAt*string (date-time)

actionsMacroActions (array of MacroAction (object))

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

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/macros/{macroId}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

200404

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "response": {
    "type": "text",
    "text": {
      "text": "text",
      "attachments": [
        {
          "mediaUrl": "https://example.com",
          "filename": "text",
          "inline": false
        }
      ],
      "actions": [
        {
          "type": "link",
          "link": {
            "text": "text",
            "url": "text"
          }
        }
      ],
      "metadata": {
        "subject": "text",
        "whatsapp": {
          "previewUrl": false
        },
        "line": {
          "emoji": {
            "items": [
              {
                "index": 0,
                "productId": "text",
                "emojiId": "text",
                "length": 0
              }
            ]
          }
        },
        "telegram": {
          "parseMode": "Markdown"
        }
      }
    }
  },
  "language": "text",
  "usageCount": 0,
  "tags": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "status": "draft",
      "category": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "description": "text",
        "emoji": "text",
        "createdAt": "text",
        "updatedAt": "text"
      },
      "agentCount": 0,
      "itemCount": 0,
      "macroCount": 0,
      "createdAt": "text",
      "updatedAt": "text",
      "deletedAt": "text",
      "lastUsed": {
        "addedToItemAt": "text",
        "addedToItemId": "123e4567-e89b-12d3-a456-426614174000",
        "removedFromItemAt": "text",
        "removedFromItemId": "123e4567-e89b-12d3-a456-426614174000"
      }
    }
  ],
  "createdAt": "2024-12-22T01:59:35.785Z",
  "updatedAt": "2024-12-22T01:59:35.785Z",
  "actions": [
    {
      "type": "text",
      "source": {
        "macroId": "123e4567-e89b-12d3-a456-426614174000",
        "actionId": "123e4567-e89b-12d3-a456-426614174000"
      },
      "outcome": "OK",
      "cause": "text"
    }
  ]
}

Update Macro

Modify fields of a specific macro.

PATCH/workspaces/{workspaceId}/macros/{macroId}

Authorization

useraccessKey

Path parameters

workspaceId*string

macroId*string (uuid)

Macro UUID

Body

application/json

namenullable string

The user-defined display name of the macro.

responseMessageBody

languagenullable string (locale-bcp47)

The optional user-defined language of the macro.

tagIdsarray of string (uuid)

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

actionsMacroActions (array of MacroAction (object))

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

Response

200404422

Successfully updated

Body

application/json

id*string (uuid)

name*string

The user-defined display name of the macro.

responseMessageBody

languagestring (locale-bcp47)

The optional user-defined language of the macro.

usageCountinteger

tagsarray of Tag (object)

createdAt*string (date-time)

updatedAt*string (date-time)

actionsMacroActions (array of MacroAction (object))

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

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/macros/{macroId}', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200404422

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "response": {
    "type": "text",
    "text": {
      "text": "text",
      "attachments": [
        {
          "mediaUrl": "https://example.com",
          "filename": "text",
          "inline": false
        }
      ],
      "actions": [
        {
          "type": "link",
          "link": {
            "text": "text",
            "url": "text"
          }
        }
      ],
      "metadata": {
        "subject": "text",
        "whatsapp": {
          "previewUrl": false
        },
        "line": {
          "emoji": {
            "items": [
              {
                "index": 0,
                "productId": "text",
                "emojiId": "text",
                "length": 0
              }
            ]
          }
        },
        "telegram": {
          "parseMode": "Markdown"
        }
      }
    }
  },
  "language": "text",
  "usageCount": 0,
  "tags": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "status": "draft",
      "category": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "description": "text",
        "emoji": "text",
        "createdAt": "text",
        "updatedAt": "text"
      },
      "agentCount": 0,
      "itemCount": 0,
      "macroCount": 0,
      "createdAt": "text",
      "updatedAt": "text",
      "deletedAt": "text",
      "lastUsed": {
        "addedToItemAt": "text",
        "addedToItemId": "123e4567-e89b-12d3-a456-426614174000",
        "removedFromItemAt": "text",
        "removedFromItemId": "123e4567-e89b-12d3-a456-426614174000"
      }
    }
  ],
  "createdAt": "2024-12-22T01:59:35.785Z",
  "updatedAt": "2024-12-22T01:59:35.785Z",
  "actions": [
    {
      "type": "text",
      "source": {
        "macroId": "123e4567-e89b-12d3-a456-426614174000",
        "actionId": "123e4567-e89b-12d3-a456-426614174000"
      },
      "outcome": "OK",
      "cause": "text"
    }
  ]
}

Delete Macro

Remove a specific macro.

DELETE/workspaces/{workspaceId}/macros/{macroId}

Authorization

useraccessKey

Path parameters

workspaceId*string

macroId*string (uuid)

Macro UUID

Response

204404

Successfully deleted

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/macros/{macroId}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

404

{
  "code": "text",
  "message": "text"
}

Get Macro with variable substitutions applied.

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

POST/workspaces/{workspaceId}/macros/{macroId}/preview

Authorization

useraccessKey

Path parameters

workspaceId*string

macroId*string (uuid)

Macro UUID

Body

application/json

itemIdstring (uuid)

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

contactone of

objectobject

actionsMacroActions (array of MacroAction (object))

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

Response

200404422

ok

Body

application/json

responseMessageBody

actionsMacroActions (array of MacroAction (object))

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

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/macros/{macroId}/preview', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200404422

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