...
The following table provides the URI and method that can be used to search for contacts in Crittah.
| Method | Result |
|---|---|
| URI | https://[CompanyID].crittah.com/ws/apiv2/[json or xml]/contacts/search |
| POST | Post a JSON or XML object with search criteria. |
Search Fields
| Field | Value type | Mandatory | Description | Example |
|---|---|---|---|---|
| FirstName | string | First name of the contact | Jarryd | |
| LastName | string | Last name of the contact | Hayne | |
| Phone | string | Phone number of the contact | 987649874 | |
| Mobile | string | Mobile phone number of the contact | 041658246 | |
| Fax | string | Fax number of the contact | 6546548665 | |
| string | Email address of the contact | fred@smith.com | ||
| ContactRef | string | The unique reference of the contact allocated by Crittah contact created | 6548335 |
Example Search
Perform a POST to the following URLÂ https://[companyID].crittah.com/ws/apiv2/json/contacts/search
JSON
| Code Block |
|---|
{
"FirstName": "James",
"Mobile": "0438770502",
"Email": "james@skurray.com"
} |
XML
| Code Block |
|---|
<?xml version="1.0" encoding="UTF-8"?>
<ContactSearchParamsComplex xmlns="http://schemas.datacontract.org/2004/07/Spinifex.lib.objects" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<FirstName>James</FirstName>
</ContactSearchParamsComplex> |
Working with a single contact
The following table provides the URI and methods that can be used to add, updated, delete and get a contact in Crittah
| Method | Result |
|---|---|
| URI | https://[CompanyID].crittah.com/ws/apiv2/[json or xml]/contacts/[contactId] |
| DELETE | Deletes one contact |
| GET | Returns data for one contact |
| POST | Create or modify only the supplied data for one contact; returns contact data after request |
| PUT | Not supported |
...