Skip to main content
POST
Assign a shipment party role
Attaches a party from your account to the shipment in one role.

Path parameters

Roles

shipper, consignee, notify_party, customs_broker, customer, freight_forwarder, pickup_dray_carrier

Behavior

  • Roles are additive. Posting a second party with the same role keeps both
  • To replace a party, delete its role and create a new one
  • Posting the same party and role twice returns 422
  • The party must belong to your account, otherwise the request returns 401

Authorizations

Authorization
string
header
required

Use a Terminal49 API key in the Authorization header with the Token prefix.

Authorization: Token YOUR_API_KEY

Path Parameters

shipment_id
string
required

Shipment ID

Body

application/json
data
object
required

Response

Created

data
Party role model · object
included
Party model · object[]