POST api/surveys
Request Information
URI Parameters
None.
Body Parameters
ApiSurvey| Name | Description | Type | Additional information |
|---|---|---|---|
| jobid | globally unique identifier |
None. |
|
| servicetenantid | globally unique identifier |
None. |
|
| records | Collection of ApiSurveyRecord |
None. |
|
| createwithoutvalidcontacts | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"jobid": "f1cdb33c-8cbe-4741-abc3-98477e9974ba",
"servicetenantid": "0268bfdd-f941-4ce2-be2c-28897d371b70",
"records": [
{
"SurveyID": "f09e1fc8-4c0b-4fba-b444-eb4825ceff6f",
"ExtSurveyID": "sample string 2",
"Created": "2025-12-25T17:00:10.8486314+01:00",
"Sent": "2025-12-25T17:00:10.8486314+01:00",
"Completed": "2025-12-25T17:00:10.8486314+01:00",
"CustomerID": "sample string 3",
"Lastname": "sample string 4",
"Firstname": "sample string 5",
"Preposition": "sample string 6",
"Initials": "sample string 7",
"Sex": "sample string 8",
"Street": "sample string 9",
"Housenumber": "sample string 10",
"HousenumberExt": "sample string 11",
"Zipcode": "sample string 12",
"City": "sample string 13",
"Country": "sample string 14",
"OrderID": "sample string 15",
"OrderSubID": "sample string 16",
"OrderProduct": "sample string 17",
"OrderProductGroup": "sample string 18",
"OrderProductType": "sample string 19",
"OrderRemarks": "sample string 20",
"OrderChannel": "sample string 21",
"OrderType": "sample string 22",
"OrderEmployee": "sample string 23",
"OrderExecutive": "sample string 24",
"OrderExecutiveType": "sample string 25",
"OrderCreated": "2025-12-25T17:00:10.8496188+01:00",
"OrderStarted": "2025-12-25T17:00:10.8496188+01:00",
"OrderCompleted": "2025-12-25T17:00:10.8496188+01:00",
"CallbackRequest": true,
"CallbackComplained": "sample string 27",
"CallbackOpened": "2025-12-25T17:00:10.8496188+01:00",
"CallbackCreated": "2025-12-25T17:00:10.8496188+01:00",
"CallbackCompleted": "2025-12-25T17:00:10.8496188+01:00",
"CallbackRemarks": "sample string 28",
"FreeTextField1": "sample string 29",
"FreeTextField2": "sample string 30",
"FreeTextField3": "sample string 31",
"FreeTextField4": "sample string 32",
"FreeTextField5": "sample string 33",
"FreeTextField6": "sample string 34",
"FreeTextField7": "sample string 35",
"FreeTextField8": "sample string 36",
"FreeTextField9": "sample string 37",
"FreeTextField10": "sample string 38",
"FreeTextField11": "sample string 39",
"FreeTextField12": "sample string 40",
"FreeTextField13": "sample string 41",
"FreeTextField14": "sample string 42",
"FreeTextField15": "sample string 43",
"FreeTextField16": "sample string 44",
"FreeTextField17": "sample string 45",
"FreeTextField18": "sample string 46",
"FreeTextField19": "sample string 47",
"FreeTextField20": "sample string 48",
"FreeTextField21": "sample string 49",
"FreeTextField22": "sample string 50",
"FreeTextField23": "sample string 51",
"FreeTextField24": "sample string 52",
"FreeTextField25": "sample string 53",
"FreeTextField26": "sample string 54",
"FreeTextField27": "sample string 55",
"FreeTextField28": "sample string 56",
"FreeTextField29": "sample string 57",
"FreeTextField30": "sample string 58",
"FreeDateField1": "2025-12-25T17:00:10.8506183+01:00",
"FreeDateField2": "2025-12-25T17:00:10.8506183+01:00",
"FreeDateField3": "2025-12-25T17:00:10.8506183+01:00",
"FreeDateField4": "2025-12-25T17:00:10.8506183+01:00",
"FreeDecimalField1": 1.0,
"FreeDecimalField2": 1.0,
"FreeDecimalField3": 1.0,
"FreeDecimalField4": 1.0,
"FreeBoolField1": true,
"FreeBoolField2": true,
"FreeBoolField3": true,
"FreeBoolField4": true,
"History": "sample string 59",
"SurveyContacts": [
{
"ContactID": "d9732bc8-f0ec-48a2-a576-bf0046439e98",
"Contact": "sample string 2",
"ContactType": "sample string 3"
},
{
"ContactID": "d9732bc8-f0ec-48a2-a576-bf0046439e98",
"Contact": "sample string 2",
"ContactType": "sample string 3"
}
],
"SurveyBatchID": "d06affb4-1ad7-4ebd-bff1-748c98953fe7",
"CallbackTypeID": "4d7b56db-7b43-4d95-a1e8-bd1939bdc7f5",
"StatusID": "9a4bcf8d-7b77-43ae-9a7b-6163a41e4067",
"LanguageID": "ce60ce2c-77e9-4a2e-965b-4125593ee7a5"
},
{
"SurveyID": "f09e1fc8-4c0b-4fba-b444-eb4825ceff6f",
"ExtSurveyID": "sample string 2",
"Created": "2025-12-25T17:00:10.8486314+01:00",
"Sent": "2025-12-25T17:00:10.8486314+01:00",
"Completed": "2025-12-25T17:00:10.8486314+01:00",
"CustomerID": "sample string 3",
"Lastname": "sample string 4",
"Firstname": "sample string 5",
"Preposition": "sample string 6",
"Initials": "sample string 7",
"Sex": "sample string 8",
"Street": "sample string 9",
"Housenumber": "sample string 10",
"HousenumberExt": "sample string 11",
"Zipcode": "sample string 12",
"City": "sample string 13",
"Country": "sample string 14",
"OrderID": "sample string 15",
"OrderSubID": "sample string 16",
"OrderProduct": "sample string 17",
"OrderProductGroup": "sample string 18",
"OrderProductType": "sample string 19",
"OrderRemarks": "sample string 20",
"OrderChannel": "sample string 21",
"OrderType": "sample string 22",
"OrderEmployee": "sample string 23",
"OrderExecutive": "sample string 24",
"OrderExecutiveType": "sample string 25",
"OrderCreated": "2025-12-25T17:00:10.8496188+01:00",
"OrderStarted": "2025-12-25T17:00:10.8496188+01:00",
"OrderCompleted": "2025-12-25T17:00:10.8496188+01:00",
"CallbackRequest": true,
"CallbackComplained": "sample string 27",
"CallbackOpened": "2025-12-25T17:00:10.8496188+01:00",
"CallbackCreated": "2025-12-25T17:00:10.8496188+01:00",
"CallbackCompleted": "2025-12-25T17:00:10.8496188+01:00",
"CallbackRemarks": "sample string 28",
"FreeTextField1": "sample string 29",
"FreeTextField2": "sample string 30",
"FreeTextField3": "sample string 31",
"FreeTextField4": "sample string 32",
"FreeTextField5": "sample string 33",
"FreeTextField6": "sample string 34",
"FreeTextField7": "sample string 35",
"FreeTextField8": "sample string 36",
"FreeTextField9": "sample string 37",
"FreeTextField10": "sample string 38",
"FreeTextField11": "sample string 39",
"FreeTextField12": "sample string 40",
"FreeTextField13": "sample string 41",
"FreeTextField14": "sample string 42",
"FreeTextField15": "sample string 43",
"FreeTextField16": "sample string 44",
"FreeTextField17": "sample string 45",
"FreeTextField18": "sample string 46",
"FreeTextField19": "sample string 47",
"FreeTextField20": "sample string 48",
"FreeTextField21": "sample string 49",
"FreeTextField22": "sample string 50",
"FreeTextField23": "sample string 51",
"FreeTextField24": "sample string 52",
"FreeTextField25": "sample string 53",
"FreeTextField26": "sample string 54",
"FreeTextField27": "sample string 55",
"FreeTextField28": "sample string 56",
"FreeTextField29": "sample string 57",
"FreeTextField30": "sample string 58",
"FreeDateField1": "2025-12-25T17:00:10.8506183+01:00",
"FreeDateField2": "2025-12-25T17:00:10.8506183+01:00",
"FreeDateField3": "2025-12-25T17:00:10.8506183+01:00",
"FreeDateField4": "2025-12-25T17:00:10.8506183+01:00",
"FreeDecimalField1": 1.0,
"FreeDecimalField2": 1.0,
"FreeDecimalField3": 1.0,
"FreeDecimalField4": 1.0,
"FreeBoolField1": true,
"FreeBoolField2": true,
"FreeBoolField3": true,
"FreeBoolField4": true,
"History": "sample string 59",
"SurveyContacts": [
{
"ContactID": "d9732bc8-f0ec-48a2-a576-bf0046439e98",
"Contact": "sample string 2",
"ContactType": "sample string 3"
},
{
"ContactID": "d9732bc8-f0ec-48a2-a576-bf0046439e98",
"Contact": "sample string 2",
"ContactType": "sample string 3"
}
],
"SurveyBatchID": "d06affb4-1ad7-4ebd-bff1-748c98953fe7",
"CallbackTypeID": "4d7b56db-7b43-4d95-a1e8-bd1939bdc7f5",
"StatusID": "9a4bcf8d-7b77-43ae-9a7b-6163a41e4067",
"LanguageID": "ce60ce2c-77e9-4a2e-965b-4125593ee7a5"
}
],
"createwithoutvalidcontacts": true
}
application/xml, text/xml
Sample:
<ApiSurvey xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaaS_3WA_Shared.Viewmodels">
<createwithoutvalidcontacts>true</createwithoutvalidcontacts>
<jobid>f1cdb33c-8cbe-4741-abc3-98477e9974ba</jobid>
<records>
<ApiSurveyRecord>
<CallbackComplained>sample string 27</CallbackComplained>
<CallbackCompleted>2025-12-25T17:00:10.8496188+01:00</CallbackCompleted>
<CallbackCreated>2025-12-25T17:00:10.8496188+01:00</CallbackCreated>
<CallbackOpened>2025-12-25T17:00:10.8496188+01:00</CallbackOpened>
<CallbackRemarks>sample string 28</CallbackRemarks>
<CallbackRequest>true</CallbackRequest>
<CallbackTypeID>4d7b56db-7b43-4d95-a1e8-bd1939bdc7f5</CallbackTypeID>
<City>sample string 13</City>
<Completed>2025-12-25T17:00:10.8486314+01:00</Completed>
<Country>sample string 14</Country>
<Created>2025-12-25T17:00:10.8486314+01:00</Created>
<CustomerID>sample string 3</CustomerID>
<ExtSurveyID>sample string 2</ExtSurveyID>
<Firstname>sample string 5</Firstname>
<FreeBoolField1>true</FreeBoolField1>
<FreeBoolField2>true</FreeBoolField2>
<FreeBoolField3>true</FreeBoolField3>
<FreeBoolField4>true</FreeBoolField4>
<FreeDateField1>2025-12-25T17:00:10.8506183+01:00</FreeDateField1>
<FreeDateField2>2025-12-25T17:00:10.8506183+01:00</FreeDateField2>
<FreeDateField3>2025-12-25T17:00:10.8506183+01:00</FreeDateField3>
<FreeDateField4>2025-12-25T17:00:10.8506183+01:00</FreeDateField4>
<FreeDecimalField1>1</FreeDecimalField1>
<FreeDecimalField2>1</FreeDecimalField2>
<FreeDecimalField3>1</FreeDecimalField3>
<FreeDecimalField4>1</FreeDecimalField4>
<FreeTextField1>sample string 29</FreeTextField1>
<FreeTextField10>sample string 38</FreeTextField10>
<FreeTextField11>sample string 39</FreeTextField11>
<FreeTextField12>sample string 40</FreeTextField12>
<FreeTextField13>sample string 41</FreeTextField13>
<FreeTextField14>sample string 42</FreeTextField14>
<FreeTextField15>sample string 43</FreeTextField15>
<FreeTextField16>sample string 44</FreeTextField16>
<FreeTextField17>sample string 45</FreeTextField17>
<FreeTextField18>sample string 46</FreeTextField18>
<FreeTextField19>sample string 47</FreeTextField19>
<FreeTextField2>sample string 30</FreeTextField2>
<FreeTextField20>sample string 48</FreeTextField20>
<FreeTextField21>sample string 49</FreeTextField21>
<FreeTextField22>sample string 50</FreeTextField22>
<FreeTextField23>sample string 51</FreeTextField23>
<FreeTextField24>sample string 52</FreeTextField24>
<FreeTextField25>sample string 53</FreeTextField25>
<FreeTextField26>sample string 54</FreeTextField26>
<FreeTextField27>sample string 55</FreeTextField27>
<FreeTextField28>sample string 56</FreeTextField28>
<FreeTextField29>sample string 57</FreeTextField29>
<FreeTextField3>sample string 31</FreeTextField3>
<FreeTextField30>sample string 58</FreeTextField30>
<FreeTextField4>sample string 32</FreeTextField4>
<FreeTextField5>sample string 33</FreeTextField5>
<FreeTextField6>sample string 34</FreeTextField6>
<FreeTextField7>sample string 35</FreeTextField7>
<FreeTextField8>sample string 36</FreeTextField8>
<FreeTextField9>sample string 37</FreeTextField9>
<History>sample string 59</History>
<Housenumber>sample string 10</Housenumber>
<HousenumberExt>sample string 11</HousenumberExt>
<Initials>sample string 7</Initials>
<LanguageID>ce60ce2c-77e9-4a2e-965b-4125593ee7a5</LanguageID>
<Lastname>sample string 4</Lastname>
<OrderChannel>sample string 21</OrderChannel>
<OrderCompleted>2025-12-25T17:00:10.8496188+01:00</OrderCompleted>
<OrderCreated>2025-12-25T17:00:10.8496188+01:00</OrderCreated>
<OrderEmployee>sample string 23</OrderEmployee>
<OrderExecutive>sample string 24</OrderExecutive>
<OrderExecutiveType>sample string 25</OrderExecutiveType>
<OrderID>sample string 15</OrderID>
<OrderProduct>sample string 17</OrderProduct>
<OrderProductGroup>sample string 18</OrderProductGroup>
<OrderProductType>sample string 19</OrderProductType>
<OrderRemarks>sample string 20</OrderRemarks>
<OrderStarted>2025-12-25T17:00:10.8496188+01:00</OrderStarted>
<OrderSubID>sample string 16</OrderSubID>
<OrderType>sample string 22</OrderType>
<Preposition>sample string 6</Preposition>
<Sent>2025-12-25T17:00:10.8486314+01:00</Sent>
<Sex>sample string 8</Sex>
<StatusID>9a4bcf8d-7b77-43ae-9a7b-6163a41e4067</StatusID>
<Street>sample string 9</Street>
<SurveyBatchID>d06affb4-1ad7-4ebd-bff1-748c98953fe7</SurveyBatchID>
<SurveyContacts>
<ApiSurveyContact>
<Contact>sample string 2</Contact>
<ContactID>d9732bc8-f0ec-48a2-a576-bf0046439e98</ContactID>
<ContactType>sample string 3</ContactType>
</ApiSurveyContact>
<ApiSurveyContact>
<Contact>sample string 2</Contact>
<ContactID>d9732bc8-f0ec-48a2-a576-bf0046439e98</ContactID>
<ContactType>sample string 3</ContactType>
</ApiSurveyContact>
</SurveyContacts>
<SurveyID>f09e1fc8-4c0b-4fba-b444-eb4825ceff6f</SurveyID>
<Zipcode>sample string 12</Zipcode>
</ApiSurveyRecord>
<ApiSurveyRecord>
<CallbackComplained>sample string 27</CallbackComplained>
<CallbackCompleted>2025-12-25T17:00:10.8496188+01:00</CallbackCompleted>
<CallbackCreated>2025-12-25T17:00:10.8496188+01:00</CallbackCreated>
<CallbackOpened>2025-12-25T17:00:10.8496188+01:00</CallbackOpened>
<CallbackRemarks>sample string 28</CallbackRemarks>
<CallbackRequest>true</CallbackRequest>
<CallbackTypeID>4d7b56db-7b43-4d95-a1e8-bd1939bdc7f5</CallbackTypeID>
<City>sample string 13</City>
<Completed>2025-12-25T17:00:10.8486314+01:00</Completed>
<Country>sample string 14</Country>
<Created>2025-12-25T17:00:10.8486314+01:00</Created>
<CustomerID>sample string 3</CustomerID>
<ExtSurveyID>sample string 2</ExtSurveyID>
<Firstname>sample string 5</Firstname>
<FreeBoolField1>true</FreeBoolField1>
<FreeBoolField2>true</FreeBoolField2>
<FreeBoolField3>true</FreeBoolField3>
<FreeBoolField4>true</FreeBoolField4>
<FreeDateField1>2025-12-25T17:00:10.8506183+01:00</FreeDateField1>
<FreeDateField2>2025-12-25T17:00:10.8506183+01:00</FreeDateField2>
<FreeDateField3>2025-12-25T17:00:10.8506183+01:00</FreeDateField3>
<FreeDateField4>2025-12-25T17:00:10.8506183+01:00</FreeDateField4>
<FreeDecimalField1>1</FreeDecimalField1>
<FreeDecimalField2>1</FreeDecimalField2>
<FreeDecimalField3>1</FreeDecimalField3>
<FreeDecimalField4>1</FreeDecimalField4>
<FreeTextField1>sample string 29</FreeTextField1>
<FreeTextField10>sample string 38</FreeTextField10>
<FreeTextField11>sample string 39</FreeTextField11>
<FreeTextField12>sample string 40</FreeTextField12>
<FreeTextField13>sample string 41</FreeTextField13>
<FreeTextField14>sample string 42</FreeTextField14>
<FreeTextField15>sample string 43</FreeTextField15>
<FreeTextField16>sample string 44</FreeTextField16>
<FreeTextField17>sample string 45</FreeTextField17>
<FreeTextField18>sample string 46</FreeTextField18>
<FreeTextField19>sample string 47</FreeTextField19>
<FreeTextField2>sample string 30</FreeTextField2>
<FreeTextField20>sample string 48</FreeTextField20>
<FreeTextField21>sample string 49</FreeTextField21>
<FreeTextField22>sample string 50</FreeTextField22>
<FreeTextField23>sample string 51</FreeTextField23>
<FreeTextField24>sample string 52</FreeTextField24>
<FreeTextField25>sample string 53</FreeTextField25>
<FreeTextField26>sample string 54</FreeTextField26>
<FreeTextField27>sample string 55</FreeTextField27>
<FreeTextField28>sample string 56</FreeTextField28>
<FreeTextField29>sample string 57</FreeTextField29>
<FreeTextField3>sample string 31</FreeTextField3>
<FreeTextField30>sample string 58</FreeTextField30>
<FreeTextField4>sample string 32</FreeTextField4>
<FreeTextField5>sample string 33</FreeTextField5>
<FreeTextField6>sample string 34</FreeTextField6>
<FreeTextField7>sample string 35</FreeTextField7>
<FreeTextField8>sample string 36</FreeTextField8>
<FreeTextField9>sample string 37</FreeTextField9>
<History>sample string 59</History>
<Housenumber>sample string 10</Housenumber>
<HousenumberExt>sample string 11</HousenumberExt>
<Initials>sample string 7</Initials>
<LanguageID>ce60ce2c-77e9-4a2e-965b-4125593ee7a5</LanguageID>
<Lastname>sample string 4</Lastname>
<OrderChannel>sample string 21</OrderChannel>
<OrderCompleted>2025-12-25T17:00:10.8496188+01:00</OrderCompleted>
<OrderCreated>2025-12-25T17:00:10.8496188+01:00</OrderCreated>
<OrderEmployee>sample string 23</OrderEmployee>
<OrderExecutive>sample string 24</OrderExecutive>
<OrderExecutiveType>sample string 25</OrderExecutiveType>
<OrderID>sample string 15</OrderID>
<OrderProduct>sample string 17</OrderProduct>
<OrderProductGroup>sample string 18</OrderProductGroup>
<OrderProductType>sample string 19</OrderProductType>
<OrderRemarks>sample string 20</OrderRemarks>
<OrderStarted>2025-12-25T17:00:10.8496188+01:00</OrderStarted>
<OrderSubID>sample string 16</OrderSubID>
<OrderType>sample string 22</OrderType>
<Preposition>sample string 6</Preposition>
<Sent>2025-12-25T17:00:10.8486314+01:00</Sent>
<Sex>sample string 8</Sex>
<StatusID>9a4bcf8d-7b77-43ae-9a7b-6163a41e4067</StatusID>
<Street>sample string 9</Street>
<SurveyBatchID>d06affb4-1ad7-4ebd-bff1-748c98953fe7</SurveyBatchID>
<SurveyContacts>
<ApiSurveyContact>
<Contact>sample string 2</Contact>
<ContactID>d9732bc8-f0ec-48a2-a576-bf0046439e98</ContactID>
<ContactType>sample string 3</ContactType>
</ApiSurveyContact>
<ApiSurveyContact>
<Contact>sample string 2</Contact>
<ContactID>d9732bc8-f0ec-48a2-a576-bf0046439e98</ContactID>
<ContactType>sample string 3</ContactType>
</ApiSurveyContact>
</SurveyContacts>
<SurveyID>f09e1fc8-4c0b-4fba-b444-eb4825ceff6f</SurveyID>
<Zipcode>sample string 12</Zipcode>
</ApiSurveyRecord>
</records>
<servicetenantid>0268bfdd-f941-4ce2-be2c-28897d371b70</servicetenantid>
</ApiSurvey>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
booleanResponse Formats
application/json, text/json
Sample:
true
application/xml, text/xml
Sample:
<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>