Create Contact

POST 
/contacts/

Use this endpoint to create a single contact. If a contact is successfully created, the response will include the user id.

Fields

Name	Required
debtorId (deprecated)	no
firstName	no
middleName	no
lastName	no
fullName	no
title	no
dateOfBirth	no
gender	no
login	no
phone	no
email	no
parent	no
primaryLanguage	no
ssn	no
sourceId	no
source	only when sourceId is provided

Request

application/json

Body

abbreviation string
company 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
primaryLanguage string
source string
sourceId number
title string

Responses

201

Create Contact - 201

Response Headers

• Alt-Svc

  string

• Via

  string

• alt-svc

  string

• content-length

  string

• date

  string

• return-format

  string

• x-request-id

  string

application/json

Schema

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

primaryLanguage string

source string

sourceId number

title string
messages string[]
total number

Example (from schema)

{
  "data": {
    "abbreviation": "MM",
    "dateOfBirth": "28/08/1993",
    "debtorId": 12345,
    "email": "miles@propel.us",
    "firstName": "Miles",
    "gender": "M",
    "id": 25492,
    "language": "NL",
    "lastName": "McCoy",
    "login": "miles@propel.us",
    "middleName": "",
    "mobile": "0038975648",
    "parent": {
      "id": 9482
    },
    "phone": "0032445888",
    "primaryLanguage": "EN",
    "source": "REST-API",
    "sourceId": 3002196,
    "title": "Mr."
  },
  "messages": [
    "Contact created"
  ],
  "total": 1
}

Create Contact - 201

{
  "data": {
    "abbreviation": "MM",
    "dateOfBirth": "28/08/1993",
    "debtorId": 12345,
    "email": "miles@propel.us",
    "firstName": "Miles",
    "gender": "M",
    "id": 25492,
    "language": "NL",
    "lastName": "McCoy",
    "login": "miles@propel.us",
    "middleName": "",
    "mobile": "0038975648",
    "parent": {
      "id": 9482
    },
    "phone": "0032445888",
    "primaryLanguage": "EN",
    "source": "REST-API",
    "sourceId": 3002196,
    "title": "Mr."
  },
  "messages": [
    "Contact created"
  ],
  "total": 1
}

400

Create Contact - 400 (invalid schema)

Response Headers

• Alt-Svc

  string

• Via

  string

• alt-svc

  string

• content-length

  string

• date

  string

• return-format

  string

• x-request-id

  string

application/json

Schema

Schema

error

object

code number

messages string[]

moreInfo string

status number

type string

Example (from schema)

{
  "error": {
    "code": 10007,
    "messages": [
      "#: extraneous key [company] is not permitted"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/10007",
    "status": 400,
    "type": "SchemaValidationException"
  }
}

Create Contact - 400 (invalid schema)

{
  "error": {
    "code": 10007,
    "messages": [
      "#: extraneous key [company] is not permitted"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/10007",
    "status": 400,
    "type": "SchemaValidationException"
  }
}

Loading...