Overview: 

The Developer API - Add Survey endpoint can be used to ingest survey and inventory information and add them to existing projects. This can include both furniture and packing materials. This doc outlines the necessary data structure that must be adhered to in order to properly ingest them. 

Prerequisites: 

• Your website or system must be able to send a webhook (an automatic message) to our endpoint in valid JSON format with the header Content-Type: application/json. 
• Your payloads must fit the JSON schema outlined in this doc. 

How to Enable in Supermove: 

1. Go to Company Settings in Supermove
2. Click Lead Providers (see screenshot above)
3. Click the + Add Lead Provider button. 
4. Select Developer API - Add Survey endpoint from the list. 
5. Add a Name and Description for this endpoint. 
   • Note: You can configure multiple Developer API - Add Survey endpoints. The names and descriptions allow you tell them apart.
6. Click Copy URL. This URL is unique to your company and to your account, all payloads sent to the endpoint will be associated with your Supermove account. No further API keys or organization identifiers are needed. 
7. Send Payloads to the URL. Please see below for an example payload and detailed information on each key and value.

How to Debug Lead Processing: 

Please see Debugging Inbound Leads - Link

Processing Notes:

• Project UUID - This endpoint defaults to utilizing the project UUID if the payload contains both UUID and email. 
• Customer Email - The customer email is used to access the most recent project associated with this customer. If multiple projects have been recently created, this can cause the survey information to be affiliated with unintended projects. Please try to leverage the Project UUID where possible. 
• Only 1 survey can be added to projects via the lead provider portal - This includes any surveys included in the initial lead. Any additional surveys will cause a validation error in the logs. 

Overall Structure: 

Warning: This doc is intended as a reference for developers working to integrate leads. 

{
    "project_uuid": "cf67aa77-fc75-4735-b691-3d0efe26b435", 
    "customer_email": "john.smith@email.com",
    "survey": [...] //Must conform to survey information. Full payload schema linked in article below.
}

Note: All fields are optional unless otherwise stated in the description.