Update Custom Carrier Code

This operation Updates the configuration for the specified Custom Carrier Code.
The custom carrier code itself cannot be changed. If provided in the body, it will be ignored.

SecuritybearerAuth
Request
path Parameters
code
required
string

Unique custom carrier code identifier. This value is defined when the custom carrier code is created and cannot be changed.

Request Body schema: application/json
carrier
required
string

Carrier name associated with the custom configuration.

carrierAccountId
required
string

Unique identifier of the carrier account under which shipments will be processed.

parcelType
string

Parcel type (e.g., PKG for package, LTR for letter).

parcelName
string

Human-readable name for the parcel type (optional).

serviceId
string

Identifier of the shipping service to be used.

serviceName
string

Human-readable name of the shipping service (optional).

Array of objects

List of special services applied to the custom carrier code.

Responses
200

Custom carrier code successfully updated.

400

Invalid request.

401

The request could not be authorized.

500

The request could not be completed due to an internal error.

put/api/v1/custom-carrier-codes/{code}
Request samples
application/json
{
  • "carrier": "FEDEX",
  • "carrierAccountId": "xxxxxxxxxxx",
  • "parcelType": "PKG",
  • "parcelName": "Package",
  • "serviceId": "GRD",
  • "serviceName": "Ground",
  • "specialServices": [
    ]
}
Response samples
application/json
{
  • "code": "myups-test2"
}