Skip to main content
PUT
/
api
/
rest
/
carriers
Update One Carrier By Source System Id
curl --request PUT \
  --url https://api.upwell.com/api/rest/carriers \
  --header 'Content-Type: application/json' \
  --data '
{
  "input": {
    "addressId": "<string>",
    "addressesLastUpdatedAt": "2023-11-07T05:31:56Z",
    "aljexId": "<string>",
    "billingAddressId": "<string>",
    "cargoInsuranceExpireDate": "<string>",
    "dotNumber": "<string>",
    "email": "<string>",
    "generalLiabilityInsuranceExpireDate": "<string>",
    "isCompanyDriver": true,
    "isQuickpay": true,
    "liabilityInsuranceExpireDate": "<string>",
    "mcNumber": "<string>",
    "name": "<string>",
    "phone": "<string>",
    "scacNumber": "<string>",
    "shipmentId": "<string>",
    "sourceSystem": "<string>",
    "sourceSystemId": "<string>"
  },
  "sourceSystem": "<string>",
  "sourceSystemId": "<string>"
}
'
{
  "updateCarrier": {
    "affectedRows": 123,
    "returning": [
      {
        "addressId": "<string>",
        "billingAddressId": "<string>",
        "cargoInsuranceExpireDate": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "dotNumber": "<string>",
        "email": "<string>",
        "generalLiabilityInsuranceExpireDate": "<string>",
        "id": "<string>",
        "liabilityInsuranceExpireDate": "<string>",
        "mcNumber": "<string>",
        "name": "<string>",
        "phone": "<string>",
        "scacNumber": "<string>",
        "shipmentId": "<string>",
        "sourceSystem": "<string>",
        "sourceSystemId": "<string>",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    ]
  }
}

Headers

​
authorization
string

Your API key will be used for authentication of the request. Authorization: YOUR_API_KEY

Query Parameters

​
sourceSystem
string

"sourceSystem" is required (enter it either in parameters or request body)

​
sourceSystemId
string

"sourceSystemId" is required (enter it either in parameters or request body)

Body

application/json

Query parameters can also be provided in the request body as a JSON object

​
input
CarriersSetInput · object

input type for updating data in table "carriers"

​
sourceSystem
string
​
sourceSystemId
string

Response

200 - application/json

Responses for PUT /api/rest/carriers

​
updateCarrier
CarriersMutationResponse · object

response of any mutation on the table "carriers"