Create User
POST/users/
Use this endpoint to create a single user. If a user is successfully created, the response will include the user id
.
Fields
Name | Required |
---|---|
debtorId | no |
firstName | no |
middleName | no |
lastName | no |
fullName | no |
title | no |
dateOfBirth | no |
gender | no |
login | no |
phone | no |
email | no |
company | no |
parent | no |
taxNumber | no |
cocNumber | no |
primaryLanguage | no |
sourceId | no |
source | only when sourceId is provided |
Request
- application/json
Body
abbreviation string
dateOfBirth string
debtorId number
email string
firstName string
gender string
language string
lastName string
login string
middleName string
mobile string
parent
object
id number
phone string
source string
sourceId number
title string
Responses
- 201
- 400
Create User - 201
Response Headers
Alt-Svc
string
Via
string
alt-svc
string
content-length
string
date
string
return-format
string
server
string
x-request-id
string
- application/json
- Schema
- Example (from schema)
- Create User - 201
Schema
data
object
abbreviation string
dateOfBirth string
debtorId number
email string
firstName string
gender string
id number
language string
lastName string
login string
middleName string
mobile string
parent
object
id number
phone string
source string
sourceId number
title string
messages string[]
total number
{
"data": {
"abbreviation": "MM",
"dateOfBirth": "28/08/1993",
"debtorId": 12345,
"email": "miles@propel.us",
"firstName": "Miles",
"gender": "M",
"id": 14759,
"language": "NL",
"lastName": "McCoy",
"login": "miles@propel.us",
"middleName": "",
"mobile": "0038975648",
"parent": {
"id": 119
},
"phone": "0032445888",
"source": "REST-API",
"sourceId": 3002196,
"title": "Mr."
},
"messages": [
"User created"
],
"total": 1
}
{
"data": {
"abbreviation": "MM",
"dateOfBirth": "28/08/1993",
"debtorId": 12345,
"email": "miles@propel.us",
"firstName": "Miles",
"gender": "M",
"id": 14759,
"language": "NL",
"lastName": "McCoy",
"login": "miles@propel.us",
"middleName": "",
"mobile": "0038975648",
"parent": {
"id": 119
},
"phone": "0032445888",
"source": "REST-API",
"sourceId": 3002196,
"title": "Mr."
},
"messages": [
"User created"
],
"total": 1
}
Create User - 400 (invalid payload)
Response Headers
Alt-Svc
string
Via
string
alt-svc
string
content-length
string
date
string
return-format
string
server
string
x-request-id
string
- application/json
- Schema
- Example (from schema)
- Create User - 400 (invalid payload)
Schema
error
object
code number
messages string[]
moreInfo string
status number
type string
{
"error": {
"code": 10005,
"messages": [
"Invalid JSON Payload"
],
"moreInfo": "https://www.propel.us/docs/errors/10005",
"status": 400,
"type": "InvalidJSONPayload"
}
}
{
"error": {
"code": 10005,
"messages": [
"Invalid JSON Payload"
],
"moreInfo": "https://www.propel.us/docs/errors/10005",
"status": 400,
"type": "InvalidJSONPayload"
}
}
Loading...