Skip to content

Tags

APIs to create, update, and remove tags for single or multiple orders.

Update Tags for an Order

Request

This operation is used to create, update or remove tags associated with a specific order.

  • To create or update tags, provide one or more values in tagIds array.
  • To remove previously assigned tags, provide an empty array for tagIds ([]).
Security
bearerAuth
Path
orderIdstringrequired

The orderId for the Order that needs to be updated.

Bodyapplication/jsonrequired
tagIdsArray of stringsrequired

List of tag identifiers to update for the Order.

Example:
[ "Urgent" ]
curl -i -X PUT \
  'https://api-sandbox.sendpro360.pitneybowes.com/ordermanagement/api/v1/orders/{orderId}/tags' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "tagIds": [
      "Urgent"
    ]
  }'

Responses

The specified tag has been updated with the order.

Response
No content