You need the Manage Campaigns permission to manage Wrap-Up Form Field.
LiveChat_Wrap-Up Field is represented as simple flat JSON objects with the following keys:
Name | Type | Description |
---|---|---|
id |
guid | Id of the wrap-up form field. |
campaignId |
guid | Id of the campaign which the wrap-up form field belongs to. |
fieldId |
guid | Id of the field which the wrap-up form field belongs to. |
label |
string | Label of the wrap-up form field. |
isVisible |
bool | Whether the wrap-up form field is visiable or not. |
isRequired |
bool | Whether the wrap-up form field is required or not. |
order |
integer | Order of the wrap-up form field. |
field |
field | Reference to LiveChat_Field. |
GET livechat/wrapupFormFields
Name | Type | In | Required | Description |
---|---|---|---|---|
campaignId |
guid | query | no | Id of the Campaign which the Wrap-Up Form Field belongs to. |
isSystem |
bool | query | no | Whether the field is system field or not. |
include |
string | query | no | Allowed values are "field", "wrapupCategoryGroup". |
An array of LiveChat_Wrap-Up Field
Sample Request:
Response:
HTTP/1.1 200 OK
GET livechat/wrapupFormFields/{id}
Sample Request:
Response:
HTTP/1.1 200 OK
POST livechat/wrapupFormFields
Name | Type | In | Required | Description |
---|---|---|---|---|
campaignId |
guid | body | no | Id of the campaign which the wrap-up form field belongs to. |
fieldId |
guid | body | yes | Id of the field which the wrap-up form field belongs to. |
label |
string | body | yes | Label of the wrap-up form field. |
isVisible |
bool | body | no | Whether the wrap-up form field is visiable or not. |
isRequired |
bool | body | no | Whether the wrap-up form field is required or not. |
order |
integer | body | no | Order of the wrap-up form field. |
Sample Request:
Response:
HTTP/1.1 201 Created
PUT livechat/wrapupFormFields/{id}
Name | Type | In | Required | Description |
---|---|---|---|---|
campaignId |
guid | body | no | Id of the campaign which the wrap-up form field belongs to. |
fieldId |
guid | body | yes | Id of the field which the wrap-up form field belongs to. |
label |
string | body | yes | Label of the wrap-up form field. |
isVisible |
bool | body | no | Whether the wrap-up form field is visiable or not. |
isRequired |
bool | body | no | Whether the wrap-up form field is required or not. |
order |
integer | body | no | Order of the wrap-up form field. |
Sample Request:
Response:
HTTP/1.1 200 OK
DELETE livechat/wrapupFormFields/{id}
No Content
Sample Request:
Response:
HTTP/1.1 204 No Content
Wrapup Category Group is represented as simple flat JSON objects with the following keys:
Name | Type | Description |
---|---|---|
id |
guid | Id of the wrap-up category group. |
name |
string | Name of the wrap-up category group. |
order |
integer | Order of the wrap-up category group. |
createdTime |
datetime | Created time of the wrap-up category group. |
siteId |
integer | Id of the site which the wrap-up category group belongs to. |
wrapupCategoryOptions |
wrapupCategoryOptions[] | Reference to Wrapup Category Option. |
GET livechat/wrapupCategoryGroups
Name | Type | In | Required | Description |
---|---|---|---|---|
include |
string | query | no | Allowed value is "wrapupCategoryOption". |
An array of Wrapup Category Group
Sample Request:
Response:
HTTP/1.1 200 OK
GET livechat/wrapupCategoryGroups/{id}
Name | Type | In | Required | Description |
---|---|---|---|---|
include |
string | query | no | Allowed value is "wrapupCategoryOption". |
Sample Request:
Response:
HTTP/1.1 200 OK
PUT livechat/wrapupCategoryGroups/{id}
Name | Type | In | Required | Description |
---|---|---|---|---|
name |
string | body | no | Name of the wrap-up category group. |
order |
integer | body | no | Order of the wrap-up category group. |
siteId |
integer | body | no | Id of the site which the wrap-up category group belongs to. |
wrapupCategoryOptions |
wrapupCategoryOptions[] | body | no | Reference to Wrapup Category Option. |
Sample Request:
Response:
HTTP/1.1 200 OK
Wrapup Category Option is represented as simple flat JSON objects with the following keys:
Name | Type | Description |
---|---|---|
id |
guid | Id of the wrap-up category option. |
name |
string | Name of the wrap-up category option. |
groupId |
guid | Id of the wrapup category group which the wrapup category option belongs to. |
order |
integer | Order of the wrapup category option. |
siteId |
integer | SiteId of the wrap-up category group which the wrapup category option belongs to. |
GET livechat/wrapupCategoryOptions
Sample Request:
Response:
HTTP/1.1 200 OK
GET livechat/wrapupCategoryOptions/{id}
Sample Request:
Response:
HTTP/1.1 200 OK