Labels

List delivery labels

deliveries.labels.list

Lists the organization's delivery labels in the order the screen shows them (order), paginated by cursor (limit 50 by default, up to 200): id, name, hex color, and who created it (created_by_id with created_by_name). Put their ids in label_ids of deliveries.deliveries.create or update, and filter deliveries.deliveries.list by label_id. Requires view access to Deliveries.

Scope

deliveries:read

Permission

View the module

MCP tool

deliveries_labels_listOn the full surface; on the compact one, mb_execute_operation with id: "deliveries.labels.list".

Declared cost: up to 202 reads and 0 writes per call (they count against the daily quota).

Parameters

Response

Errors

Example

curl "https://api.mb-suite.com/v1/deliveries/labels" \
  -H "Authorization: Bearer $MB_API_KEY"

Try it with your test API key

With a test API key the request always goes to your practice organization: example data you can reset.

curl "https://api.mb-suite.com/v1/deliveries/labels" \
  -H "Authorization: Bearer $MB_TEST_KEY"

Create a delivery label

deliveries.labels.create

Creates a delivery label with a name (up to 60 characters) and a hex color (#RRGGBB), placed last in the order. Returns the new label_id and the label. Requires edit access to Deliveries.

Scope

deliveries:write

Permission

Edit in the module

MCP tool

deliveries_labels_createOn the full surface; on the compact one, mb_execute_operation with id: "deliveries.labels.create".

Declared cost: up to 1 reads and 1 writes per call (they count against the daily quota).

Parameters

Response

Errors

Example

curl -X POST "https://api.mb-suite.com/v1/deliveries/labels" \
  -H "Authorization: Bearer $MB_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "name": "NAME",
  "color": "COLOR"
}'

Try it with your test API key

With a test API key the request always goes to your practice organization: example data you can reset.

curl -X POST "https://api.mb-suite.com/v1/deliveries/labels" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "name": "NAME",
  "color": "COLOR"
}'

Update a delivery label

deliveries.labels.update

Renames, recolors or moves a delivery label (updates object: name, color, order). Only what is sent changes; deliveries keep it. Idempotent. Returns the label. Requires edit access to Deliveries.

Scope

deliveries:write

Permission

Edit in the module

MCP tool

deliveries_labels_updateOn the full surface; on the compact one, mb_execute_operation with id: "deliveries.labels.update".

Declared cost: up to 1 reads and 1 writes per call (they count against the daily quota).

Parameters

Response

Errors

Example

curl -X PATCH "https://api.mb-suite.com/v1/deliveries/labels/{label_id}" \
  -H "Authorization: Bearer $MB_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "updates": {}
}'

Try it with your test API key

With a test API key the request always goes to your practice organization: example data you can reset.

curl -X PATCH "https://api.mb-suite.com/v1/deliveries/labels/{label_id}" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "updates": {}
}'

Delete a delivery label

deliveries.labels.delete

Deletes a delivery label and removes it from every delivery that had it (deliveries_updated says how many). The label goes to the 30-day trash and owners and admins can restore it; restoring puts it back on those deliveries (the ones deleted meanwhile are skipped; the trash keeps up to 5,000 of them, and with more the trash item says linked_truncated). Outside the screen it needs a dry run (it names the label and counts the deliveries that have it) and a confirm_token, or a simple DELETE with a key that may delete. Requires edit access to Deliveries.

With an API key, this DELETE runs directly: the record stays 30 days in the trash and the response carries its trash_item_id. With an OAuth token, and through the MCP, it needs dry_run → confirm_token.

Scope

deliveries:write and “Allow deletions” (deliveries:delete in OAuth)

Permission

Edit in the module

MCP tool

deliveries_labels_deleteOn the full surface; on the compact one, mb_execute_operation with id: "deliveries.labels.delete".

Declared cost: up to 1001 reads and 1001 writes per call (they count against the daily quota).

Parameters

Response

Errors

Example

curl -X DELETE "https://api.mb-suite.com/v1/deliveries/labels/{label_id}" \
  -H "Authorization: Bearer $MB_API_KEY"

Try it with your test API key

With a test API key the request always goes to your practice organization: example data you can reset.

curl -X DELETE "https://api.mb-suite.com/v1/deliveries/labels/{label_id}" \
  -H "Authorization: Bearer $MB_TEST_KEY"