POST v1/Parcels/{parcelId}/CarrierParameters/{key}

Adds or updates the specified Parcel's Carrier Parameter.

Request Information

URI Parameters

Name	Description	Type	Additional information
parcelId	The id of the Parcel.	integer	Required.
key	The Carrier Parameter key.	string	Required.

Body Parameters

The Carrier Parameter value.

CarrierParameterValue

Name	Description	Type	Additional information
Value	The Carrier Parameter value	string	None.

Request Formats

application/json, text/json

Sample:

{
  "Value": "sample string 1"
}

application/xml, text/xml

Sample:

<CarrierParameterValue xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Value>sample string 1</Value>
</CarrierParameterValue>

Response Information

Resource Description

The HttpResponseMessage object.

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.