Update Order Tag

🏷️ Use this endpoint to set a custom tag on one of your orders. Tags are a free-text label you control — use them to group or annotate orders however is useful to you (e.g. "campaign-q3", "client-acme").

🔑 Authentication

Requires a valid API token.

PATCH /api/v1/orders/:uuid/tag

🔑 Path Parameters

`uuid` (required)

The order's ID (e.g. "rec_XXXXXXXXXXXXXXXX"), as returned by GET /orders or GET /orders/:uuid.

🔑 Query Parameters

`organization_id` (required)

Your organization's ID. The order must belong to this organization.

🔑 Request Body Parameters

`tag` (required)

The tag value to set on the order.

Must be a string.

Maximum length: 320 characters.

Pass an empty string "" to clear an existing tag.

{ "tag": "campaign-q3" }

📋 Example Request

PATCH /api/v1/orders/rec_XXXXXXXXXXXXXXXX/tag?organization_id=recXXXXXXXXXXXXXX

{
  "tag": "campaign-q3"
}

✅ Response

{
  "message": "Updated Successfully"
}

⚠️ Error Responses

Missing or invalid tag

{ "message": "tag is required" }

Tag too long

{ "message": "tag exceeds maximum length of 320 characters" }

Order not found (wrong `uuid`, or it doesn't belong to `organization_id`)

{ "message": "Payment record not found" }

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

curl --location --request PATCH 'https://server.scaledmail.com/api/v1/orders//tag?organization_id=undefined' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: text/plain' \ --data ''

🔑 Authentication#

🔑 Path Parameters#

uuid (required)#

🔑 Query Parameters#

organization_id (required)#

🔑 Request Body Parameters#

tag (required)#

📋 Example Request#

✅ Response#

⚠️ Error Responses#

Missing or invalid tag#

Tag too long#

Order not found (wrong uuid, or it doesn't belong to organization_id)#

Request

Responses