Update MD by SH ID

PreviousCreate MD by SH ID NextDocuments [api]

Last updated 5 months ago

Update shipment metadata request by prototype id.

patch

/galaxy/shipments/{id}/metadata/{prototype_id}

Authorizations

Path parameters

idintegerrequired

Shipment identifier.

prototype_idintegerrequired

Metadata prototype identifier.

Header parameters

X-Account-IDinteger

Account identifier

Body

valuestringrequired

Metadata request value.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://api.shiptify.com/galaxy/shipments/{id}/metadata/{prototype_id}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "value": "text"
  }'

200

400

401

404

500

{
  "successful": true
}