Contents x
      Wrap-Up Field
      • 16 Jun 2022
      • 6 Minutes to read
      • Print
      • Dark
        Light
      Contents

      Wrap-Up Field

      • Updated on 16 Jun 2022
      • 6 Minutes to read
      • Print
      • Dark
        Light
      Article summary

      Wrap-Up Field

      You need the Manage Campaigns permission to manage Wrap-Up Form Field.

      Wrap-Up Field JSON Format

      Wrap-Up Field is represented as simple flat JSON objects with the following keys:

      NameTypeDescription
      idguidId of the wrap-up form field.
      campaignIdguidId of the campaign which the wrap-up form field belongs to.
      fieldIdguidId of the field which the wrap-up form field belongs to.
      labelstringLabel of the wrap-up form field.
      isVisibleboolWhether the wrap-up form field is visiable or not.
      isRequiredboolWhether the wrap-up form field is required or not.
      orderintegerOrder of the wrap-up form field.
      fieldfieldReference to Field.

      Get the list of Wrap-Up Fields

      GET livechat/wrapupFormFields

      • Parameters:

      NameTypeinRequiredDescription
      campaignIdguidquerynoId of the Campaign which the Wrap-Up Form Field belongs to.
      isSystemboolquerynoWhether the field is system field or not.
      includestringquerynoAllowed values are "field", "wrapupCategoryGroup".

      • Response:

      An array of Wrap-Up Field

      • Example

      Sample Request:

      curl https://api11.comm100.io/v4/livechat/wrapupFormFields \ 
    -X 'GET' \ 
    -H 'Authorization: Bearer {access_token}' \

      Response:

      HTTP/1.1 200 OK

      [
  {
      "id": "FCB01DA6-650C-495E-89E5-F3918CAB792B",
      "campaignId": "612E0EB3-F9A2-460D-B2D9-1A12E90B73B0",
      "fieldId": "D8F2C475-490C-4427-9C3D-535DE30B45DE",
      "label": "wrapup-text",
      "isVisible": true,
      "isRequired": false,
      "order": 0,
      "field": {
          "id": "a03cce30-f892-4286-8b7e-8e6c39cb4d19",
          "isSystem": false,
          "name": "Pre-textarea",
          "type": "radioBox",
          "leftText": "Highly unlikely",
          "rightText": "Highly likely",
          "fieldOptions": [
              {
                  "id": "314a02b2-cb4c-418f-b9bc-84fb4ad84254",
                  "fieldId": "ca092d3f-21eb-492f-9142-205101b1d08a",
                  "parentOptionId": "fa3e2d7b-cadb-47c1-ad7e-ef387907ec41",
                  "value": "Text 2",
                  "order": 0
              }
          ]
      }
  }
]

      Get a single Wrap-Up Field

      GET livechat/wrapupFormFields/{id}

      • Parameters:

      No Parameters

      • Response:

      Wrap-Up Field

      • Example

      Sample Request:

      curl https://api11.comm100.io/v4/livechat/wrapupFormFields/FCB01DA6-650C-495E-89E5-F3918CAB792B \ 
    -X 'GET' \ 
    -H 'Authorization: Bearer {access_token}' \

      Response:

      HTTP/1.1 200 OK

      {
  "id": "d268ba6a-6816-40cd-9cb2-e84ef4bed1fb",
  "campaignId": "9e7a73f1-06e3-475d-9ce1-d141f7011846",
  "fieldId": "fc2d8fb6-dbb2-4df4-9f42-653062505410",
  "label": "Category",
  "isVisible": true,
  "isRequired": true,
  "order": 0,
  "field": {
      "id": "fc2d8fb6-dbb2-4df4-9f42-653062505410",
      "isSystem": true,
      "name": "Category",
      "type": "category",
      "leftText": "",
      "rightText": "",
      "fieldOptions": []
  },
  "groups": [
      {
          "siteId": 10000,
          "name": "Gruop1",
          "order": 0,
          "createdTime": "2021-01-29T06:45:44.863Z",
          "isDeleted": false,
          "wrapupCategoryOptions": [
              {
                  "siteId": 10000,
                  "name": "option2",
                  "groupId": "13641ee8-68d1-48e9-89ba-acbf006f7124",
                  "order": 0,
                  "isDeleted": false,
                  "id": "2a22c15a-26fc-4dd0-9ed0-acbf006f7124"
              }
          ],
          "id": "13641ee8-68d1-48e9-89ba-acbf006f7124"
      }
  ]
}

      Create a new Wrap-Up Field

      POST livechat/wrapupFormFields

      • Parameters:

      NameTypeinRequiredDescription
      campaignIdguidbodynoId of the campaign which the wrap-up form field belongs to.
      fieldIdguidbodyyesId of the field which the wrap-up form field belongs to.
      labelstringbodyyesLabel of the wrap-up form field.
      isVisibleboolbodynoWhether the wrap-up form field is visiable or not.
      isRequiredboolbodynoWhether the wrap-up form field is required or not.
      orderintegerbodynoOrder of the wrap-up form field.

      • Response:

      Wrap-Up Field

      • Example

      Sample Request:

      curl https://api11.comm100.io/v4/livechat/wrapupFormFields \ 
    -X 'POST' \ 
    -H 'Authorization: Bearer {access_token}' \ 
    -H 'Content-Type: application/json' \ 
    -D '{"campaignId":"612E0EB3-F9A2-460D-B2D9-1A12E90B73B0","fieldId":"D8F2C475-490C-4427-9C3D-535DE30B45DE","label":"wrapup-text","isVisible":true,"isRequired":false,"order":0}'

      Response:

      HTTP/1.1 201 Created

      {
  "id": "FCB01DA6-650C-495E-89E5-F3918CAB792B",
  "campaignId": "612E0EB3-F9A2-460D-B2D9-1A12E90B73B0",
  "fieldId": "D8F2C475-490C-4427-9C3D-535DE30B45DE",
  "label": "wrapup-text",
  "isVisible": true,
  "isRequired": false,
  "order": 0,
  "field": {
      "id": "a03cce30-f892-4286-8b7e-8e6c39cb4d19",
      "isSystem": false,
      "name": "Pre-textarea",
      "type": "radioBox",
      "leftText": "Highly unlikely",
      "rightText": "Highly likely",
      "fieldOptions": [
          {
              "id": "314a02b2-cb4c-418f-b9bc-84fb4ad84254",
              "fieldId": "ca092d3f-21eb-492f-9142-205101b1d08a",
              "parentOptionId": "fa3e2d7b-cadb-47c1-ad7e-ef387907ec41",
              "value": "Text 2",
              "order": 0
          }
      ]
  }
}

      Update the Wrap-Up Field

      PUT livechat/wrapupFormFields/{id}

      • Parameters:

      NameTypeinRequiredDescription
      campaignIdguidbodynoId of the campaign which the wrap-up form field belongs to.
      fieldIdguidbodyyesId of the field which the wrap-up form field belongs to.
      labelstringbodyyesLabel of the wrap-up form field.
      isVisibleboolbodynoWhether the wrap-up form field is visiable or not.
      isRequiredboolbodynoWhether the wrap-up form field is required or not.
      orderintegerbodynoOrder of the wrap-up form field.

      • Response:

      Wrap-Up Field

      • Example

      Sample Request:

      curl https://api11.comm100.io/v4/livechat/wrapupFormFields/FCB01DA6-650C-495E-89E5-F3918CAB792B \ 
    -X 'PUT' \ 
    -H 'Authorization: Bearer {access_token}' \ 
    -H 'Content-Type: application/json' \ 
    -D '{"campaignId":"612E0EB3-F9A2-460D-B2D9-1A12E90B73B0","fieldId":"D8F2C475-490C-4427-9C3D-535DE30B45DE","label":"wrapup-text","isVisible":true,"isRequired":false,"order":0}'

      Response:

      HTTP/1.1 200 OK

      {
  "id": "FCB01DA6-650C-495E-89E5-F3918CAB792B",
  "campaignId": "612E0EB3-F9A2-460D-B2D9-1A12E90B73B0",
  "fieldId": "D8F2C475-490C-4427-9C3D-535DE30B45DE",
  "label": "wrapup-text",
  "isVisible": true,
  "isRequired": false,
  "order": 0,
  "field": {
      "id": "a03cce30-f892-4286-8b7e-8e6c39cb4d19",
      "isSystem": false,
      "name": "Pre-textarea",
      "type": "radioBox",
      "leftText": "Highly unlikely",
      "rightText": "Highly likely",
      "fieldOptions": [
          {
              "id": "314a02b2-cb4c-418f-b9bc-84fb4ad84254",
              "fieldId": "ca092d3f-21eb-492f-9142-205101b1d08a",
              "parentOptionId": "fa3e2d7b-cadb-47c1-ad7e-ef387907ec41",
              "value": "Text 2",
              "order": 0
          }
      ]
  }
}

      Remove the Wrap-Up Field

      DELETE livechat/wrapupFormFields/{id}

      • Parameters:

      No Parameters

      • Response:

      No Content

      • Example

      Sample Request:

      curl https://api11.comm100.io/v4/livechat/wrapupFormFields/FCB01DA6-650C-495E-89E5-F3918CAB792B \ 
    -X 'DELETE' \ 
    -H 'Authorization: Bearer {access_token}' \

      Response:

      HTTP/1.1 204 No Content

      Wrapup Category Group JSON Format

      Wrapup Category Group is represented as simple flat JSON objects with the following keys:

      NameTypeDescription
      idguidId of the wrap-up category group.
      namestringName of the wrap-up category group.
      orderintegerOrder of the wrap-up category group.
      createdTimedatetimeCreated time of the wrap-up category group.
      siteIdintegerId of the site which the wrap-up category group belongs to.
      wrapupCategoryOptionswrapupCategoryOptions[]Reference to Wrapup Category Option.

      Get the list of Wrapup Category Groups

      GET livechat/wrapupCategoryGroups

      • Parameters:

      NameTypeinRequiredDescription
      includestringquerynoAllowed value is "wrapupCategoryOption".

      • Response:

      An array of Wrapup Category Group

      • Example

      Sample Request:

      curl https://api11.comm100.io/v4/livechat/wrapupCategoryGroups \ 
    -X 'GET' \ 
    -H 'Authorization: Bearer {access_token}' \

      Response:

      HTTP/1.1 200 OK

      [
  {
      "id": "1AEAE8BA-F91D-414F-8AB9-5992AF564EFD",
      "name": "97D0D2AB-AF00-415D-9FEB-302386AC40FC",
      "order": 1,
      "createdTime": "2021-04-07T06:05:28.98Z",
      "siteId": 10000,
      "wrapupCategoryOptions": [
          {
              "id": "e9e1379a-c478-4659-b1c5-04d3da5efddf",
              "name": "Group101",
              "groupId": "1245e3e2-6d42-466d-97b8-80579b4b8c2e",
              "order": 0,
              "siteId": 10000
          }
      ]
  }
]

      Get a single Wrapup Category Group

      GET livechat/wrapupCategoryGroups/{id}

      • Parameters:

      NameTypeinRequiredDescription
      includestringquerynoAllowed value is "wrapupCategoryOption".

      • Response:

      Wrapup Category Group

      • Example

      Sample Request:

      curl https://api11.comm100.io/v4/livechat/wrapupCategoryGroups/1AEAE8BA-F91D-414F-8AB9-5992AF564EFD \ 
    -X 'GET' \ 
    -H 'Authorization: Bearer {access_token}' \

      Response:

      HTTP/1.1 200 OK

      {
  "id": "1AEAE8BA-F91D-414F-8AB9-5992AF564EFD",
  "name": "97D0D2AB-AF00-415D-9FEB-302386AC40FC",
  "order": 1,
  "createdTime": "2021-04-07T06:05:28.98Z",
  "siteId": 10000,
  "wrapupCategoryOptions": [
      {
          "id": "e9e1379a-c478-4659-b1c5-04d3da5efddf",
          "name": "Group101",
          "groupId": "1245e3e2-6d42-466d-97b8-80579b4b8c2e",
          "order": 0,
          "siteId": 10000
      }
  ]
}

      Update the Wrapup Category Group

      PUT livechat/wrapupCategoryGroups/{id}

      • Parameters:

      NameTypeinRequiredDescription
      namestringbodynoName of the wrap-up category group.
      orderintegerbodynoOrder of the wrap-up category group.
      siteIdintegerbodynoId of the site which the wrap-up category group belongs to.
      wrapupCategoryOptionswrapupCategoryOptions[]bodynoReference to Wrapup Category Option.

      • Response:

      Wrapup Category Group

      • Example

      Sample Request:

      curl https://api11.comm100.io/v4/livechat/wrapupCategoryGroups/1AEAE8BA-F91D-414F-8AB9-5992AF564EFD \ 
    -X 'PUT' \ 
    -H 'Authorization: Bearer {access_token}' \ 
    -H 'Content-Type: application/json' \ 
    -D '{"name":"97D0D2AB-AF00-415D-9FEB-302386AC40FC","order":1,"siteId":10000,"wrapupCategoryOptions":[{"name":"Group101","order":0,"siteId":10000}]}'

      Response:

      HTTP/1.1 200 OK

      {
  "id": "1AEAE8BA-F91D-414F-8AB9-5992AF564EFD",
  "name": "97D0D2AB-AF00-415D-9FEB-302386AC40FC",
  "order": 1,
  "createdTime": "2021-04-07T06:05:28.98Z",
  "siteId": 10000,
  "wrapupCategoryOptions": [
      {
          "id": "e9e1379a-c478-4659-b1c5-04d3da5efddf",
          "name": "Group101",
          "groupId": "1245e3e2-6d42-466d-97b8-80579b4b8c2e",
          "order": 0,
          "siteId": 10000
      }
  ]
}

      Wrapup Category Option JSON Format

      Wrapup Category Option is represented as simple flat JSON objects with the following keys:

      NameTypeDescription
      idguidId of the wrap-up category option.
      namestringName of the wrap-up category option.
      groupIdguidId of the wrapup category group which the wrapup category option belongs to.
      orderintegerOrder of the wrapup category option.
      siteIdintegerSiteId of the wrap-up category group which the wrapup category option belongs to.

      Get the list of Wrapup Category Options

      GET livechat/wrapupCategoryOptions

      • Parameters:

      No Parameters

      • Response:

      An array of Wrapup Category Option

      • Example

      Sample Request:

      curl https://api11.comm100.io/v4/livechat/wrapupCategoryOptions \ 
    -X 'GET' \ 
    -H 'Authorization: Bearer {access_token}' \

      Response:

      HTTP/1.1 200 OK

      [
  {
      "id": "e9e1379a-c478-4659-b1c5-04d3da5efddf",
      "name": "Group101",
      "groupId": "1245e3e2-6d42-466d-97b8-80579b4b8c2e",
      "order": 0,
      "siteId": 10000
  }
]

      Get a single Wrapup Category Option

      GET livechat/wrapupCategoryOptions/{id}

      • Parameters:

      No Parameters

      • Response:

      Wrapup Category Option

      • Example

      Sample Request:

      curl https://api11.comm100.io/v4/livechat/wrapupCategoryOptions/e9e1379a-c478-4659-b1c5-04d3da5efddf \ 
    -X 'GET' \ 
    -H 'Authorization: Bearer {access_token}' \

      Response:

      HTTP/1.1 200 OK

      {
  "id": "e9e1379a-c478-4659-b1c5-04d3da5efddf",
  "name": "Group101",
  "groupId": "1245e3e2-6d42-466d-97b8-80579b4b8c2e",
  "order": 0,
  "siteId": 10000
}
      Was this article helpful?
      What's Next
      Copyright © 2022 Comm100 Network Corporation. All Rights Reserved.