1. v3
  2. Panelist
  3. POST - webhooks/event/panelist/optout

Definition

POST - webhooks/event/Panelist/Optout

Occurs when a Panelist doesn't want to receive survey invitations anymore.

Required roles: Contacts (read)

Response information


Contact

The contact who has choosen not to receive any emails from you anymore.


Type OptOut
WebhookId

The id of the webhook which triggered this request


Type integer
EventName

The EventName which triggered this request


Type string
Links

HATEOAS related to this object. It wil contain relevant url's such as previous and next page for paged results, create/update/delete action. These url's can be used in your application for the next steps in your application logic.


Type Hateoas

Sample: 
{
  "Contact": {
    "DateOptOut": "2024-11-21T14:25:25.5787718Z",
    "SurveyParticipation": "sample string 2",
    "OptoutSourceId": 64,
    "LangCode": "en",
    "Surveys": [
      {
        "SurveyId": 2,
        "Title": "sample string 3",
        "PanelistStatusId": 4,
        "DateAdded": "2024-11-21T14:25:25.5787718Z",
        "PanelistReportUrl": "sample string 5"
      },
      {
        "SurveyId": 2,
        "Title": "sample string 3",
        "PanelistStatusId": 4,
        "DateAdded": "2024-11-21T14:25:25.5787718Z",
        "PanelistReportUrl": "sample string 5"
      }
    ],
    "Groups": [
      {
        "GroupId": 2,
        "Name": "sample string 3"
      },
      {
        "GroupId": 2,
        "Name": "sample string 3"
      }
    ],
    "ContactId": 3,
    "FirstName": "John",
    "LastName": "Doe",
    "Email": "john.doe@mail.com",
    "CustomField1": "sample string 4",
    "CustomField2": "sample string 5",
    "CustomField3": "sample string 6",
    "CustomField4": "sample string 7",
    "CustomField5": "sample string 8",
    "CustomField6": "sample string 9",
    "CustomField7": "sample string 10",
    "CustomField8": "sample string 11",
    "CustomField9": "sample string 12",
    "CustomField10": "sample string 13",
    "CustomField11": "sample string 14",
    "CustomField12": "sample string 15",
    "CustomField13": "sample string 16",
    "CustomField14": "sample string 17",
    "CustomField15": "sample string 18",
    "CustomField16": "sample string 19",
    "CustomField17": "sample string 20",
    "CustomField18": "sample string 21",
    "CustomField19": "sample string 22",
    "CustomField20": "sample string 23",
    "Street": "Main Street",
    "HouseNumber": "123",
    "Suite": "B",
    "PostalCode": "98765-4321",
    "City": "Anytown",
    "State": "CA",
    "Province": "Orange County",
    "Phone": "+1-202-555-0117",
    "CountryId": "US",
    "Gender": "M",
    "DateOfBirth": "2024-11-21T14:25:25.5787718Z",
    "IsBounced": true,
    "IsOptedOut": true
  },
  "WebhookId": 1,
  "EventName": "sample string 2"
}
Sample: 
<OptoutResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" z:Id="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/">
  <EventName>sample string 2</EventName>
  <WebhookId>1</WebhookId>
  <Contact z:Id="i2">
    <Groups>
      <GroupReference>
        <GroupId>2</GroupId>
        <Name>sample string 3</Name>
      </GroupReference>
      <GroupReference>
        <GroupId>2</GroupId>
        <Name>sample string 3</Name>
      </GroupReference>
    </Groups>
    <LangCode>en</LangCode>
    <Surveys>
      <SurveyReference z:Id="i3">
        <DateAdded>2024-11-21T14:25:25.5787718+00:00</DateAdded>
        <PanelistReportUrl>sample string 5</PanelistReportUrl>
        <PanelistStatusId>4</PanelistStatusId>
        <SurveyId>2</SurveyId>
        <Title>sample string 3</Title>
      </SurveyReference>
      <SurveyReference z:Ref="i3" />
    </Surveys>
    <ContactId>3</ContactId>
    <FirstName>John</FirstName>
    <LastName>Doe</LastName>
    <Email>john.doe@mail.com</Email>
    <CustomField1>sample string 4</CustomField1>
    <CustomField2>sample string 5</CustomField2>
    <CustomField3>sample string 6</CustomField3>
    <CustomField4>sample string 7</CustomField4>
    <CustomField5>sample string 8</CustomField5>
    <CustomField6>sample string 9</CustomField6>
    <CustomField7>sample string 10</CustomField7>
    <CustomField8>sample string 11</CustomField8>
    <CustomField9>sample string 12</CustomField9>
    <CustomField10>sample string 13</CustomField10>
    <CustomField11>sample string 14</CustomField11>
    <CustomField12>sample string 15</CustomField12>
    <CustomField13>sample string 16</CustomField13>
    <CustomField14>sample string 17</CustomField14>
    <CustomField15>sample string 18</CustomField15>
    <CustomField16>sample string 19</CustomField16>
    <CustomField17>sample string 20</CustomField17>
    <CustomField18>sample string 21</CustomField18>
    <CustomField19>sample string 22</CustomField19>
    <CustomField20>sample string 23</CustomField20>
    <Street>Main Street</Street>
    <HouseNumber>123</HouseNumber>
    <Suite>B</Suite>
    <PostalCode>98765-4321</PostalCode>
    <City>Anytown</City>
    <State>CA</State>
    <Province>Orange County</Province>
    <Phone>+1-202-555-0117</Phone>
    <CountryId>US</CountryId>
    <Gender>M</Gender>
    <DateOfBirth>2024-11-21T14:25:25.5787718+00:00</DateOfBirth>
    <IsBounced>true</IsBounced>
    <IsOptedOut>true</IsOptedOut>
    <DateOptOut>2024-11-21T14:25:25.5787718+00:00</DateOptOut>
    <OptoutSourceId>64</OptoutSourceId>
    <SurveyParticipation>sample string 2</SurveyParticipation>
  </Contact>
</OptoutResult>