Create a Contact

post/public/v1/contacts

post/public/v1/contacts

curl --request POST \
  --url 'https://api.app.astalty.com.au/public/v1/contacts' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "first_name": "string",
  "last_name": "string",
  "dob": "2026-07-01",
  "email": "jane.citizen@example.com",
  "phone": "string",
  "mobile": "string",
  "preferred_contact_method": "string",
  "occupation": "string",
  "organisation": {
    "id": "string"
  },
  "description": "string"
}'

Response

{
  "data": {
    "id": "c1o2n3t4-a5c6-47t8-9b0c-1d2e3f4a5b6c",
    "full_name": "Jane Doe",
    "first_name": "John",
    "last_name": "Doe",
    "dob": "1985-03-22",
    "email": "jane.doe@example.com",
    "phone": "02 9876 5432",
    "mobile": "0412 345 678",
    "gender": "male",
    "occupation": "Support Coordinator",
    "description": "Primary point of contact for scheduling",
    "archived_at": "2025-01-01T00:00:00+00:00",
    "preferred_contact_method": "mobile",
    "created_at": "2024-01-15T10:30:00+00:00"
  }
}

Authorization

Authorizationstringrequired
Bearer authentication header of the form Bearer <token>, where <token> is your API key. See How to set up an API key.

Body

application/json

first_namestringrequiredmax length 255
last_namestring | nullmax length 255
dobstring<date> | null
emailstring<email> | nullmax length 255
phonestring | nullmax length 255
mobilestring | nullmax length 255
preferred_contact_methodstring | nullmax length 255
occupationstring | nullmax length 255
organisationobject
▶Show 1 child attributesHide child attributes
- idstring | null
descriptionstring | nullmax length 65535
Limited to 65535 bytes.

Response

200application/json

ContactResource

dataobjectrequired
▶Show 14 child attributesHide child attributes
- idstringrequired
  Example:c1o2n3t4-a5c6-47t8-9b0c-1d2e3f4a5b6c
- full_namestringrequired
  Example:Jane Doe
- first_namestring | nullrequired
  Example:John
- last_namestring | nullrequired
  Example:Doe
- dobstring | nullrequired
  Example:1985-03-22
- emailstring | nullrequired
  Example:jane.doe@example.com
- phonestring | nullrequired
  Example:02 9876 5432
- mobilestring | nullrequired
  Example:0412 345 678
- genderstring | nullrequired
  Example:male
- occupationstring | nullrequired
  Example:Support Coordinator
- descriptionstring | nullrequired
  Example:Primary point of contact for scheduling
- archived_atstring | nullrequired
  Example:2025-01-01T00:00:00+00:00
- preferred_contact_methodstring | nullrequired
  Example:mobile
- created_atstringrequired
  Example:2024-01-15T10:30:00+00:00

Errors

401Unauthenticated
403Authorization error
422Validation error

Command Palette

Authorization

Body

Response

Errors