Acculynx

This endpoint allows users to schedule the initial appointment for a specific job in the acculynx system. it is used to set up the first meeting or site visit for a construction or roofing project. the endpoint requires the job id, start date and time, and end date and time for the appointment. this is crucial for initiating the project workflow and ensuring that all parties involved are aware of the scheduled time for the first interaction. the appointment details are set in the context of the company’s timezone unless otherwise specified. use this endpoint when a new job has been created and the first appointment needs to be scheduled with the client or at the job site.

Action Parameters

Action Response

Creates a new contact in the acculynx system with detailed information for use in roofing and construction project management. this endpoint allows for the addition of comprehensive contact details including personal information, company affiliation, communication preferences, and address information. it’s particularly useful for adding new customers, leads, vendors, or any other type of contact relevant to construction projects. the endpoint provides flexibility in the amount of information that can be added, with only the contact type being required. use this when you need to add a new contact to your acculynx database or update your system with new lead information. note that while many fields are optional, providing as much information as possible will enhance the usefulness of the contact record for future project management and communication purposes.

Action Parameters

Action Response

Creates a new job in the acculynx system with the provided details. this endpoint allows you to initialize a job with essential information such as the associated contact, location, job category, work type, priority, and trade types. it’s particularly useful for setting up new projects or tasks within the acculynx platform for the roofing and construction industries. the endpoint requires at minimum a contact id and location address, with several optional fields to further customize the job entry. use this when you need to programmatically create new jobs in acculynx, such as when integrating with other systems or automating job creation processes.

Action Parameters

Action Response

This endpoint creates a new lead in the acculynx system, specifically for residential roofing projects. it should be used when a new potential customer expresses interest in roofing services or when importing lead data from external sources. the endpoint captures essential contact information to initiate the lead management process. while it creates the lead, it does not assign priorities or sales representatives; these actions would need to be performed separately. the endpoint is designed for simplicity and quick lead entry, focusing on the most crucial identifying information.

Action Parameters

Action Response

Retrieves a list of appointments from the calendar associated with a specific job in acculynx. this endpoint is used to fetch scheduled events, such as site visits, inspections, or project milestones, for a particular roofing or construction job. it provides valuable information for project management and scheduling purposes. the endpoint should be used when you need to view or manage the timeline of events for a specific job. it will not provide general calendar information or appointments unrelated to the specified job id. the response likely includes details such as appointment dates, times, descriptions, and associated team members, though the exact structure is not specified in the given schema.

Action Parameters

Action Response

Retrieves a list of calendars associated with the authenticated user or organization in acculynx. this endpoint provides access to the calendar data, which is crucial for scheduling and organizing tasks in the roofing and construction project management context. it should be used when you need to obtain an overview of all available calendars or to gather calendar ids for use in other api operations. the endpoint returns basic information about each calendar, likely including identifiers, names, and possibly associated metadata. it does not modify any calendar data and is intended for read-only operations. keep in mind that the response may be paginated for large datasets, and additional parameters might be available for filtering or sorting the results, although they are not specified in the current schema.

Action Parameters

Action Response

Retrieves a list of all available contact types in the acculynx system. this endpoint is used to fetch the predefined categories or classifications for contacts, such as residential, repair, property management, and other job categories. it’s essential for organizing and filtering contact information within the acculynx platform. the endpoint should be used when setting up new contacts, updating existing ones, or when needing to populate dropdown menus or filter options in the user interface. it does not create, modify, or delete contact types; it only provides the current list of available options. the response will likely include unique identifiers and names for each contact type, allowing for easy integration with other parts of the acculynx api or external systems.

Action Parameters

Action Response

This endpoint allows you to add a company representative to a specific job within the acculynx system. it is used when you need to associate a representative with a particular project or task. the endpoint requires the job’s unique identifier and the representative’s id to establish the connection. this operation is useful for assigning personnel to projects, tracking responsibilities, and maintaining accurate job records. it’s important to note that this endpoint only adds the association and doesn’t create new representative or job entries.

Action Parameters

Action Response