# Assign or unassign a team member on a shipment

```http
PUT https://secure.yoprint.com/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/shipment/{id}/assign
```

- API version: v2
- Operation ID: `v2_public_sales_order_shipment_assign`
- Section: Shipping › [Shipments](https://developer.yoprint.com/reference/shipments.md)
- Web page: https://developer.yoprint.com/reference/shipments/v2-sales-order-shipment-assign/
- Authentication: `Authorization: Bearer YOUR_API_KEY`

Adds a team member to a shipment's assignees with `action: "assign"`, or removes them with `action: "unassign"`. The answer is the shipment's assignees. `{hash_id}` is the order's `id`; `{id}` is the shipment's `id`.

## Permission

Any member of the team.

## Side effects

- Customer Portal pages the order's customer has open refresh (a live update, not an email).

## Path parameters

- `team_slug` (string, required): Your team slug, shown as Team ID next to your API key in Profile. Example `your-team`.
- `hash_id` (string, required): The sales order's or quote's `id` (a hash id). The `ord_` unique key and the order number do not work here. Example `V4keXwwxMQyXw7`.
- `id` (string, required): The shipment's `id` (a hash id). Example `qAKg4jO63uFqjs`.

## Request body

Content type `application/json`, required.

Fields:

- `action` (string, required): One of: `"assign"`, `"unassign"`.
- `user_id` (string, required): A team member's `id`.

### Example request

```bash
curl -X PUT 'https://secure.yoprint.com/v2/api/store/your-team/v2/sales_order/V4keXwwxMQyXw7/shipment/qAKg4jO63uFqjs/assign' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'X-Yoprint-Decimal-Format: exact-v1' \
  -H 'Content-Type: application/json' \
  -d '{
    "action": "assign",
    "user_id": "PydH0WtBhSeiNU"
  }'
```

## Response

`200` Successful response.

Fields:

- `data` (array of objects, required): The shipment's assignees.
  - Each item:
    - `avatar_url` (string | null, optional)
    - `email` (string, optional)
    - `id` (string, optional)
    - `name` (string, optional)
    - `timezone` (string | null, optional): IANA time zone, for example `America/Chicago`.
- `status` (integer, required)
- `success` (boolean, required)

Example response:

```json
{
  "data": [
    {
      "avatar_url": null,
      "email": "alex@example.com",
      "id": "PydH0WtBhSeiNU",
      "name": "Alex Rivera",
      "timezone": "America/Chicago"
    }
  ],
  "status": 200,
  "success": true
}
```

## Errors

- `401` The API key is missing or wrong (`unauthenticated`).
- `403` You are not allowed to do this. `api_access_not_in_plan`: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only `{"message": "Insufficient Permission"}`. Other refusals use the error envelope, with `unauthorized` or `user_is_not_authorized`.
- `404` Not found. `page_not_found`: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. `code: null`, with a message that starts "No query results for": there is no record with that id.
  - When: The user is not a team member, or the shipment is not on this order. Fix: Check both ids.
- `422` The request was refused and changed nothing. `validation_failed` lists what to fix in `error.fields`; other codes name a business rule, explained in `error.message`. A few checks answer with only `{"message": "..."}`. An operation that calls another service (a payment provider, a carrier, an accounting app) can answer `connect_timeout` ("Please retry again") when that service does not answer in time: the change may or may not have happened there, so read the record back before you retry.
  - When: `action` or `user_id` is missing, `action` is not `assign` or `unassign`, or `user_id` is not a valid id (`validation_failed`). Fix: Send both fields.

## Related

- [List the shipments of a sales order](https://developer.yoprint.com/reference/shipments/v2-sales-order-shipment-index-for-order.md): `GET /v2/api/store/{team_slug}/v2/sales_order/{unique_key}/shipment`