AUautarc
Enquiries

Create a lead

Creates a new enquiry (lead) for the authenticated company. If assignedUserId is omitted and postcode is present, Autarc applies the company's postcode (PLZ) lead assignment rules and assigns the lead to the matching team member when one is found. projectId can link the lead to an existing project in the authenticated company. When projectId is set without customerId, the lead uses the project's customer. When both are set, the project must belong to the supplied customer; otherwise the request fails with 400.

post/enquiries

Request

  • Base URL
    https://api3.autarc.energy/v1
  • Auth
    API key in header X-Api-Key

Request body

namestring required

Lead name, for example the contact or household name.

phonestring

Optional phone number for the lead.

emailstring email

Optional email address for the lead.

postcodestring

Optional postcode for the lead address. Used for PLZ auto-assignment when assignedUserId is omitted.

addressLine1string

Optional first address line for the lead.

citystring

Optional city. Used when a new customer is created because customerId is omitted.

countrystring

Optional country. Used when a new customer is created because customerId is omitted.

countryCodestring

Optional ISO country code. Used when a new customer is created because customerId is omitted.

notesstring

Optional free-text notes for the lead.

customerIdstring uuid

Optional existing customer DB UUID to link this lead to.

projectIdstring uuid

Optional existing project DB UUID to link this lead to. If set without customerId, the project's customer is used.

assignedUserIdstring uuid

Optional team member profile DB UUID to assign this lead to. Overrides postcode assignment when provided.

source'api' | 'zapier'

Optional public source for the lead. Defaults to api when omitted.

Response

Created

idstring uuid required
namestring required
statusstring required

Current lead pipeline status.

sourcestring required

Source that created the lead.

phonestring nullable
emailstring email nullable
postcodestring nullable
addressLine1string nullable
notesstring nullable
estimatenumber nullable
customerIdstring uuid nullable
projectIdstring uuid nullable
stageIdstring uuid nullable
assignedUserIdstring uuid nullable
rejectedReasonstring nullable
reminderDatestring date-time nullable
createdAtstring date-time required
updatedAtstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.