To authenticate an OpenCRM Connector you will need an API Key, Pass Key and your OpenCRM account name.
API Key and Pass Key
These credentials should be issued by OpenCRM’s support team or your OpenCRM account manager. Please contact support@opencrm.co.uk for more information.
OpenCRM Account
This is your account name as it appears in the url when logged into OpenCRM.
For instance if the url is https://mycompany.opencrm.co.uk your account name for API purposes would be mycompany.
Cyclr Connector Installation
When installing an OpenCRM Connector, the following values are used:
- Pass Key
- OpenCRM account name
- API Key
Add custom fields
Your records may contain custom fields which aren’t mapped for each method’s request or response fields. You can find the API field names for custom fields in your custom field settings within OpenCRM. An example of a custom field API field name is cf_123.
To add mappings for a custom field, you can follow the steps in the Cyclr documentation on how to add custom fields.
To add a custom field, you need to provide the API field name for the Field Location of the custom field.
The format varies slightly depending on whether the field is for a singular or plural method, such as Get Contact or List Contacts.
| Method Name | Response/Request Field | Field Location | Example |
|---|---|---|---|
| Upsert Contact | Request | APIFieldName | cf_123 |
| Get Contact | Response | APIFieldName | cf_123 |
| List Contacts | Response | [].APIFieldName | [].cf_123 |
| List New Contacts | Response | [].APIFieldName | [].cf_123 |
| List Updated Contacts | Response | [].APIFieldName | [].cf_123 |