POST user/adduser

Action will save or 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

AddUserRequest
NameDescriptionTypeAdditional information
FirstName

First Name

string
Required
LastName

Last Name

string
Required
Email

Email

string
Required
Password

Password

string
Required
RoleName

Role Name

string
Required
UserFunction

User Function

UserFunctionType
Required
UserType

UserType

UserType
Optional. If not provided
0 (Standard) will be treated by default
CarrierIds

Carrier Ids. At Least 1 CarrierId should be present

Collection of integer
Required
PackagesIds

Package Ids

Collection of integer
Optional
UserWarehousesIds

User Warehouses Ids

Collection of integer
Optional
DefaultUserWarehousesId

Default User Warehouses Id

integer
Optional
Active

Active. if null then it will be considered as false

boolean
Optional

Request Formats

application/json, text/json

Sample:
{
  "FirstName": "sample string 1",
  "LastName": "sample string 2",
  "Email": "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": 6,
  "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": {}
}