Assign a berth

PUT /berths/{berthId}/assign

Authorization

bearerAuth Authorization: Bearer <token>

Any token will do here. Without one the answer is a 401.

Path parameters

berthId* string

The berth, as painted on the quay.

Example B7

Request body

application/json

By ship

shipId* integer

until? string

Format date-time

Reserved

reason* string

Responses

200 The berth and what holds it. application/json

berth? string

shipId? integer | null

reason? string | null

until? string | null

Format date-time

422 Neither a ship nor a reason was given. application/json

message* string

errors? object

Request

curl -X PUT 'https://vellum.jimmyverburgt.com/harbor/v2/berths/{berthId}/assign' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
    "shipId": 0,
    "until": "2026-01-31T09:00:00Z"
}'

$response = Http::withToken('<token>')->put('https://vellum.jimmyverburgt.com/harbor/v2/berths/{berthId}/assign', [
        'shipId' => 0,
        'until' => '2026-01-31T09:00:00Z',
    ]);

const response = await fetch('https://vellum.jimmyverburgt.com/harbor/v2/berths/{berthId}/assign', {
  method: 'PUT',
  headers: {
    'Authorization': 'Bearer <token>',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "shipId": 0,
      "until": "2026-01-31T09:00:00Z"
  })
})

Response

{
    "berth": "B7",
    "shipId": 1,
    "reason": "string",
    "until": "2026-01-31T09:00:00Z"
}

{
    "message": "The name field is required.",
    "errors": []
}