Menú

Referencia de la API · Envíos

Etiquetas

deliveries · labels · 4 operaciones

GET/v1/deliveries/labels

List delivery labels

deliveries.labels.list

LecturaIdempotenteDesde 2026-11-01

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.

Alcance
deliveries:read
Permiso
Ver el módulo
Tool del MCP
deliveries_labels_listEn la superficie completa; en la compacta, mb_execute_operation con id: "deliveries.labels.list".

Costo declarado: hasta 202 lecturas y 0 escrituras por llamada (cuentan en el cupo diario).

Parámetros

limitintegerqueryopcional

How many labels per page (default 50, at most 200).

Por defecto: 50

cursorstringqueryopcional

The next_cursor of the previous page, to get the next one; omit it for the first page.

Respuesta

dataarray<object>
has_moreboolean
next_cursorstring

Errores

Ejemplo

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

Probar con tu API key de prueba

Con una API key de prueba el pedido va siempre a tu organización de práctica: datos de ejemplo que puedes reiniciar.

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

Create a delivery label

deliveries.labels.create

EscrituraDesde 2026-11-01

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.

Alcance
deliveries:write
Permiso
Editar en el módulo
Tool del MCP
deliveries_labels_createEn la superficie completa; en la compacta, mb_execute_operation con id: "deliveries.labels.create".

Costo declarado: hasta 1 lecturas y 1 escrituras por llamada (cuentan en el cupo diario).

Parámetros

namestringcuerporequerido

Label name (1–60 characters).

colorstringcuerporequerido

Hex color, e.g. #3b82f6.

Respuesta

label_idstring

The new label id.

labelobject

The label as saved.

Errores

Ejemplo

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"
}'

Probar con tu API key de prueba

Con una API key de prueba el pedido va siempre a tu organización de práctica: datos de ejemplo que puedes reiniciar.

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"
}'
PATCH/v1/deliveries/labels/{label_id}

Update a delivery label

deliveries.labels.update

EscrituraIdempotenteDesde 2026-11-01

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.

Alcance
deliveries:write
Permiso
Editar en el módulo
Tool del MCP
deliveries_labels_updateEn la superficie completa; en la compacta, mb_execute_operation con id: "deliveries.labels.update".

Costo declarado: hasta 1 lecturas y 1 escrituras por llamada (cuentan en el cupo diario).

Parámetros

label_idstringrutarequerido

The delivery label id (deliveries.labels.list).

updatesobjectcuerporequerido

The fields to change.

Respuesta

labelobject

The label as saved.

Errores

Ejemplo

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": {}
}'

Probar con tu API key de prueba

Con una API key de prueba el pedido va siempre a tu organización de práctica: datos de ejemplo que puedes reiniciar.

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/v1/deliveries/labels/{label_id}

Delete a delivery label

deliveries.labels.delete

IrreversibleDesde 2026-11-01

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.

Con una API key, este DELETE se ejecuta directo: el registro queda 30 días en la papelera y la respuesta trae su trash_item_id. Con un token OAuth, y por el MCP, pide dry_run → confirm_token.

Alcance
deliveries:write y «Permitir eliminar» (deliveries:delete en OAuth)
Permiso
Editar en el módulo
Tool del MCP
deliveries_labels_deleteEn la superficie completa; en la compacta, mb_execute_operation con id: "deliveries.labels.delete".

Costo declarado: hasta 1001 lecturas y 1001 escrituras por llamada (cuentan en el cupo diario).

Parámetros

label_idstringrutarequerido

The delivery label id (deliveries.labels.list).

Respuesta

oktrue

Always true.

deliveries_updatednumber

How many deliveries it was removed from.

trash_item_idstring

The trash item this deletion left: the item_id of platform.trash.restore (POST /trash/{item_id}/restore). Missing if nothing went to the trash.

trash_item_idsarray<string>

Only when the deletion left more than one copy: all of them, the first being trash_item_id.

trash_expires_atnumber

When the copy leaves the trash for good (epoch ms): 30 days after the deletion.

Errores

Ejemplo

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

Probar con tu API key de prueba

Con una API key de prueba el pedido va siempre a tu organización de práctica: datos de ejemplo que puedes reiniciar.

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