Tags

Last updated on Feb 05, 2025

List tags

Method: GET

URLhttps://app.allpost.co/in/api/<workspaceUuid>/tags

AuthorizationBearer <token>

Response: 200

{
  "data": [
    {
      "id": 3,
      "uuid": "a09367a5-dfc1-43d7-9557-70eb93e01e01",
      "name": "news",
      "hex_color": "#38bdf8"
    },
    {
      "id": 2,
      "uuid": "f9288040-0d50-4e40-83d6-10ef6dd31d9d",
      "name": "release",
      "hex_color": "#111827"
    },
    {
      "id": 1,
      "uuid": "2323e1eb-b3a6-4183-990d-4d5afea04835",
      "name": "motivation",
      "hex_color": "#60a5fa"
    }
  ]
}

Response: 401

{
  "message": "Unauthenticated."
}

Response: 403

{
  "message": "Access forbidden."
}

Response: 404

{
  "message": "Workspace not found."
}

Get a tag

Method: GET

URLhttps://app.allpost.co/in/api/<workspaceUuid>/tags/<tagUuid>

AuthorizationBearer <token>

Response: 200

{
  "id": 1,
  "uuid": "2323e1eb-b3a6-4183-990d-4d5afea04835",
  "name": "motivation",
  "hex_color": "#60a5fa"
}

Response: 401

{
  "message": "Unauthenticated."
}

Response: 403

{
  "message": "Access forbidden."
}

Response: 404

{
  "message": "Workspace not found."
}
{
  "message": "Tag not found."
}

Create a tag

Method: POST

URLhttps://example.com/<MIXPOST_CORE_PATH>/api/<workspaceUuid>/tags

AuthorizationBearer <token>

Body:

{
  "name": "motivation",
  "hex_color": "#60a5fa"
}

Key: name

Format: string

Required: required


Key: hex_color

Format: string

Required: required

Description: HEX color

Response: 200

{
  "id": 3,
  "uuid": "6059e1b3-e102-4be5-951b-82698abd9ee3",
  "name": "Motivation",
  "hex_color": "#000000"
}

Response: 401

{
  "message": "Unauthenticated."
}

Response: 403

{
  "message": "Access forbidden."
}

Response: 404

{
  "message": "Workspace not found."
}

Response: 422

{
  "message": "Validation errors",
  "errors": {}
}

Update a tag

Method: PUT

URLhttps://app.allpost.co/in/api/<workspaceUuid>/tags/{tagUuid}

AuthorizationBearer <token>

Body:

{
  "name": "motivation",
  "hex_color": "#60a5fa"
}

Key: name

Format: string

Required: required


Key: hex_color

Format: string

Required: required

Description: HEX color

Response: 200

{
  "success": true,
}

Response: 401

{
  "message": "Unauthenticated."
}

Response: 403

{
  "message": "Access forbidden."
}

Response: 404

{
  "message": "Workspace not found."
}
{
  "message": "Tag not found."
}

Response: 422

{
  "message": "Validation errors",
  "errors": {}
}

Delete a tag

Method: DELETE

URLhttps://app.allpost.co/in/api/<workspaceUuid>/tags/{tagUuid}

AuthorizationBearer <token>

Response: 200

{
  "success": true
}
{
  "success": false
}

Response: 401

{
  "message": "Unauthenticated."
}

Response: 403

{
  "message": "Access forbidden."
}

Response: 404

{
  "message": "Workspace not found."
}