Contact / Types

Create a new contact type

This method requires the Contacts:Create permission to be associated with your role.

POST

/fm/contact/types

curl --request POST \
  --url https://api.catch-e.com/fm/contact/types \
  --header 'Authorization: <api-key>' \
  --header 'Audit-User-Id: <string>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "description": "Contact Type",
    "report_type": null,
    "status_flag": "active"
  }
]
'

{
  "_embedded": {
    "contact_types": [
      {
        "_links": {
          "self": {
            "href": "https://api.catch-e.com/fm/contact/types/1234567890123456789"
          }
        },
        "contact_type_id": "1234567890123456789",
        "description": "Contact Type",
        "report_type": null,
        "status_flag": "active"
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://api.catch-e.com/fm/contact/types"
    }
  },
  "page": 1,
  "page_count": 1,
  "page_size": 25,
  "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

pageinteger

Example: 1

page_countinteger

Example: 1

page_sizeinteger

Example: 25

total_itemsinteger

Example: 1

Still need help? Ask the team