Skip to main content
Create single contact
curl --request POST \
  --url https://api.splose.com/v1/contacts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "Standard",
  "name": "Plan Manager",
  "title": "Mr.",
  "firstName": "Harry",
  "lastName": "Potter",
  "preferredName": "Harry",
  "profession": "Contractor",
  "companyName": "splose",
  "providerNumber": "12345678",
  "doctorType": "GP",
  "email": "harry@hogwarts.edu",
  "addressL1": "123 King William Street",
  "addressL2": "",
  "addressL3": "",
  "suburb": "Adelaide",
  "state": "SA",
  "postalCode": "5000",
  "country": "Australia",
  "phoneNumbers": [
    {
      "type": "Mobile",
      "code": "+61",
      "phoneNumber": "401234567"
    }
  ]
}'
{
  "id": 1,
  "type": "Standard",
  "name": "Plan Manager",
  "title": "Mr.",
  "firstName": "Harry",
  "lastName": "Potter",
  "preferredName": "Harry",
  "profession": "Contractor",
  "companyName": "splose",
  "providerNumber": "12345678",
  "doctorType": "GP",
  "associatedPatientIds": [
    123
  ],
  "associatedInvoiceIds": [
    123
  ],
  "associatedCaseIds": [
    123
  ],
  "email": "harry@hogwarts.edu",
  "addressL1": "123 King William Street",
  "addressL2": "",
  "addressL3": "",
  "suburb": "Adelaide",
  "state": "SA",
  "postalCode": "5000",
  "country": "Australia",
  "phoneNumbers": [
    {
      "type": "Mobile",
      "code": "+61",
      "phoneNumber": "401234567"
    }
  ],
  "archived": false,
  "createdAt": "2023-07-30T09:00:00.000Z",
  "updatedAt": "2023-07-30T09:00:00.000Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
type
string
required

Contact type

Example:

"Standard"

​
name
string
required

Contact name

Example:

"Plan Manager"

​
email
string<email>
required

Contact email

Example:

"harry@hogwarts.edu"

​
title
string | null

Contact title

Example:

"Mr."

​
firstName
string | null

Contact first name

Example:

"Harry"

​
lastName
string | null

Contact last name

Example:

"Potter"

​
preferredName
string | null

Contact preferred name

Example:

"Harry"

​
profession
string | null

Contact profession

Example:

"Contractor"

​
companyName
string | null

Contact company name

Example:

"splose"

​
providerNumber
string | null

Contact provider number

Example:

"12345678"

​
doctorType
enum<string> | null

Contact doctor type

Available options:
GP,
Specialist
Example:

"GP"

​
addressL1
string | null

Contact address line 1

Example:

"123 King William Street"

​
addressL2
string | null

Contact address line 2

Example:

""

​
addressL3
string | null

Contact address line 3

Example:

""

​
suburb
string | null

Contact city

Example:

"Adelaide"

​
state
string | null

Contact state

Example:

"SA"

​
postalCode
string | null

Contact post code

Example:

"5000"

​
country
string | null
default:Australia

Contact country

Example:

"Australia"

​
phoneNumbers
object[]

Response

Successfully created contact

​
id
integer
required

Contact id

Required range: x > 0
Example:

1

​
type
string | null
required

Contact type

Example:

"Standard"

​
name
string | null
required

Contact name

Example:

"Plan Manager"

​
title
string | null
required

Contact title

Example:

"Mr."

​
firstName
string | null
required

Contact first name

Example:

"Harry"

​
lastName
string | null
required

Contact last name

Example:

"Potter"

​
preferredName
string | null
required

Contact preferred name

Example:

"Harry"

​
profession
string | null
required

Contact profession

Example:

"Contractor"

​
companyName
string | null
required

Contact company name

Example:

"splose"

​
providerNumber
string | null
required

Contact provider number

Example:

"12345678"

​
doctorType
enum<string> | null
required

Contact doctor type

Available options:
GP,
Specialist
Example:

"GP"

​
associatedPatientIds
number[] | null
required

The associated patients' id in this contact

​
associatedInvoiceIds
number[] | null
required

The associated invoices' id in this contact

​
associatedCaseIds
number[] | null
required

The associated invoices' id in this contact

​
email
string | null
required

Contact email

Example:

"harry@hogwarts.edu"

​
addressL1
string | null
required

Contact address line 1

Example:

"123 King William Street"

​
addressL2
string | null
required

Contact address line 2

Example:

""

​
addressL3
string | null
required

Contact address line 3

Example:

""

​
suburb
string | null
required

Contact city

Example:

"Adelaide"

​
state
string | null
required

Contact state

Example:

"SA"

​
postalCode
string | null
required

Contact post code

Example:

"5000"

​
country
string | null
required

Contact country

Example:

"Australia"

​
phoneNumbers
object[]
​
archived
boolean | null
default:false

Whether the contact has been archived

​
createdAt

Object creation date time

Example:

"2023-07-30T09:00:00.000Z"

​
updatedAt

Object update date time

Example:

"2023-07-30T09:00:00.000Z"