Skip to main content
PUT
/
{recordType}
/
{recordId}
/
tags
Replace all tags on a record
curl --request PUT \
  --url https://{companyName}.api.joinluminous.com/external/api/v1/{recordType}/{recordId}/tags \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "tags": [
    "<string>"
  ]
}
'
{
  "message": "Tags replaced successfully",
  "tags": [
    {
      "id": 123,
      "name": "<string>",
      "description": "<string>",
      "icon": "<string>",
      "color": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Authenticate using a bearer token. To obtain a token, contact [email protected]

Path Parameters

recordType
enum<string>
required

Type of record to replace tags on

Available options:
sales-orders,
sales-order-items,
invoices,
products
recordId
integer
required

ID of the record

Body

application/json
tags
string[]
required

New set of tags to replace existing ones with

Response

Tags replaced successfully

message
string
Example:

"Tags replaced successfully"

tags
object[]