Tags

Organize contacts with tags.

GET/api/v1/tags

Get all tags for the authenticated client. Cursor-paginated (per_page default 25, max 100; cursor for next/previous page).

Response Fields

idinteger

The tag ID.

uuidstring

The tag UUID.

namestring

The tag name.

created_atstring

ISO 8601 creation timestamp.

metaobject

Cursor pagination metadata (path, per_page, next_cursor, prev_cursor).

Request

curl -X GET \
  "https://byomailer.com/api/v1/tags" \
  -H "Authorization: Bearer {your-api-token}" \
  -H "Accept: application/json"

Response

200

{
  "data": [
    {
      "id": 1,
      "uuid": "tag-uuid-1",
      "name": "newsletter",
      "created_at": "2024-01-15T10:30:00.000000Z"
    },
    {
      "id": 2,
      "uuid": "tag-uuid-2",
      "name": "customer",
      "created_at": "2024-01-14T09:00:00.000000Z"
    }
  ],
  "meta": {
    "path": "https://byomailer.com/api/v1/tags",
    "per_page": 25,
    "next_cursor": null,
    "prev_cursor": null
  }
}

POST/api/v1/tags

Create a new tag.

Body Parameters

namestring

required

The name of the tag. Must be unique.

Response Fields

idinteger

The tag ID.

uuidstring

The tag UUID.

namestring

The tag name.

created_atstring

ISO 8601 creation timestamp.

Request

curl -X POST \
  "https://byomailer.com/api/v1/tags" \
  -H "Authorization: Bearer {your-api-token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "premium"
}'

Response

201

{
  "data": {
    "id": 3,
    "uuid": "tag-uuid-3",
    "name": "premium",
    "created_at": "2024-01-16T11:00:00.000000Z"
  }
}

PATCH/api/v1/tags/{tagId}

Update an existing tag.

Path Parameters

tagIdinteger

required

The ID of the tag to update.

Body Parameters

namestring

required

The new name for the tag. Must be unique.

Response Fields

idinteger

The tag ID.

uuidstring

The tag UUID.

namestring

The updated tag name.

created_atstring

ISO 8601 creation timestamp.

Request

curl -X PATCH \
  "https://byomailer.com/api/v1/tags/{tagId}" \
  -H "Authorization: Bearer {your-api-token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "premium-user"
}'

Response

200

{
  "data": {
    "id": 3,
    "uuid": "tag-uuid-3",
    "name": "premium-user",
    "created_at": "2024-01-16T11:00:00.000000Z"
  }
}

DELETE/api/v1/tags/{tagId}

Delete a tag.

Path Parameters

tagIdinteger

required

The ID of the tag to delete.

Request

curl -X DELETE \
  "https://byomailer.com/api/v1/tags/{tagId}" \
  -H "Authorization: Bearer {your-api-token}" \
  -H "Accept: application/json"

Response

204

No content