Create a Macro

Develop Env

http://localhost:3030

POST

/api/v1/accounts/{account_id}/macros

Create a new macro in the account.

Macros can have different visibility levels:

personal: Only visible to the creator

global: Visible to all users in the account

Agents can only create personal macros.

Request

Authorization

API Key

Add parameter in header

api_access_token

Example:

api_access_token: ********************

Path Params

Body Params application/json; charset=utf-8Required

Examples

Responses

🟢200

application/json; charset=utf-8

Success - Created macro

Body

🟠400

🟠401

🟠422

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'http://localhost:3030/api/v1/accounts//macros' \
--header 'api_access_token: <api-key>' \
--header 'Content-Type: application/json; charset=utf-8' \
--data-raw '{
    "name": "Resolve and Close",
    "visibility": "personal",
    "actions": [
        {
            "action_name": "send_message",
            "action_params": [
                "Hello, thank you for contacting us!"
            ]
        }
    ]
}'

Response Example

200 - Example 1

{
    "id": 1,
    "name": "Resolve and Close",
    "visibility": "personal",
    "account_id": 1,
    "actions": [
        {
            "action_name": "send_message",
            "action_params": [
                "string"
            ]
        }
    ],
    "created_by": {
        "id": 0,
        "uid": "string",
        "name": "string",
        "available_name": "string",
        "display_name": "string",
        "email": "string",
        "account_id": 0,
        "role": "agent",
        "confirmed": true,
        "availability_status": "available",
        "auto_offline": true,
        "custom_attributes": {}
    },
    "updated_by": {
        "id": 0,
        "uid": "string",
        "name": "string",
        "available_name": "string",
        "display_name": "string",
        "email": "string",
        "account_id": 0,
        "role": "agent",
        "confirmed": true,
        "availability_status": "available",
        "auto_offline": true,
        "custom_attributes": {}
    },
    "files": [
        {
            "id": 0,
            "macro_id": 0,
            "file_type": "string",
            "account_id": 0,
            "file_url": "string",
            "blob_id": 0,
            "filename": "string"
        }
    ],
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
}

Modified at 2025-12-16 21:29:06

List all Macros

Get a Macro