Account Labels

List of valid attributes:

Attribute	Description	Specifics
account_id	ID of the account the label belongs to	Cannot be set
archived_at	Timestamp when the label was archived	Cannot be set
description	Description of the label	Optional
discarded_at	Null or timestamp of removal	Cannot be set
name	Name of the label	Must be set, Length 1-50 characters, Must be unique within account

Meta data: Permissions

Group	Description
actions	Contains permissions to edit or delete an account label

Create

Example request:

{
  "data": {
    "type": "account_label",
    "attributes": {
      "name": "Priority",
      "description": "High-priority items"
    }
  }
}

Example response:

{
  "data": {
    "id": "a6e9e2g8-5p4e-4r4b-8c7e-6a5b85h3c2b1a",
    "type": "account_label",
    "attributes": {
      "account_id": "c2c3a4c9-5a9e-4ad8-9b7b-9a7d6c5b2e1f",
      "archived_at": null,
      "description": "High-priority items",
      "discarded_at": null,
      "name": "Priority"
    }
  }
}

This endpoint creates a new account label.

HTTP Request

POST /api/v1/account_labels

List

Example response:

{
  "data": [
    {
      "id": "6d3c5c2a-b4e9-41d0-a4c8-3327f9012abc",
      "type": "account_label",
      "attributes": {
        "account_id": "c2c3a4c9-5a9e-4ad8-9b7b-9a7d6c5b2e1f",
        "archived_at": null,
        "description": "High-priority items",
        "discarded_at": null,
        "name": "Priority"
      }
    },
    {
      ...
    }
  ]
}

This endpoint returns all account labels of the current user’s account.

HTTP Request

GET /api/v1/account_labels

Update

Example request:

{
  "data": {
    "type": "account_label",
    "attributes": {
      "name": "Priority",
      "description": "High-priority items",
      "archived": true
    }
  }
}

Example response:

{
  "data": {
    "id": "a6e9e2g8-5p4e-4r4b-8c7e-6a5b85h3c2b1a",
    "type": "account_label",
    "attributes": {
      "account_id": "c2c3a4c9-5a9e-4ad8-9b7b-9a7d6c5b2e1f",
      "archived_at": "2026-06-23T10:00:00.000Z",
      "description": "High-priority items",
      "discarded_at": null,
      "name": "Priority"
    }
  }
}

This endpoint updates an account label. Pass archived as a boolean to archive or unarchive a label. When archived is true, archived_at is set to the current time (only if not already archived). When archived is false, archived_at is cleared.

HTTP Request

PUT /api/v1/account_labels/:account_label_id

URL Parameters

Parameter	Description
account_label_id	The ID of the account label to update