POST user/updateuser

Action will update the user into the FreightPOP.

Pass HTTP Authorization request header with value "Bearer {token}" to perform this action.

EndPoint

Production Url: https://enterprise.freightpop.com/user/saveuser

Sandbox Url: https://sandbox-api.freightpop.com/user/saveuser

Request Information

URI Parameters

None.

Body Parameters

UpdateUserRequest
NameDescriptionTypeAdditional information
Id

string
Required
FirstName

First Name

string
Optional
LastName

Last Name

string
Optional
Password

Password

string
Optional
RoleName

Role Name

string
Optional
UserFunction

User Function

UserFunctionType
Optional
UserType

User Type

UserType
Optional
CarrierIds

Carrier Ids. If present it will replace the existing ones

Collection of integer
Optional
PackagesIds

Package Ids. If present it will replace the existing ones

Collection of integer
Optional
UserWarehousesIds

User Warehouses Ids. If present it will replace the existing ones

Collection of integer
Optional
DefaultUserWarehousesId

Default User Warehouses Id. if UserWarehousesIds are present but previous saved or current DefaultUserWarehousesId Value does not exist in the provided UserWarehousesIds then first one from the UserWarehousesIds will be treated as default.

integer
Optional
Active

Active. if not present then previous saved value will be used

boolean
Optional

Request Formats

application/json, text/json

Sample:
{
  "Id": "sample string 1",
  "FirstName": "sample string 2",
  "LastName": "sample string 3",
  "Password": "sample string 4",
  "RoleName": "sample string 5",
  "UserFunction": 1,
  "UserType": 0,
  "CarrierIds": [
    1,
    2
  ],
  "PackagesIds": [
    1,
    2
  ],
  "UserWarehousesIds": [
    1,
    2
  ],
  "DefaultUserWarehousesId": 1,
  "Active": true
}

Response Information

Resource Description

BadResponse
NameDescriptionTypeAdditional information
Data

Data returned by api

Object

None.

Code

Response code returned by api

HttpStatusCode

None.

Message

Human readable message

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Code": 100,
  "Message": "sample string 2",
  "Data": {}
}