Skip to main content
PATCH
/
api
/
v1
/
shared
/
ships
/
{ship_id}
Update Ship
curl --request PATCH \
  --url https://api.example.com/api/v1/shared/ships/{ship_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "imoNumber": "<string>",
  "mmsiNumber": "<string>",
  "callSign": "<string>",
  "flagName": "<string>",
  "portOfRegistry": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "imoNumber": "<string>",
  "mmsiNumber": "<string>",
  "callSign": "<string>",
  "flagName": "<string>",
  "portOfRegistry": "<string>",
  "crewCount": 0
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
ship_id
string<uuid>
required

Body

application/json

Data for updating a ship. All fields are optional for partial updates.

​
name
string | null
​
imoNumber
string | null
​
mmsiNumber
string | null
​
callSign
string | null
​
flagName
string | null
​
portOfRegistry
string | null

Response

Successful Response

Ship with enriched data for API responses (includes crew_count).

​
id
string<uuid>
required
​
name
string
required
​
createdAt
string<date-time>
required
​
imoNumber
string | null
​
mmsiNumber
string | null
​
callSign
string | null
​
flagName
string | null
​
portOfRegistry
string | null
​
crewCount
integer
default:0