Create Helpfulness Response Types REST Endpoint

POST api/v2/articles/helpfulness/responsetypes/{collectionid}.{json|xml}

Scopes

Article Collections › Modify Helpfulness Response Types articlecollections.helpfulnessresponsetypes.modify

Request Parameters

Name Type Location Description Required Default Options
CollectionId Guid Request Body Id of the collection to create the helpfulness response option in. Required
Name string Request Body Helpfulness response option message.. Required
RequireMessage bool Request Body If true, when this type is specified as a response message is also required. Optional

Example Requests

Widget Javascript

jQuery.telligent.evolution.post({
	url: jQuery.telligent.evolution.site.getBaseUrl() + 'api/v2/articles/helpfulness/responsetypes/{collectionid}.json',
	data: {
		'collectionid': '49fec544-6df7-4a82-872b-f8be586d5e9e',
		'Name': 'name'
	}
}).then(function(response) {
	// use response
});

Example Responses

JSON

{
  "HelpfulnessResponseTypes": {"Id":6,"RequireMessage":true,"Name":"name","CreateDate":"2012-01-04T00:00:00","User":{"AvatarUrl":"avatarurl","DisplayName":"displayname","ProfileUrl":"profileurl","Username":"username","CurrentStatus":{"Author":{"AvatarUrl":"avatarurl","DisplayName":"displayname","ProfileUrl":"profileurl","Username":"username","CurrentStatus":{"Author":{"AvatarUrl":"avatarurl","DisplayName":"displayname","ProfileUrl":"profileurl","Username":"username","CurrentStatus":null,"Id":null},"Body":"body","CreatedDate":"2012-05-02T00:00:00","ReplyCount":25,"Group":{"AvatarUrl":"avatarurl","DateCreated":null,"Description":"description","Key":"key","Name":"name","ParentGroupId":null,"Url":"url","TotalMembers":null,"HasGroups":true,"GroupCount":null,"GroupType":"grouptype","EnableGroupMessages":true,"EnableContact":true,"SearchUniqueId":"searchuniqueid","IsEnabled":true,"ExtendedAttributes":[],"ContainerId":"49fec544-6df7-4a82-872b-f8be586d5e9e","ContainerTypeId":"23b05a61-c3e5-4451-90d9-bfa00453bce4","Container":null,"Id":null},"AttachedUrl":"attachedurl","HasReplies":true,"Replies":[],"ContentId":"9ba1ec43-dc34-4e27-a579-4a0855144e2f","ContentType":"56f1a3ec-14bb-45c6-949f-ee7776d68c78","Url":"url","IsPublished":true,"Content":{"CreatedByUser":null,"ContentId":"2d525bad-c4df-470d-a193-a1c6d66e5c3e","ContentTypeId":"bd519379-b61f-4e2f-b0f9-c0f28c5cceb1","CreatedDate":"2012-06-04T00:00:00","HtmlName":"htmlname","HtmlDescription":"htmldescription","Url":"url","AvatarUrl":"avatarurl","Application":null},"Id":"9ba1ec43-dc34-4e27-a579-4a0855144e2f"},"Id":8},"Body":"body","CreatedDate":"2011-05-28T00:00:00","ReplyCount":4,"Group":{"AvatarUrl":"avatarurl","DateCreated":"2011-12-09T00:00:00","Description":"description","Key":"key","Name":"name","ParentGroupId":7,"Url":"url","TotalMembers":27,"HasGroups":true,"GroupCount":32,"GroupType":"grouptype","EnableGroupMessages":true,"EnableContact":true,"SearchUniqueId":"searchuniqueid","IsEnabled":true,"ExtendedAttributes":[{"Key":"key","Value":"value"},{"Key":"key","Value":"value"}],"ContainerId":"e3715662-2528-4ba1-84a7-bfcd9d548f80","ContainerTypeId":"23b05a61-c3e5-4451-90d9-bfa00453bce4","Container":{"ContainerId":"6cdcf200-3bad-476d-af45-97b52545c337","ContainerTypeId":"b04540ec-eb38-4fa1-b7bb-e3fde05401b4","HtmlName":"htmlname","Url":"url","AvatarUrl":"avatarurl"},"Id":52},"AttachedUrl":"attachedurl","HasReplies":true,"Replies":[],"ContentId":"44df201a-07e6-42eb-96c7-8ce7ce35aab6","ContentType":"56f1a3ec-14bb-45c6-949f-ee7776d68c78","Url":"url","IsPublished":true,"Content":{"CreatedByUser":{"AvatarUrl":"avatarurl","DisplayName":"displayname","ProfileUrl":"profileurl","Username":"username","CurrentStatus":{"Author":null,"Body":"body","CreatedDate":null,"ReplyCount":19,"Group":null,"AttachedUrl":"attachedurl","HasReplies":null,"Replies":[],"ContentId":"9f5a6721-639d-4e1d-ab6a-ce63b7750f46","ContentType":"56f1a3ec-14bb-45c6-949f-ee7776d68c78","Url":"url","IsPublished":true,"Content":null,"Id":"9f5a6721-639d-4e1d-ab6a-ce63b7750f46"},"Id":112},"ContentId":"2d525bad-c4df-470d-a193-a1c6d66e5c3e","ContentTypeId":"bd519379-b61f-4e2f-b0f9-c0f28c5cceb1","CreatedDate":"2012-03-29T00:00:00","HtmlName":"htmlname","HtmlDescription":"htmldescription","Url":"url","AvatarUrl":"avatarurl","Application":{"ApplicationId":"9ba1ec43-dc34-4e27-a579-4a0855144e2f","ApplicationTypeId":"e3715662-2528-4ba1-84a7-bfcd9d548f80","HtmlName":"htmlname","HtmlDescription":"htmldescription","Url":"url","AvatarUrl":"avatarurl","Container":{"ContainerId":"6cdcf200-3bad-476d-af45-97b52545c337","ContainerTypeId":"b04540ec-eb38-4fa1-b7bb-e3fde05401b4","HtmlName":"htmlname","Url":"url","AvatarUrl":"avatarurl"}}},"Id":"44df201a-07e6-42eb-96c7-8ce7ce35aab6"},"Id":61},"ArticleCollection":{"Id":"49fec544-6df7-4a82-872b-f8be586d5e9e","EnableHelpfulness":true,"Name":"name","UrlKey":"urlkey","Description":"description","CreateDate":null,"Group":{"AvatarUrl":"avatarurl","DateCreated":"2012-04-19T00:00:00","Description":"description","Key":"key","Name":"name","ParentGroupId":18,"Url":"url","TotalMembers":76,"HasGroups":true,"GroupCount":6,"GroupType":"grouptype","EnableGroupMessages":true,"EnableContact":true,"SearchUniqueId":"searchuniqueid","IsEnabled":true,"ExtendedAttributes":[{"Key":"key","Value":"value"},{"Key":"key","Value":"value"}],"ContainerId":"9f5a6721-639d-4e1d-ab6a-ce63b7750f46","ContainerTypeId":"23b05a61-c3e5-4451-90d9-bfa00453bce4","Container":{"ContainerId":"fe65240b-044c-4292-9946-f10e0361ecff","ContainerTypeId":"2d525bad-c4df-470d-a193-a1c6d66e5c3e","HtmlName":"htmlname","Url":"url","AvatarUrl":"avatarurl"},"Id":25},"Url":"url","CreatedBy":{"AvatarUrl":"avatarurl","DisplayName":"displayname","ProfileUrl":"profileurl","Username":"username","CurrentStatus":{"Author":{"AvatarUrl":"avatarurl","DisplayName":"displayname","ProfileUrl":"profileurl","Username":"username","CurrentStatus":{"Author":null,"Body":"body","CreatedDate":null,"ReplyCount":8,"Group":null,"AttachedUrl":"attachedurl","HasReplies":null,"Replies":[],"ContentId":"bd519379-b61f-4e2f-b0f9-c0f28c5cceb1","ContentType":"56f1a3ec-14bb-45c6-949f-ee7776d68c78","Url":"url","IsPublished":true,"Content":null,"Id":"bd519379-b61f-4e2f-b0f9-c0f28c5cceb1"},"Id":4},"Body":"body","CreatedDate":"2012-01-16T00:00:00","ReplyCount":7,"Group":{"AvatarUrl":"avatarurl","DateCreated":"2012-01-04T00:00:00","Description":"description","Key":"key","Name":"name","ParentGroupId":27,"Url":"url","TotalMembers":32,"HasGroups":true,"GroupCount":52,"GroupType":"grouptype","EnableGroupMessages":true,"EnableContact":true,"SearchUniqueId":"searchuniqueid","IsEnabled":true,"ExtendedAttributes":[],"ContainerId":"e3715662-2528-4ba1-84a7-bfcd9d548f80","ContainerTypeId":"23b05a61-c3e5-4451-90d9-bfa00453bce4","Container":{"ContainerId":"6cdcf200-3bad-476d-af45-97b52545c337","ContainerTypeId":"b04540ec-eb38-4fa1-b7bb-e3fde05401b4","HtmlName":"htmlname","Url":"url","AvatarUrl":"avatarurl"},"Id":19},"AttachedUrl":"attachedurl","HasReplies":true,"Replies":[],"ContentId":"9ba1ec43-dc34-4e27-a579-4a0855144e2f","ContentType":"56f1a3ec-14bb-45c6-949f-ee7776d68c78","Url":"url","IsPublished":true,"Content":{"CreatedByUser":{"AvatarUrl":"avatarurl","DisplayName":"displayname","ProfileUrl":"profileurl","Username":"username","CurrentStatus":null,"Id":null},"ContentId":"9f5a6721-639d-4e1d-ab6a-ce63b7750f46","ContentTypeId":"fe65240b-044c-4292-9946-f10e0361ecff","CreatedDate":"2012-05-02T00:00:00","HtmlName":"htmlname","HtmlDescription":"htmldescription","Url":"url","AvatarUrl":"avatarurl","Application":{"ApplicationId":"2d525bad-c4df-470d-a193-a1c6d66e5c3e","ApplicationTypeId":"bd519379-b61f-4e2f-b0f9-c0f28c5cceb1","HtmlName":"htmlname","HtmlDescription":"htmldescription","Url":"url","AvatarUrl":"avatarurl","Container":null}},"Id":"9ba1ec43-dc34-4e27-a579-4a0855144e2f"},"Id":112},"Prefix":"prefix","DefaultType":{"Id":61,"Name":"name","ImageUrl":"imageurl"},"DefaultArticleId":"e3715662-2528-4ba1-84a7-bfcd9d548f80","ThemeId":"6cdcf200-3bad-476d-af45-97b52545c337"}},
  "Errors": ["string","string"]
}

