CAcargoai

Update User

Changed on

This endpoint allows you to add offices to any user already created and associated with your API key. Field formats are listed on the Data Format page.

put/users

Request

  • Base URL
    https://api.cargoai.co/solutions
  • URL
    https://api.cargoai.co/solutions/users
  • Auth
    API key in header x-api-key

Headers

x-api-keystring required

Request body

firstNamestring

first name of the user

lastNamestring

last name of the user

emailstring required

user's email address

companyNamestring

user's company name

partnerIdstring

The user's identifier in your own (partner) system.

Response

200

status'Activated' | 'Manual activation' | 'Pending validation' | 'Pending company validation'

account status of the user. Omitted when the status is not one of the listed values.

messagestring

result of the request

tokenstring

authentication token for the CargoMART portal

linkstring

redirection link to the CargoMART portal, including the token

Changes