Brand
Macros
Archive Macro

Archive Macro

Archives a macro with a reason and optional description, recording the user who performed the action.

Overview

  • Method: POST
  • Path: /brand/macros/archive-macro/<id>
  • Tags: brand

Parameters

id (path)

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

Request Body

  • Content Type: application/json
  • Required: Yes

Fields

FieldTypeRequiredDetails
reasonstringYes
descriptionstringYes

Responses

200

Successful response

Content Type: application/json

{
  "id": "string",
  "name": "string",
  "isArchived": true,
  "archivedAt": "2024-01-01T00:00:00.000Z",
  "archivedBy": "string",
  "archive_reason": "string",
  "description": "string"
}

400

Bad Request

Content Type: application/json

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

401

Unauthorized

404

Not Found

500

Internal Server Error

Example Usage

curl -X POST \
  https://api.pillexa.com/brand/macros/archive-macro/<id> \
  -H "Content-Type: application/json" \
  -d '{"example": "data"}'
VerifyGet Macro