Cayzu Help Desk Support



Sample API code

Updated: 02/08/2019
Article #: 214


Cayzu offers a public RESTFul API.  

 

To request your own API key (token), see this FAQ .

 

 

Sample API code:

 

How to find a contact:

http://api.cayzu.com/api/search/contacts?q=x&token=y

- Replace x with your email address or name for the contact you want to find in the system
- Replace y with your Cayzu API Token

How to add a contact:

https://api.cayzu.com/api/customer/individual?token=y

- Replace y with your Cayzu API Token

Note: If you want them to get the activation email, please set notify_by_email to true

Request body formats: application/json, text/json

Sample:

{
  "notify_by_email": false,
  "address1": "",
  "alternate_phone_number": "",
  "city": "",
  "country": "Canada",
  "description": "",
  "email_address": "Email_Address_Here",
  "full_name": "Full_Name_Here",
  "location": "",
  "phone_number": "",
  "postal_code": ""
}

How to update a contact:

https://api.cayzu.com/api/customer/w/contact/x?token=y

- Replace w with your customerid you retrieved from the find API call.
- Replace x with your id you retrieved from the find API call.
- Replace y with your Cayzu API Token

Request body formats: application/json, text/json

Sample:

{
  "notify_by_email": false,
  "address1": "123 Ford Street",
  "alternate_phone_number": "",
  "city": "",
  "country": "Canada",
  "description": "",
  "email_address": "Email_Address_Here",
  "full_name": "Full_Name_Here",
  "location": "",
  "phone_number": "",
  "postal_code": ""
}

 

 

How to create a ticket.  See this FAQ 

 

 

Want more information on Cayzu Help Desk? Visit www.cayzu.com

  






Rate this Topic:
Rating: 0.00 / Votes: 0