Overview: 

The Developer API Integration can be used to ingest customer defined item lists collected by longer forms. This doc outlines the necessary data structure that must be adhered to in order to properly ingest this customer survey as part of the lead. This is an addendum to the main Developer API Integration payload. 

Prerequisites: 

• The Developer API must be configured. Please see main Developer API Integrations for more details. 
• Payloads must have lead information and survey information, you can not submit survey information alone. 

How to Debug Survey Processing: 

Please see Debugging Inbound Leads - Link. Survey logs will be surfaced within the associated lead logs. 

Overall Survey Structure: 

Warning: This doc is long and very technical. It is intended as a reference for developers working to integrate leads with associated survey information. 

"survey":[
    {
      "name": "Living Room",
      "description": "Large room with fireplace.",
      "items": [
        {
          "name": "Couch",
          "description": "Gray upholstered three-piece couch.",
          "take_count": 1,
          "leave_count": 0,
          "weight": 400,
          "volume": 57,
          "price": 10000
        },
        {
          "name": "Yellow Chair",
          "description": "Very scratched up.",
          "take_count": 2,
          "volume": 2000
        },
        {
          "name": "Media Console",
          "description": "Mid Mod",
          "take_count": 1
        }
      ]
    },
    {
      "name": "Master Bedroom",
      "description": "Straight back on the right",
      "items": [
        {
          "name": "King bed frame",
          "description": "from IKEA",
          "take_count": 1
        },
        {
          "name": "dressers",
          "description": "from IKEA",
          "take_count": 2
        }
      ]
    }
  ]

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

Collection Object:

{
  "name": "Living Room",
  "description": "Large room with fireplace.",
  "items": [
    {
      "name": "Couch",
      "description": "Gray upholstered three-piece couch.",
      "take_count": 1,
      "leave_count": 0,
      "weight": 400,
      "volume": 57,
      "price": 10000
    },
    {
      "name": "Yellow Chair",
      "description": "Very scratched up.",
      "take_count": 2,
      "volume": 2000
    },
    {
      "name": "Media Console",
      "description": "Mid Mod",
      "take_count": 1
    }
  ]
},

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

Item Object:

{
  "name": "Couch",
  "description": "Gray upholstered three-piece couch.",
  "take_count": 1,
  "leave_count": 0,
  "weight": 400,
  "volume": 57,
  "price": 10000
}

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