Skip to main content
POST
/
contact
/
{external_id}
Create or update a contact
curl --request POST \
  --url https://thalamus.nerds.nl/api/v1/contact/{external_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "external_organization_id": "ORG-5001",
  "name": "John Doe",
  "email": "john@example.com",
  "phone": "+31612345678",
  "address": "Keizersgracht 100",
  "zip": "1015 AA",
  "city": "Amsterdam",
  "country": "NL",
  "comment": "<string>",
  "status": "active",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}
'
{
  "success": true,
  "data": {
    "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "external_id": "<string>",
    "name": "<string>",
    "email": "<string>",
    "phone": "<string>",
    "external_organization_id": "<string>",
    "status": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "message": "<string>"
}

Authorizations

​
Authorization
string
header
required

Partner API key (e.g. nerds_live_a8f3d9k2m5n7p1q4r6t8v0w2x4y6z8)

Path Parameters

​
external_id
string
required

External contact ID

Example:

"C-10042"

Body

application/json
​
external_organization_id
string

External organization ID this contact belongs to

Example:

"ORG-5001"

​
name
string | null
Example:

"John Doe"

​
email
string | null
Example:

"john@example.com"

​
phone
string | null
Example:

"+31612345678"

​
address
string | null
Example:

"Keizersgracht 100"

​
zip
string | null
Example:

"1015 AA"

​
city
string | null
Example:

"Amsterdam"

​
country
string | null

ISO 3166-1 alpha-2 country code

Example:

"NL"

​
comment
string | null

Internal notes about this contact

​
status
string
default:active
Example:

"active"

​
created_at
string<date-time> | null
​
updated_at
string<date-time> | null

Response

Contact updated

​
success
boolean
Example:

true

​
data
object
​
message
string