Contact / Types

Update an existing contact type

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

PUT

/fm/contact/types/{contact_type_id}

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

{
  "_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"
}

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

Path Parameters

contact_type_idstringrequired

Contact type id to update

Maximum string length: 20

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

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

descriptionstring

Example: Contact Type

report_typeenum<string>

Available options: periodic-lease, combined, recharge, recharge-fuel, pay-run, pay-run-reports

status_flagenum<string>default:active

Available options: active, inactive

Example: active

Response

Success

_linksobject

Show child attributes

contact_type_idstring

Example: 1234567890123456789