XML

<?xml version="1.0" encoding="utf-16"?>
<Response>
  <HelpfulnessResponseTypes>
    <Id>6</Id>
    <RequireMessage>true</RequireMessage>
    <Name>name</Name>
    <CreateDate>2012-01-04T00:00:00</CreateDate>
    <User>
      <Id>61</Id>
      <AvatarUrl>avatarurl</AvatarUrl>
      <DisplayName>displayname</DisplayName>
      <ProfileUrl>profileurl</ProfileUrl>
      <Username>username</Username>
      <CurrentStatus>
        <Id>44df201a-07e6-42eb-96c7-8ce7ce35aab6</Id>
        <Author>
          <Id>8</Id>
          <AvatarUrl>avatarurl</AvatarUrl>
          <DisplayName>displayname</DisplayName>
          <ProfileUrl>profileurl</ProfileUrl>
          <Username>username</Username>
          <CurrentStatus>
            <Id>9ba1ec43-dc34-4e27-a579-4a0855144e2f</Id>
            <Author>
              <Id />
              <AvatarUrl>avatarurl</AvatarUrl>
              <DisplayName>displayname</DisplayName>
              <ProfileUrl>profileurl</ProfileUrl>
              <Username>username</Username>
            </Author>
            <Body>body</Body>
            <CreatedDate>2012-05-02T00:00:00</CreatedDate>
            <ReplyCount>25</ReplyCount>
            <Group>
              <Id />
              <AvatarUrl>avatarurl</AvatarUrl>
              <DateCreated />
              <Description>description</Description>
              <Key>key</Key>
              <Name>name</Name>
              <Url>url</Url>
              <TotalMembers />
              <HasGroups>true</HasGroups>
              <GroupCount />
              <GroupType>grouptype</GroupType>
              <EnableGroupMessages>true</EnableGroupMessages>
              <EnableContact>true</EnableContact>
              <SearchUniqueId>searchuniqueid</SearchUniqueId>
              <ExtendedAttributes />
              <ContainerId>49fec544-6df7-4a82-872b-f8be586d5e9e</ContainerId>
            </Group>
            <AttachedUrl>attachedurl</AttachedUrl>
            <HasReplies>true</HasReplies>
            <ContentId>9ba1ec43-dc34-4e27-a579-4a0855144e2f</ContentId>
            <ContentType>56f1a3ec-14bb-45c6-949f-ee7776d68c78</ContentType>
            <Url>url</Url>
            <IsPublished>true</IsPublished>
            <Content>
              <ContentId>2d525bad-c4df-470d-a193-a1c6d66e5c3e</ContentId>
              <ContentTypeId>bd519379-b61f-4e2f-b0f9-c0f28c5cceb1</ContentTypeId>
              <CreatedDate>2012-06-04T00:00:00</CreatedDate>
              <HtmlName>htmlname</HtmlName>
              <HtmlDescription>htmldescription</HtmlDescription>
              <Url>url</Url>
              <AvatarUrl>avatarurl</AvatarUrl>
            </Content>
          </CurrentStatus>
        </Author>
        <Body>body</Body>
        <CreatedDate>2011-05-28T00:00:00</CreatedDate>
        <ReplyCount>4</ReplyCount>
        <Group>
          <Id>52</Id>
          <AvatarUrl>avatarurl</AvatarUrl>
          <DateCreated>2011-12-09T00:00:00</DateCreated>
          <Description>description</Description>
          <Key>key</Key>
          <Name>name</Name>
          <ParentGroupId>7</ParentGroupId>
          <Url>url</Url>
          <TotalMembers>27</TotalMembers>
          <HasGroups>true</HasGroups>
          <GroupCount>32</GroupCount>
          <GroupType>grouptype</GroupType>
          <EnableGroupMessages>true</EnableGroupMessages>
          <EnableContact>true</EnableContact>
          <SearchUniqueId>searchuniqueid</SearchUniqueId>
          <ExtendedAttributes>
            <key>value</key>
            <key>value</key>
          </ExtendedAttributes>
          <ContainerId>e3715662-2528-4ba1-84a7-bfcd9d548f80</ContainerId>
          <Container>
            <ContainerId>6cdcf200-3bad-476d-af45-97b52545c337</ContainerId>
            <ContainerTypeId>b04540ec-eb38-4fa1-b7bb-e3fde05401b4</ContainerTypeId>
            <HtmlName>htmlname</HtmlName>
            <Url>url</Url>
            <AvatarUrl>avatarurl</AvatarUrl>
          </Container>
        </Group>
        <AttachedUrl>attachedurl</AttachedUrl>
        <HasReplies>true</HasReplies>
        <ContentId>44df201a-07e6-42eb-96c7-8ce7ce35aab6</ContentId>
        <ContentType>56f1a3ec-14bb-45c6-949f-ee7776d68c78</ContentType>
        <Url>url</Url>
        <IsPublished>true</IsPublished>
        <Content>
          <CreatedByUser>
            <Id>112</Id>
            <AvatarUrl>avatarurl</AvatarUrl>
            <DisplayName>displayname</DisplayName>
            <ProfileUrl>profileurl</ProfileUrl>
            <Username>username</Username>
            <CurrentStatus>
              <Id>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</Id>
              <Body>body</Body>
              <CreatedDate />
              <ReplyCount>19</ReplyCount>
              <AttachedUrl>attachedurl</AttachedUrl>
              <HasReplies />
              <ContentId>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</ContentId>
              <ContentType>56f1a3ec-14bb-45c6-949f-ee7776d68c78</ContentType>
              <Url>url</Url>
              <IsPublished>true</IsPublished>
            </CurrentStatus>
          </CreatedByUser>
          <ContentId>2d525bad-c4df-470d-a193-a1c6d66e5c3e</ContentId>
          <ContentTypeId>bd519379-b61f-4e2f-b0f9-c0f28c5cceb1</ContentTypeId>
          <CreatedDate>2012-03-29T00:00:00</CreatedDate>
          <HtmlName>htmlname</HtmlName>
          <HtmlDescription>htmldescription</HtmlDescription>
          <Url>url</Url>
          <AvatarUrl>avatarurl</AvatarUrl>
          <Application>
            <ApplicationId>9ba1ec43-dc34-4e27-a579-4a0855144e2f</ApplicationId>
            <ApplicationTypeId>e3715662-2528-4ba1-84a7-bfcd9d548f80</ApplicationTypeId>
            <HtmlName>htmlname</HtmlName>
            <HtmlDescription>htmldescription</HtmlDescription>
            <Url>url</Url>
            <AvatarUrl>avatarurl</AvatarUrl>
            <Container>
              <ContainerId>6cdcf200-3bad-476d-af45-97b52545c337</ContainerId>
              <ContainerTypeId>b04540ec-eb38-4fa1-b7bb-e3fde05401b4</ContainerTypeId>
              <HtmlName>htmlname</HtmlName>
              <Url>url</Url>
              <AvatarUrl>avatarurl</AvatarUrl>
            </Container>
          </Application>
        </Content>
      </CurrentStatus>
    </User>
    <ArticleCollection>
      <Id>49fec544-6df7-4a82-872b-f8be586d5e9e</Id>
      <EnableHelpfulness>true</EnableHelpfulness>
      <Name>name</Name>
      <UrlKey>urlkey</UrlKey>
      <Description>description</Description>
      <Group>
        <Id>25</Id>
        <AvatarUrl>avatarurl</AvatarUrl>
        <DateCreated>2012-04-19T00:00:00</DateCreated>
        <Description>description</Description>
        <Key>key</Key>
        <Name>name</Name>
        <ParentGroupId>18</ParentGroupId>
        <Url>url</Url>
        <TotalMembers>76</TotalMembers>
        <HasGroups>true</HasGroups>
        <GroupCount>6</GroupCount>
        <GroupType>grouptype</GroupType>
        <EnableGroupMessages>true</EnableGroupMessages>
        <EnableContact>true</EnableContact>
        <SearchUniqueId>searchuniqueid</SearchUniqueId>
        <ExtendedAttributes>
          <key>value</key>
          <key>value</key>
        </ExtendedAttributes>
        <ContainerId>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</ContainerId>
        <Container>
          <ContainerId>fe65240b-044c-4292-9946-f10e0361ecff</ContainerId>
          <ContainerTypeId>2d525bad-c4df-470d-a193-a1c6d66e5c3e</ContainerTypeId>
          <HtmlName>htmlname</HtmlName>
          <Url>url</Url>
          <AvatarUrl>avatarurl</AvatarUrl>
        </Container>
      </Group>
      <Url>url</Url>
      <CreatedBy>
        <Id>112</Id>
        <AvatarUrl>avatarurl</AvatarUrl>
        <DisplayName>displayname</DisplayName>
        <ProfileUrl>profileurl</ProfileUrl>
        <Username>username</Username>
        <CurrentStatus>
          <Id>9ba1ec43-dc34-4e27-a579-4a0855144e2f</Id>
          <Author>
            <Id>4</Id>
            <AvatarUrl>avatarurl</AvatarUrl>
            <DisplayName>displayname</DisplayName>
            <ProfileUrl>profileurl</ProfileUrl>
            <Username>username</Username>
            <CurrentStatus>
              <Id>bd519379-b61f-4e2f-b0f9-c0f28c5cceb1</Id>
              <Body>body</Body>
              <CreatedDate />
              <ReplyCount>8</ReplyCount>
              <AttachedUrl>attachedurl</AttachedUrl>
              <HasReplies />
              <ContentId>bd519379-b61f-4e2f-b0f9-c0f28c5cceb1</ContentId>
              <ContentType>56f1a3ec-14bb-45c6-949f-ee7776d68c78</ContentType>
              <Url>url</Url>
              <IsPublished>true</IsPublished>
            </CurrentStatus>
          </Author>
          <Body>body</Body>
          <CreatedDate>2012-01-16T00:00:00</CreatedDate>
          <ReplyCount>7</ReplyCount>
          <Group>
            <Id>19</Id>
            <AvatarUrl>avatarurl</AvatarUrl>
            <DateCreated>2012-01-04T00:00:00</DateCreated>
            <Description>description</Description>
            <Key>key</Key>
            <Name>name</Name>
            <ParentGroupId>27</ParentGroupId>
            <Url>url</Url>
            <TotalMembers>32</TotalMembers>
            <HasGroups>true</HasGroups>
            <GroupCount>52</GroupCount>
            <GroupType>grouptype</GroupType>
            <EnableGroupMessages>true</EnableGroupMessages>
            <EnableContact>true</EnableContact>
            <SearchUniqueId>searchuniqueid</SearchUniqueId>
            <ExtendedAttributes />
            <ContainerId>e3715662-2528-4ba1-84a7-bfcd9d548f80</ContainerId>
            <Container>
              <ContainerId>6cdcf200-3bad-476d-af45-97b52545c337</ContainerId>
              <ContainerTypeId>b04540ec-eb38-4fa1-b7bb-e3fde05401b4</ContainerTypeId>
              <HtmlName>htmlname</HtmlName>
              <Url>url</Url>
              <AvatarUrl>avatarurl</AvatarUrl>
            </Container>
          </Group>
          <AttachedUrl>attachedurl</AttachedUrl>
          <HasReplies>true</HasReplies>
          <ContentId>9ba1ec43-dc34-4e27-a579-4a0855144e2f</ContentId>
          <ContentType>56f1a3ec-14bb-45c6-949f-ee7776d68c78</ContentType>
          <Url>url</Url>
          <IsPublished>true</IsPublished>
          <Content>
            <CreatedByUser>
              <Id />
              <AvatarUrl>avatarurl</AvatarUrl>
              <DisplayName>displayname</DisplayName>
              <ProfileUrl>profileurl</ProfileUrl>
              <Username>username</Username>
            </CreatedByUser>
            <ContentId>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</ContentId>
            <ContentTypeId>fe65240b-044c-4292-9946-f10e0361ecff</ContentTypeId>
            <CreatedDate>2012-05-02T00:00:00</CreatedDate>
            <HtmlName>htmlname</HtmlName>
            <HtmlDescription>htmldescription</HtmlDescription>
            <Url>url</Url>
            <AvatarUrl>avatarurl</AvatarUrl>
            <Application>
              <ApplicationId>2d525bad-c4df-470d-a193-a1c6d66e5c3e</ApplicationId>
              <ApplicationTypeId>bd519379-b61f-4e2f-b0f9-c0f28c5cceb1</ApplicationTypeId>
              <HtmlName>htmlname</HtmlName>
              <HtmlDescription>htmldescription</HtmlDescription>
              <Url>url</Url>
              <AvatarUrl>avatarurl</AvatarUrl>
            </Application>
          </Content>
        </CurrentStatus>
      </CreatedBy>
      <Prefix>prefix</Prefix>
      <DefaultType>
        <Id>61</Id>
        <Name>name</Name>
        <ImageUrl>imageurl</ImageUrl>
      </DefaultType>
      <DefaultArticleId>e3715662-2528-4ba1-84a7-bfcd9d548f80</DefaultArticleId>
      <ThemeId>6cdcf200-3bad-476d-af45-97b52545c337</ThemeId>
    </ArticleCollection>
  </HelpfulnessResponseTypes>
  <Errors>
    <Message>string</Message>
    <Message>string</Message>
  </Errors>
</Response>
Related
Recommended

About
Privacy Policy
Terms of use
Copyright 2026 Verint, Inc.
Powered by Verint Community