You need the Manage Secure Form permission to manage Secure Forms.
SecureForm_Label is represented as simple flat JSON objects with the following keys:
Name | Type | Description |
---|---|---|
id |
guid | Id of the secure form. |
name |
string | Name of the secure form. |
description |
string | Description of the secure form. |
secureFormFields |
secureFormFields[] | Reference to Secure Form Field. |
Secure Form Field Option JSON Format:
Name | Type | Description |
---|---|---|
id |
guid | Id of the secure form field which the secure form field option belongs to. |
fieldId |
guid | Id of the secure form field which the secure form field option belongs to. |
displayText |
string | Display text of this secure form field option. |
order |
integer | Order of the secure form field option. |
GET livechat/secureForms
Name | Type | In | Required | Description |
---|---|---|---|---|
include |
string | query | no | Allowed value is "secureFormField". |
An array of SecureForm_Label
Sample Request:
Response:
HTTP/1.1 200 OK
GET livechat/secureForms/{id}
Name | Type | In | Required | Description |
---|---|---|---|---|
include |
string | query | no | Allowed value is "secureFormField". |
Sample Request:
Response:
HTTP/1.1 200 OK
POST livechat/secureForms
Name | Type | In | Required | Description |
---|---|---|---|---|
name |
string | body | yes | Name of the secure form. |
description |
string | body | no | Description of the secure form. |
secureFormFields |
secureFormFields[] | body | no | Reference to Secure Form Field. |
Sample Request:
Response:
HTTP/1.1 201 Created
PUT livechat/secureForms/{id}
Name | Type | In | Required | Description |
---|---|---|---|---|
name |
string | body | yes | Name of the secure form. |
description |
string | body | no | Description of the secure form. |
secureFormFields |
secureFormFields[] | body | no | Reference to Secure Form Field. |
Sample Request:
Response:
HTTP/1.1 200 OK
DELETE livechat/secureForms/{id}
No Content
Sample Request:
Response:
HTTP/1.1 204 No Content
Secure Form Field is represented as simple flat JSON objects with the following keys:
Name | Type | Description |
---|---|---|
id |
guid | Id of the secure form field |
secureFormId |
guid | Id of the secure form which the secure form field belongs to. |
name |
string | Name of the secure form field. |
label |
string | Label of the secure form field. |
type |
string | Allowed values are "text", "textArea", "radioBox", "checkbox", "dropdownList", "checkboxList", "datePicker", "cardNumber", "expiration", "csc/cvv". |
isSystem |
bool | Whether the form field is a system form field or not. |
isVisible |
bool | Whether the form field is visible or not. |
isRequired |
bool | Whether the form field is required or not. |
order |
integer | Order of the secure form field. |
secureFormFieldOptions |
secureFormFieldOptions[] | Reference to Secure Form Field Option. |
GET livechat/secureFormFields
Name | Type | In | Required | Description |
---|---|---|---|---|
include |
string | query | no | Allowed value is "secureFormFieldOption". |
An array of Secure Form Field
Sample Request:
Response:
HTTP/1.1 200 OK
GET livechat/secureFormFields/{id}
Name | Type | In | Required | Description |
---|---|---|---|---|
include |
string | query | no | Allowed value is "secureFormFieldOption". |
Sample Request:
Response:
HTTP/1.1 200 OK
POST livechat/secureFormFields
Name | Type | In | Required | Description |
---|---|---|---|---|
secureFormId |
guid | body | no | Id of the secure form which the secure form field belongs to. |
name |
string | body | yes | Name of the secure form field. |
label |
string | body | no | Label of the secure form field. |
type |
string | body | yes | Allowed values are "text", "textArea", "radioBox", "checkbox", "dropdownList", "checkboxList", "datePicker", "cardNumber", "expiration", "csc/cvv". |
isSystem |
bool | body | no | Whether the form field is a system form field or not. |
isVisible |
bool | body | no | Whether the form field is visible or not. |
isRequired |
bool | body | no | Whether the form field is required or not. |
order |
integer | body | no | Order of the secure form field. |
secureFormFieldOptions |
secureFormFieldOptions[] | body | yes | Reference to Secure Form Field Option. |
Sample Request:
Response:
HTTP/1.1 201 Created
PUT livechat/secureFormFields/{id}
Name | Type | In | Required | Description |
---|---|---|---|---|
secureFormId |
guid | body | no | Id of the secure form which the secure form field belongs to. |
name |
string | body | yes | Name of the secure form field. |
label |
string | body | no | Label of the secure form field. |
type |
string | body | yes | Allowed values are "text", "textArea", "radioBox", "checkbox", "dropdownList", "checkboxList", "datePicker", "cardNumber", "expiration", "csc/cvv". |
isSystem |
bool | body | no | Whether the form field is a system form field or not. |
isVisible |
bool | body | no | Whether the form field is visible or not. |
isRequired |
bool | body | no | Whether the form field is required or not. |
order |
integer | body | no | Order of the secure form field. |
secureFormFieldOptions |
secureFormFieldOptions[] | body | yes | Reference to Secure Form Field Option. |
Sample Request:
Response:
HTTP/1.1 200 OK
DELETE livechat/secureFormFields/{id}
No Content
Sample Request:
Response:
HTTP/1.1 204 No Content