Get Macros For State

Returns available macros for a given order based on state, visibility, permissions, and feature flags.

Overview

• Method: GET
• Path: /brand/macros/get-macros-for-state/<orderId>
• Tags: brand

Parameters

orderId (path)

• Type: string
• Required: Yes
• Description: orderId parameter

Request Body

No request body required.

Responses

200

Successful response

Content Type: application/json

{
  "macros": "string",
  "name": "string",
  "type": "string",
  "visibility": "string",
  "order": 123,
  "data": {
    "key": {}
  },
  "maxRuns": 123,
  "label": "string",
  "style": "string",
  "requiredRole": "string",
  "requiresMacroId": "string",
  "previewMessage": "string",
  "onComplete": "string"
}

400

Bad Request

Content Type: application/json

{
  "error": "string",
  "details": [
    {}
  ]
}

401

Unauthorized

404

Not Found

500

Internal Server Error

Example Usage

curl -X GET \
  https://api.pillexa.com/brand/macros/get-macros-for-state/<orderId> \
  -H "Content-Type: application/json" \