lead-configuration
When a Reuzenpanda form gets submitted a lead-configuration is added. So the lead-configuration is the form submission. This contains all the data the customer has filled in and different metadata.
The lead-configuration has the following properties:
- configuration: The configuration object
- configurator_id: the id of the configurator filled in
- finalise: if the configuration is final this is true. (important to have this true when final)
- automation: always true
The configuration has the following properties:
- id: id of the configuration
- configurator_id: the id of the configurator filled in
- input_fields: The question filled in by the customer and the regarden answers
- status: Always "PARTIAL_CONFIGURATION"
Here is an example of a lead-configuration request body:
{
"configuration":{
"id":"f58c1821-10db-45a4-9884-1ddf5dc1c031",
"configurator_id":"a8437f5e-25eb-4ecb-a827-a849f225a200",
"input_fields":[
{
"field_identifier":"94222939-7b25-4b7b-bc96-386ac7c882c3",
"field_label":"Number question",
"value":40,
"type":"NUMBER",
"technical_type":""
},
{
"field_identifier":"59618e13-6483-4521-ad73-0c7edfe2f3de",
"field_label":"Radio question",
"value":{
"id":"25b7dcb4-a67e-43db-9eb0-cfdc240dba3c",
"name":"Answer A"
},
"type":"RADIO",
"technical_type":""
},
{
"field_identifier":"f86b477f-f5ee-4c19-8bf2-f9fab7f698f6",
"field_label":"Mutliple select question",
"value":[
{
"id":"f641acb1-62ac-4770-8bed-875953abc174",
"name":"Answer B"
},
{
"id":"a3737622-6dcc-462f-b288-0fda2446ab4f",
"name":"Answer A"
}
],
"type":"CHECK_BOX",
"technical_type":""
},
{
"field_identifier":"0c2b36a4-4e4a-4b4a-8dc0-e664c439f1dc",
"field_label":"Color question",
"value":{
"id":"8718cbca-1e59-4167-a706-11ee56c829a7",
"color":"#8247F5",
"checked":3,
"name":"Koninklijk amethist"
},
"type":"COLOR",
"technical_type":""
},
{
"field_identifier":"32a596d9-f1e0-4097-8790-02f4d599d274",
"field_label":"Long text question",
"value":"Long text answer\nLong text answer line 2",
"type":"TEXT_AREA",
"technical_type":""
},
{
"field_identifier":"95140da7-b910-4eb4-a640-9686b554a14f",
"field_label":"Short text question",
"value":"Short text answer",
"type":"TEXT",
"technical_type":""
},
{
"field_identifier":"8018a949-925f-4012-b2c9-4ea53f9bb21d",
"field_label":"Firstname",
"value":"John",
"type":"TEXT",
"technical_type":"FIRST_NAME"
},
{
"field_identifier":"55c46201-0e48-429e-818f-71490ea5dfb9",
"field_label":"Surname",
"value":"Doe",
"type":"TEXT",
"technical_type":"LAST_NAME"
},
{
"field_identifier":"67d3a84e-fe2f-4e5e-b6d3-8257b147230b",
"field_label":"E-mail address",
"value":"john.doe@gmail.com",
"type":"TEXT",
"technical_type":"EMAIL"
},
{
"field_identifier":"6fa7f9e4-52e4-4640-8ead-3e07f8d42168",
"field_label":"Phone number",
"value":"+310612345678",
"type":"TEXT",
"technical_type":"PHONE"
}
],
"status":"PARTIAL_CONFIGURATION"
},
"configurator_id":"a8437f5e-25eb-4ecb-a827-a849f225a200",
"configuration_id":"f58c1821-10db-45a4-9884-1ddf5dc1c031",
"finalise":true,
"automation":true
}Input_fields
Input fields contain all the questions, filled in by the customer, with the chosen answers. Each inputfield has the following:
- field_identifier: This is the id of the question. This is equal to the question-template id. (the is of the question in the configurator)
- field_label: This is the pretty name of the question filled in. This is equal to the question-template name. (the is of the question in the configurator)
- value: This is an object representing the answer. This is depends on the question type. (The different input_field structures with answer by question type below)
- type: This is the question type.
- technical_type: This is a technical_type. This is used for assumption within the Reuzenpanda system. A firstname question has a technical_type of "FIRST_NAME". (this can also be empty).
An example of an input_field (Radio question):
{
"field_identifier":"59618e13-6483-4521-ad73-0c7edfe2f3de",
"field_label":"Radio question",
"value":{
"id":"25b7dcb4-a67e-43db-9eb0-cfdc240dba3c",
"name":"Answer A"
},
"type":"RADIO",
"technical_type":""
}Multiple choice (radio)
A multiple choice question answer contains the following:
- id: id of the answer. This is equal to the id of the answer in the configurator
- name: pretty name of the answer. This is equal to the name of the answer in the configurator
Example below:
{
"field_identifier":"59618e13-6483-4521-ad73-0c7edfe2f3de",
"field_label":"Radio question",
"value":{
"id":"25b7dcb4-a67e-43db-9eb0-cfdc240dba3c",
"name":"Answer A"
},
"type":"RADIO",
"technical_type":""
}Multiple select
A multiple select question answer contains an array of object. Each object contains the following:
- id: id of the answer. This is equal to the id of the answer in the configurator
- name: pretty name of the answer. This is equal to the name of the answer in the configurator
Example below:
{
"field_identifier":"f86b477f-f5ee-4c19-8bf2-f9fab7f698f6",
"field_label":"Mutliple select question",
"value":[
{
"id":"f641acb1-62ac-4770-8bed-875953abc174",
"name":"Answer B"
},
{
"id":"a3737622-6dcc-462f-b288-0fda2446ab4f",
"name":"Answer A"
}
],
"type":"CHECK_BOX",
"technical_type":""
}Number question
A color question answer contains an array of object. Each object contains the following:
- id: id of the answer. This is equal to the id of the answer in the configurator
- name: pretty name of the answer. This is equal to the name of the answer in the configurator
Example below:
{
"field_identifier":"94222939-7b25-4b7b-bc96-386ac7c882c3",
"field_label":"Number question",
"value":40,
"type":"NUMBER",
"technical_type":""
}Color question
A color question answer contains the following:
- id: id of the answer (color). This is equal to the id of the answer in the configurator. (only filled in when not custom color)
- color: Hex-code of the color.
- name: pretty name of the answer (color). This is equal to the name of the answer in the configurator. (only filled in when not custom color)
- checked: index of the answer (color).
Example below:
{
"field_identifier":"0c2b36a4-4e4a-4b4a-8dc0-e664c439f1dc",
"field_label":"Color question",
"value":{
"id":"8718cbca-1e59-4167-a706-11ee56c829a7",
"color":"#8247F5",
"checked":3,
"name":"Koninklijk amethist"
},
"type":"COLOR",
"technical_type":""
}Long text question
A long text question answer is the text filled in.
Example below:
{
"field_identifier":"32a596d9-f1e0-4097-8790-02f4d599d274",
"field_label":"Long text question",
"value":"Long text answer\nLong text answer line 2",
"type":"TEXT_AREA",
"technical_type":""
}Short text question
A short text question answer is the text filled in.
Example below:
{
"field_identifier":"95140da7-b910-4eb4-a640-9686b554a14f",
"field_label":"Short text question",
"value":"Short text answer",
"type":"TEXT",
"technical_type":""
}Firstname question
A firstname question answer is the firstname filled in.
Example below:
{
"field_identifier":"8018a949-925f-4012-b2c9-4ea53f9bb21d",
"field_label":"Firstname",
"value":"John",
"type":"TEXT",
"technical_type":"FIRST_NAME"
}Lastname question
A lastname question answer is the lastname filled in.
Example below:
{
"field_identifier":"55c46201-0e48-429e-818f-71490ea5dfb9",
"field_label":"Surname",
"value":"Doe",
"type":"TEXT",
"technical_type":"LAST_NAME"
}E-mailaddress question
An E-mail adddress question answer is the e-mailaddress filled in.
Example below:
{
"field_identifier":"67d3a84e-fe2f-4e5e-b6d3-8257b147230b",
"field_label":"E-mail address",
"value":"john.doe@gmail.com",
"type":"TEXT",
"technical_type":"EMAIL"
}Phonenumber questions
A phonenumber question answer is the phonenumer filled in.
Example below:
{
"field_identifier":"6fa7f9e4-52e4-4640-8ead-3e07f8d42168",
"field_label":"Phone number",
"value":"+310612345678",
"type":"TEXT",
"technical_type":"PHONE"
}Submitting a lead
When a lead-configuration gets submitted the Reuzenpanda software automatically creates a lead based on the lead-configuration's data.
So to create a lead through the API you have to submit a lead-configuration with all the data filled in by the customer. How this is structured is explained above.
The lead-submission can be done at the following endpoint with a PATCH request: https://backend.reuzenpanda.nl/widget-service/api/v1/lead-configuration/public (opens in a new tab)
with the following body (same as above):
{
"configuration":{
"id":"f58c1821-10db-45a4-9884-1ddf5dc1c031",
"configurator_id":"a8437f5e-25eb-4ecb-a827-a849f225a200",
"input_fields":[
{
"field_identifier":"94222939-7b25-4b7b-bc96-386ac7c882c3",
"field_label":"Number question",
"value":40,
"type":"NUMBER",
"technical_type":""
},
{
"field_identifier":"59618e13-6483-4521-ad73-0c7edfe2f3de",
"field_label":"Radio question",
"value":{
"id":"25b7dcb4-a67e-43db-9eb0-cfdc240dba3c",
"name":"Answer A"
},
"type":"RADIO",
"technical_type":""
},
{
"field_identifier":"f86b477f-f5ee-4c19-8bf2-f9fab7f698f6",
"field_label":"Mutliple select question",
"value":[
{
"id":"f641acb1-62ac-4770-8bed-875953abc174",
"name":"Answer B"
},
{
"id":"a3737622-6dcc-462f-b288-0fda2446ab4f",
"name":"Answer A"
}
],
"type":"CHECK_BOX",
"technical_type":""
},
{
"field_identifier":"0c2b36a4-4e4a-4b4a-8dc0-e664c439f1dc",
"field_label":"Color question",
"value":{
"id":"8718cbca-1e59-4167-a706-11ee56c829a7",
"color":"#8247F5",
"checked":3,
"name":"Koninklijk amethist"
},
"type":"COLOR",
"technical_type":""
},
{
"field_identifier":"32a596d9-f1e0-4097-8790-02f4d599d274",
"field_label":"Long text question",
"value":"Long text answer\nLong text answer line 2",
"type":"TEXT_AREA",
"technical_type":""
},
{
"field_identifier":"95140da7-b910-4eb4-a640-9686b554a14f",
"field_label":"Short text question",
"value":"Short text answer",
"type":"TEXT",
"technical_type":""
},
{
"field_identifier":"8018a949-925f-4012-b2c9-4ea53f9bb21d",
"field_label":"Firstname",
"value":"John",
"type":"TEXT",
"technical_type":"FIRST_NAME"
},
{
"field_identifier":"55c46201-0e48-429e-818f-71490ea5dfb9",
"field_label":"Surname",
"value":"Doe",
"type":"TEXT",
"technical_type":"LAST_NAME"
},
{
"field_identifier":"67d3a84e-fe2f-4e5e-b6d3-8257b147230b",
"field_label":"E-mail address",
"value":"john.doe@gmail.com",
"type":"TEXT",
"technical_type":"EMAIL"
},
{
"field_identifier":"6fa7f9e4-52e4-4640-8ead-3e07f8d42168",
"field_label":"Phone number",
"value":"+310612345678",
"type":"TEXT",
"technical_type":"PHONE"
}
],
"status":"PARTIAL_CONFIGURATION"
},
"configurator_id":"a8437f5e-25eb-4ecb-a827-a849f225a200",
"configuration_id":"f58c1821-10db-45a4-9884-1ddf5dc1c031",
"finalise":true,
"automation":true
}