Create Client Contact - Roosted HR API Documentation

POST

clients

{id}

contacts

Create Client Contact

curl --request POST \
  --url https://api.roostedhr.com/api/1_12/clients/{id}/contacts \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "name": "<string>",
  "number": "<string>",
  "email": "<string>",
  "title": "<string>"
}
'

{
  "id": "<string>",
  "name": "<string>",
  "number": "<string>",
  "email": "<string>",
  "title": "<string>"
}

Authorizations

X-API-KEY

string

header

required

Path Parameters

string

required

Client ID

Body

application/json

Contact details. Only name is required.

name

string

required

Contact full name.

number

string

Phone number.

string

Email address.

title

string

Job title.

Response

Created

string

Unique contact identifier.

name

string

Contact full name.

number

string | null

Contact phone number.

string | null

Contact email address.

title

string | null

Contact job title.

Get Client ContactReturns a single contact by ID.

Create Client Contact

curl --request POST \
  --url https://api.roostedhr.com/api/1_12/clients/{id}/contacts \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "name": "<string>",
  "number": "<string>",
  "email": "<string>",
  "title": "<string>"
}
'

{
  "id": "<string>",
  "name": "<string>",
  "number": "<string>",
  "email": "<string>",
  "title": "<string>"
}