Contacts

Create a new contact

Creata a new contact This method requires the Contacts:Create permission to be associated with your role.

POST

/fm/contacts

curl --request POST \
  --url https://api.catch-e.com/fm/contacts \
  --header 'Authorization: <api-key>' \
  --header 'Audit-User-Id: <string>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "address1": "Level 1 ",
    "address2": "111 Street name",
    "allocations": [
      {
        "record_id": "100000",
        "status_flag": "active",
        "table_name": "fm_clients"
      }
    ],
    "area": "",
    "contact_job_title_id": "1234567890123456789",
    "contact_type_allocations": [
      "1234567891234567"
    ],
    "country_id": "12312312312312312312",
    "email": "hello@catch-e.com.au",
    "given_name": "Abc",
    "mobile": "+61423456789",
    "note": "Any note in relation to the contact",
    "phone": "+61391234567",
    "postcode": "3173",
    "salutation": "Mrs",
    "state_id": "100000",
    "status_flag": "active",
    "surname": "Surname"
  }
]
'

{
  "_embedded": {
    "contacts": [
      {
        "_links": {
          "job_title": {
            "href": "https://api.catch-e.com/fm/contact/job-titles/1234567890123456789"
          },
          "self": {
            "href": "https://api.catch-e.com/fm/contact/1234567890123456789"
          }
        },
        "address1": "Level 1 ",
        "address2": "111 Street name",
        "allocations": [
          {
            "contact_id": "1234567890123456789",
            "record_id": "100001",
            "status_flag": "active",
            "table_name": "fm_clients"
          }
        ],
        "area": "",
        "contact_id": "1234567890123456789",
        "contact_job_title_id": "1234567890123456789",
        "contact_type_allocations": [
          {
            "contact_id": "1234567890123456789",
            "contact_type_id": "1234567890123456789",
            "email_type": "to"
          }
        ],
        "country_id": "12312312312312312312",
        "email": "hello@catch-e.com.au",
        "given_name": "Abc",
        "mobile": "+61423456789",
        "note": "Any note in relation to the contact",
        "phone": "+61391234567",
        "postcode": "3173",
        "salutation": "Mrs",
        "state_id": "100000",
        "status_flag": "active",
        "surname": "Def"
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://api.catch-e.com/fm/contacts"
    }
  },
  "total_items": 1
}

Authorizations

Authorizationstringheaderrequired

For accessing the API a valid token must be passed in all the queries in the 'Authorization' header.

A valid token is generated by the API and returned by the /authenticate method by supplying a valid username and password.

The following syntax must be used in the 'Authorization' header :

Bearer aaaaaa/bbbbbb.ccccccc.dddddd

Headers

Audit-User-Idstringheader

(Optional) User Id to use for audit purposes. This header requires the Audit:UserIdOverride permission to be associated with your role.

Maximum string length: 5

Pattern: ^[1-9]{1}[0-9]*$

Body

JSON payload

itemsobject[]

Show child attributes

Response

Success

_embeddedobject

Show child attributes

_linksobject

total_itemsinteger

Example: 1

Still need help? Ask the team