AccuLynx Integration
May 2, 2024From AccuLynx Documentation: All API Calls require authentication via an API Key. An API Key must be sent with every request.
Each individual location within a company needs its own API key.
Obtaining an API Key
Get your API key from your AccuLynx API page. (https://my.acculynx.com/apikeys)
Authorization
Key: authorization
Value: Bearer <your API key>
Use this endpoint for webhook https://api.acculynx.com/api/v1/leads
Body Schema JSON
| firstName | string [ 0 .. 50 ] characters First name of the primary contact. Required |
| lastName | string or null [ 0 .. 50 ] characters Last name of the primary contact. |
| companyName | string or null [ 0 .. 100 ] characters Company name for the primary contact. |
| phoneNumber1 | string or null <tel> [ 0 .. 30 ] characters Primary phone number for the primary contact. Phone Cell from CT |
| phoneExtension1 | string or null [ 0 .. 100 ] characters Primary phone extension for the primary contact. Not Included |
| phoneType1 | string (ContactFieldDescription) Enum: “Home” “Mobile” “Work” |
| phoneNumber2 | string or null <tel> [ 0 .. 30 ] characters Additional phone number for the primary contact. Phone Home from CT |
| phoneExtension2 | string or null [ 0 .. 100 ] characters Additional phone extension for the primary contact. Not included |
| phoneType2 | string (ContactFieldDescription) Enum: “Home” “Mobile” “Work” |
| phoneNumber3 | string or null <tel> [ 0 .. 30 ] characters Additional phone number for the primary contact. NA |
| phoneExtension3 | string or null [ 0 .. 100 ] characters Additional phone extension for the primary contact. NA |
| phoneType3 | string (ContactFieldDescription) Enum: “Home” “Mobile” “Work” NA |
| emailAddress | string or null <email> [ 0 .. 100 ] characters Primary email address for the primary contact. Email from CT |
| crossReference | string or null [ 0 .. 250 ] characters Cross reference identifier for the primary contact. NA |
| jobCategory | string (JobCategory)Enum: “Residential” “Repair” “Property Management” jobCategory custom field control. |
| workType | string (WorkType)Enum: “Insurance” “Repair” “Retail” “Warranty” “New” “Inspection” “Service” workType custom field control |
| street | string or null [ 0 .. 250 ] characters Street address of the lead/job. Address from CT |
| street2 | string or null [ 0 .. 50 ] characters Apartment/Suite/Unit/Building of the lead/job. NA |
| city | string or null [ 0 .. 50 ] characters City of the lead/job. City from CT |
| state | string or null [ 0 .. 50 ] characters State, County, Province, or Region of the lead/job. State from CT |
| zip | string or null [ 0 .. 50 ] characters Zip code or postal code of the lead/job.Zip_code from CT |
| country | string or null [ 0 .. 50 ] characters Country of the lead/job. Hard coded US |
| priority | string (JobPriority) Enum: “Normal” “High” “Urgent” jobPriority Custom field control |
| notes | string or null [ 0 .. 1000 ] characters Notes are saved as a comment on the message board of the lead/job.job Notes Custom field control Whiteboard Token |
| salesPerson | string or null <email> [ 0 .. 100 ] characters Login email address of the active user the lead/job should be assigned to. If no email address is provided, the lead will be unassigned. Need some help here for Mapping or should we leave it blank? Leave it blank |
initialAppointmentDate | string or null <date> Date and time of the initial appointment. If no timezone is provided it will default to the Company timezone. If there is an initial Appointment Date and there is no sales Person, the appointment time will be added to the Notes field.Next Appointment date/time. Ours is Z, Format?Wait until after assignments “MAY” be added in CT |