Share a Shipment with outside parties and get a link to it

SecurityAuthToken

Request

shipmentId

required

string <uuid>

The id of the shipment

external_link	string or null Read-only link to a share Shipment page
include_map	string or null Field to indicate whether the link should also include the map when visiting the external link.
recipient_emails	Array of strings <email> Emails that should receive a link to the Shipment
recipient_phone_number	string or null Optional phone number to text a link to the Shipment

Responses

201

Successfully shared the Shipment to the provided emails

external_link	string or null Read-only link to a share Shipment page
include_map	string or null Field to indicate whether the link should also include the map when visiting the external link.
recipient_emails	Array of strings <email> Emails that should receive a link to the Shipment
recipient_phone_number	string or null Optional phone number to text a link to the Shipment

default

Default error response

post/shipments/{shipmentId}/share/

Request samples

application/json

{"external_link": "string",
"include_map": "string",
"recipient_emails": ["user@example.com"
],
"recipient_phone_number": "string"
}

Response samples

application/json

{"external_link": "string",
"include_map": "string",
"recipient_emails": ["user@example.com"
],
"recipient_phone_number": "string"
}