Skip to main content
PUT
/
orgs
/
{orgId}
/
carriers
/
{carrierId}
Updates an existing carrier
curl --request PUT \
  --url https://api.zippendo.com/orgs/{orgId}/carriers/{carrierId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "carrierSlug": "<string>",
  "config": {},
  "senderAddressId": "<string>"
}
'
{
  "id": "<string>",
  "name": "<string>",
  "carrierSlug": "<string>",
  "config": {},
  "senderAddressId": "<string>",
  "orgId": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "senderAddress": {
    "id": "<string>",
    "name": "<string>",
    "attContact": "<string>",
    "address1": "<string>",
    "address2": "<string>",
    "zipcode": "<string>",
    "city": "<string>",
    "phone": "<string>",
    "countryCode": "<string>",
    "state": "<string>",
    "email": "jsmith@example.com",
    "orgId": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "customs": {}
  }
}

Authorizations

Authorization
string
header
required

JWT access token or API token (prefixed with zipp_)

Path Parameters

orgId
string
required

Organization ID

carrierId
string
required

Carrier ID

Body

application/json
name
string

Carrier name

Minimum string length: 1
carrierSlug
string

Carrier slug identifier

Minimum string length: 1
config
object

Carrier configuration JSON

senderAddressId
string

Sender address ID

Response

Default Response

id
string
required
name
string
required

Carrier name

carrierSlug
string
required

Carrier slug identifier

config
object
required

Carrier configuration (required and optional fields)

senderAddressId
string
required

Associated sender address ID

orgId
string
required
createdAt
string
required
updatedAt
string
required
senderAddress
object
required