Sign in
freight

Update freight provider account credentials

Changed on

Replace the credentials stored for a freight provider account — the mechanism for rotating a client secret without disconnecting.

The new credentials are verified against the provider before they replace the stored pair, so a failed verification leaves the existing connection working. The connection's nickname and account number are untouched.

put/v1/freight/provider_accounts/{freight_provider_account_id}/credentials

Request

  • Base URL: https://api.shipengine.com
  • URL: https://api.shipengine.com/v1/freight/provider_accounts/{freight_provider_account_id}/credentials
  • Auth: API key in header API-Key

Request body

client_idstring required

The new OAuth client ID issued by the freight provider.

client_secretstring required

The new OAuth client secret issued by the freight provider.

Example request

{
  "client_id": "my-new-client-id",
  "client_secret": "my-new-client-secret"
}

Response

The credentials were replaced successfully.

freight_provider_account_idstring

A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.

freight_provider_codestring

The code of the freight provider, such as UNISHIPPERS or WWEX. This is the same value returned as freight_provider_code on quotes, shipments, and tracking.

nicknamestring nullable

The name given to the connection when it was set up, or null when it has none.

Example response

{
  "freight_provider_account_id": "se-28529731",
  "freight_provider_code": "UNISHIPPERS",
  "nickname": "Unishippers - Midwest"
}

Changes

  • 020f57d6f5b8Revision changes
    • ▲

      the / response's property type changed from no type to object for status

    • ▲

      the / response's property type changed from no type to object for status

    • ▲

      the / response's property type changed from no type to object for status

    • ○

      added the optional property // to the response with the status

    • ○

      added the optional property // to the response with the status

    • ○

      added the optional property // to the response with the status

    • ○

      added the optional property // to the response with the status

    • ○

      added the optional property // to the response with the status

    • ○

      added the optional property // to the response with the status

    • ○

      added the optional property // to the response with the status

    • ○

      added the optional property // to the response with the status

    • ○

      added the optional property // to the response with the status

    • ○

      removed from the / response property allOf list for the response status

    • ○

      removed from the / response property allOf list for the response status

    • ○

      removed from the / response property allOf list for the response status

    • ○

      added the required property // to the response with the status

    • ○

      added the required property // to the response with the status

    • ○

      added the required property // to the response with the status

    • ○

      added the required property // to the response with the status

    • ○

      added the required property // to the response with the status

    • ○

      added the required property // to the response with the status

    • ○

      added the required property // to the response with the status

    • ○

      added the required property // to the response with the status

    • ○

      added the required property // to the response with the status

    • ○

      added the required property // to the response with the status

    • ○

      added the required property // to the response with the status

    • ○

      added the required property // to the response with the status

  • 3fdd35fbad5cRevision changes
    • ○

      endpoint added