CRM-2 Contacts API

Contacts API is used to create and retreive contacts.

The API calls follow the general RESTful pattern of CRM-2 API.

The base URL is http://crm-2-url/crm2/contact

GET: Get a List of Contacts by:

• contactId
• emailAddress
• attribute Map

POST: Create or update Contact

The following parameters are supported:

• firstName
• lastName
• companyName
• emailsNumber (used to iterate the following parameter where N is an index number)
  • emailN (the email address)
  • emailPurposeN (can be one of : PRIMARY, OTHER, ORDER, BILLING_AR, PAYMENT_AR, SHIPMENT)
• attribute Map

Only the attributes given as attribute_XXX are used to find an existing contact for update, if they are not given and / or a contact matching those is not found the operation will create a new contact.

The operation returns a JSON response with the contact ID of the created or updated record, eg:

 { "contact": { "contactId": XXX } }

The attribute Map is described as a series of attribute_${key}=${value} parameters. For example, attribute_opentapsPartyId=12345 will become {opentapsPartyId:12345}