# Update a Consignment using a Tracking Reference

**PATCH /workspaces/{workspaceId}/consignments**




## Servers
- The production URL for sending requests to the Reelables API.: https://api.reelables.com/v1 (The production URL for sending requests to the Reelables API.)


## Authentication methods
- Auth endpoint


## Parameters
### Headers
- **request-id** (string)
  Unique identifier for the API request. Example: f7ecf495-ca1c-4468-a6c2-6ee3f723fa00

### Path parameters
- **workspaceId** (string)
  The identifier of the Workspace

### Query parameters
- **trackingRef** (string)
  The tracking reference that identifies the Consignment in the user system

### Body: application/json (object)

- **isActive** (boolean)
  Indicates whether the Consignment is actively being tracked


## Responses
### 200
200 response

#### Body: application/json (object)
- **pieces** (object)
  Pieces in the Consignment
- **trackingRef** (string)
  The tracking reference that identifies the Consignment in the user system
- **gateways** (object)
  Gateways in the Consignment
- **workspace** (object)

- **destination** (object)

- **id** (string(uuid))
  Unique identifier of the Consignment. Example: 'd290f1ee-6c54-4b01-90e6-d701748f0851'
- **isActive** (boolean)
  Indicates whether the Consignment is actively being tracked
- **deactivated** (object)

- **activated** (object)


### 401
Unauthorized

#### Body: application/json (object)
- **errors** (array[object])


### 403
Forbidden

#### Body: application/json (object)
- **errors** (array[object])


### 404
Consignment not found in Workspace

#### Body: application/json (object)
- **errors** (array[object])


### 429
Too Many Requests

#### Body: application/json (object)
- **errors** (array[object])



[Powered by Bump.sh](https://bump.sh)