Field Mapping
- 16 Jun 2022
- 1 Minute to read
- Print
- DarkLight
Field Mapping
- Updated on 16 Jun 2022
- 1 Minute to read
- Print
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Field Mapping
Chat or offlinemessage field mapping to ticket field.
Field Mappings- Field Mappings ManageGET ticketing/fields/{id}/fieldMapping- Get a single Field MappingPUT ticketing/fields/{id}/fieldMapping- Update the Field Mapping
Field Mapping JSON Format
Field Mapping is represented as simple flat JSON objects with the following keys:
| Name | Type | Description |
|---|---|---|
fieldId | guid | Id of the field. |
mappedChatField | string | Id of the mapped chat field. |
mappedOfflineMessageField | string | Id of the mapped offline message field. |
Get a single Field Mapping
GET ticketing/fields/{id}/fieldMapping
Parameters:
| Name | Type | in | Required | Description |
|---|---|---|---|---|
include | string | query | no | Allowed value is "ticketingField". |
Response:
Example
Sample Request:
curl https://api11.comm100.io/v4/ticketing/fields/b42812a1-ceb4-4884-a22e-11d84f183ff1/fieldMapping \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \
Response:
HTTP/1.1 200 OK
{
"fieldId": "b42812a1-ceb4-4884-a22e-11d84f183ff1",
"mappedChatField": "{!Visitor.Current Page URL}",
"mappedOfflineMessageField": "{!Visitor.Email}"
}
Update the Field Mapping
PUT ticketing/fields/{id}/fieldMapping
Parameters:
| Name | Type | in | Required | Description |
|---|---|---|---|---|
mappedChatField | string | body | no | Id of the mapped chat field. |
mappedOfflineMessageField | string | body | no | Id of the mapped offline message field. |
Response:
Example
Sample Request:
curl https://api11.comm100.io/v4/ticketing/fields/b42812a1-ceb4-4884-a22e-11d84f183ff1/fieldMapping \
-X 'PUT' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"mappedChatField":"{!Visitor.Current Page URL}","mappedOfflineMessageField":"{!Visitor.Email}"}'
Response:
HTTP/1.1 200 OK
{
"fieldId": "b42812a1-ceb4-4884-a22e-11d84f183ff1",
"mappedChatField": "{!Visitor.Current Page URL}",
"mappedOfflineMessageField": "{!Visitor.Email}"
}
Was this article helpful?