Custom Fields APIs

Custom fields can be created for user, agent, company, or ticket records. Once created, their values are filled and retrieved using the relevant user, agent, company, or ticket API methods. See Users APIs, Agent APIs, Company APIs, and Tickets APIs.
Agent vs User Custom Fields
When you get an agent object (using an agent API), any returned custom fields are those specifically configured for the agent (if any). When you get a user object of an agent, any returned custom fields are those specifically configured for the user object (if any); agent custom fields are not returned.

Add Custom Field

Users: POST https://<tenant_subdomain>.wixanswers.com/api/v1/users/fields
Tickets: POST https://<tenant_subdomain>.wixanswers.com/api/v1/tickets/fields
Agents: POST https://<tenant_subdomain>.wixanswers.com/api/v1/agents/fields
Companies: POST https://<tenant_subdomain>.wixanswers.com/api/v1/companies/fields

Add a custom field for a record. Note the following maximums:
  • You cannot create more than 20 numeric custom fields for tickets, or more than 15 custom fields for users, agents, or companies.
  • You cannot create more than 30 text custom fields for tickets, or more than 10 custom fields for users, agents, or companies.

Payload Params
Description 
Format
Required
name
The generated name for use in other API calls
String

Max 50 characters.
displayName
The field name, visible to agents
String
type
Integer
Additional payload for a user, agent, or company custom field:
Payload Params
Description 
Format
Required
data
Structure of:
* data (structure, required): Substructure of:
 * title (string): The field name, visible to users
 * placeHolder (string): The placeholder text, visible to users before or when they interact with the field
 * description (string): Description of field, visible to users
 * values (list of strings): Value options for selection fields
 * disabled (Boolean): Whether the field is disabled
Structure
Additional payload for a ticket custom field:
Payload Params
Description 
Format
Required
data
Structure of:
* multilingualData: A map of <locale> to <data>:
  * <locale> (two-letter country code string): Language ISO code (e.g: 'de'). Note that the locale must be supported in your tenant.
  * <data structure> as described in the additional payload for a user custom field, above.
Structure
Payload Example (user):
1
2
3
4
5
6
7
8
9
10
11
12
13
14
POST https://<tenant_subdomain>.wixanswers.com/api/v1/users/fields

{
    "name": "nickname-1",
    "displayName": "Nickname",
    "type": 1,
    "data": {
        "data": {
            "title": "Enter a Nickname",
            "placeHolder": "Enter your nickname here ...",
            "description": "A nickname is used in the user interface",
        }
    }
}
Payload Example (ticket):
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
POST https://<tenant_subdomain>.wixanswers.com/api/v1/tickets/fields

{
    "name": "nickname-1",
    "displayName": "Nickname",
    "type": 1,
    "data": {
        "multilingualData": {
            "en": {
                "title": "Enter a Nickname",
                "placeHolder": "Enter your nickname here ...",
                "description": "A nickname is used in the user interface",
            }
        }
    }
}

Get Custom Field Information (Guest)

Users: GET https://<tenant_subdomain>.wixanswers.com/api/v1/users/fields/{custom field GUID}
Tickets: GET https://<tenant_subdomain>.wixanswers.com/api/v1/tickets/fields/{custom field GUID}
Agents: GET https://<tenant_subdomain>.wixanswers.com/api/v1/agents/fields/{custom field GUID}
Companies: GET https://<tenant_subdomain>.wixanswers.com/api/v1/companies/fields/{custom field GUID}

Get a custom field's publicly available information. Internal information is not returned; see Get Custom Field Information (Admin).

Request Example (ticket):
1
GET https://<account_subdomain>.wixanswers.com/api/v1/tickets/fields/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa

Get All Custom Fields (Guest)

Users: GET https://<tenant_subdomain>.wixanswers.com/api/v1/users/fields
Tickets: GET https://<tenant_subdomain>.wixanswers.com/api/v1/tickets/fields
Agents: GET https://<tenant_subdomain>.wixanswers.com/api/v1/agents/fields
Companies: GET https://<tenant_subdomain>.wixanswers.com/api/v1/companies/fields

Get all user/ticket/agent/company custom fields' publicly available information. Internal information is not returned, see Get All Custom Fields (Admin).

Request Example (ticket):
1
GET https://<account_subdomain>.wixanswers.com/api/v1/tickets/fields

Get Custom Field Information (Admin)

Users: GET https://<tenant_subdomain>.wixanswers.com/api/v1/users/fields/{custom field GUID}/admin
Tickets: GET https://<tenant_subdomain>.wixanswers.com/api/v1/tickets/fields/{custom field GUID}/admin
Agents: GET https://<tenant_subdomain>.wixanswers.com/api/v1/agents/fields/{custom field GUID}/admin
Companies: GET https://<tenant_subdomain>.wixanswers.com/api/v1/companies/fields/{custom field GUID}/admin

Get a custom field's information, including internal information relevant only to agents.

Request Example (ticket):
1
GET https://<account_subdomain>.wixanswers.com/api/v1/tickets/fields/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa/admin

Get All Custom Fields (Admin)

Users: GET https://<tenant_subdomain>.wixanswers.com/api/v1/users/fields/admin
Tickets: GET https://<tenant_subdomain>.wixanswers.com/api/v1/tickets/fields/admin
Agents: GET https://<tenant_subdomain>.wixanswers.com/api/v1/agents/fields/admin
Companies: GET https://<tenant_subdomain>.wixanswers.com/api/v1/companies/fields/admin

Get all user/ticket/agent/company custom fields, including internal information available only to agents.

Request Example (ticket):
1
GET https://<account_subdomain>.wixanswers.com/api/v1/tickets/fields/admin

Update Custom Field Name or Data Type

Users: PUT https://<tenant_subdomain>.wixanswers.com/api/v1/users/fields/{custom field GUID}
Tickets: PUT https://<tenant_subdomain>.wixanswers.com/api/v1/tickets/fields/{custom field GUID}
Agents: PUT https://<tenant_subdomain>.wixanswers.com/api/v1/agents/fields/{custom field GUID}
Companies: PUT https://<tenant_subdomain>.wixanswers.com/api/v1/companies/fields/{custom field GUID}

Update a custom field name or type. See Important Information about Updating Structures Using the API.

  • Authorization: Requires admin authorization level
  • Content type: application/json; charset=utf-8.
  • Accept: application/json.
  • Response: None
Payload Params
Description 
Format
Required
name
The generated name for use in other API calls
String

Max 50 characters.
displayName
The field name, visible to agents

If not provided, the value of name is used.
String

Additional payload for a user, agent, or company custom field:
Payload Params
Description 
Format
Required
data
Structure of:
* data (structure): Substructure of:
 * title (string): The field name, visible to users
 * placeHolder (string): The placeholder text, visible to users before or when they interact with the field
 * description (string): Description of field, visible to users
 * values (list of strings): Value options for selection fields
 * disabled (Boolean): Whether the field is disabled
Structure
Additional payload for a ticket custom field:
Payload Params
Description 
Format
Required
data
Structure of:
* multilingualData: A map of <locale> to <data>:
  * <locale> (two-letter country code string): Language ISO code (e.g: 'de')
  * <data structure> as described in the additional payload for a user custom field, above.
Structure
Payload Example (user):
1
2
3
4
5
6
7
8
9
10
11
12
13
PUT https://<tenant_subdomain>.wixanswers.com/api/v1/users/fields/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa

{
    "name": "nickname-1",
    "displayName": "Nickname",
    "data": {
        "data": {
            "title": "Enter a Nickname",
            "placeHolder": "Enter your nickname here ...",
            "description": "A nickname is used in the user interface",
        }
    }
}
Payload Example (ticket):
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
PUT https://<tenant_subdomain>.wixanswers.com/api/v1/tickets/fields/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa

{
    "name": "nickname-1",
    "displayName": "Nickname",
    "data": {
        "multilingualData": {
            "en": {
                "title": "Enter a Nickname",
                "placeHolder": "Enter your nickname here ...",
                "description": "A nickname is used in the user interface",
            }
        }
    }
}

Delete Custom Field

Users: DELETE https://<tenant_subdomain>.wixanswers.com/api/v1/users/fields/{custom field GUID}
Tickets: DELETE https://<tenant_subdomain>.wixanswers.com/api/v1/tickets/fields/{custom field GUID}
Agents: DELETE https://<tenant_subdomain>.wixanswers.com/api/v1/agents/fields/{custom field GUID}
Companies: DELETE https://<tenant_subdomain>.wixanswers.com/api/v1/companies/fields/{custom field GUID}

Delete a custom field for the relevant record type. If a user/ticket/agent/company has a value for this field, Wix Answers removes the field and value the next time it updates the record.

  • Authorization: Requires admin authorization level
  • Content type: application/json; charset=utf-8.
  • Accept: application/json.
  • Response: None
Request Example (ticket):
1
DELETE https://<account_subdomain>.wixanswers.com/api/v1/tickets/fields/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa

Related Articles

Finding a Custom Field Name

Wix Answers generates a name for each custom field that you define. You need this name to, for example, create a new ticket using that custom field. To find these names, navigate in the Wix Answers UI to Settings &gt; Custom Fields &gt; Edit (of specific custom field).

1 min read

Managing Custom Fields

Edit or delete the custom fields you've created for your Help Center or Widget contact forms. Click here to learn how to create new custom fields.  Important:Any changes that you make to the custom fields are applied to all of the contact forms using these fields.To manage your custom fields:Hover over Settings  in the side panel and click Custom Fields.Click Edit next to a field.Do one of the following:Edit the field text: Edit the text and click Update.Delete the field: Click Delete Field and click Delete to confirm.Click Update.

1 min read

Working with Custom Fields on Tickets

Use custom fields on your contact form to gather information about your customers' support requests. When your customer submits a ticket through your contact form, you can view and manage the custom fields submitted in the side panel to the right of their ticket.To manage a ticket's custom fields:Go to the relevant ticket. Click Ticket Fields in the panel on the right. Click Edit Fields next to Field List:Note: If fields have not been added yet click Add Field and select a field to add it.Add a field: Click Add Field and select a field. Note: If you are an admin you can click Create New Field to create a new custom field. Edit a field: Click the relevant field and modify it. Delete a field: Click the Delete Field icon  next to a field to delete it.  Click Update.

1 min read

About Custom Field Types

When using your Help Center or a widget as a support channel, you can create a contact form with custom fields to gain valuable information about your customers and the issues they're experiencing. Use different custom field types depending on the information you wish to capture. Tip:Easily view or edit a customer's custom field responses directly from their ticket. Learn MoreText FieldsAllow your customers to enter a single line of text. Text fields are good for collecting short strings of text such as names and emails. Dropdown FieldsAllow your customers to choose from a list of options. Dropdown fields are useful when you want your visitors to choose one possible option. Multi-line FieldsAllow your customers to write full paragraphs and describe the issue they're having.Checkbox FieldsAllow your customers to select a single response. Checkbox fields are useful when you have a yes or no answer. Number FieldsAllow your customers to only enter numeric values. 

1 min read

Creating Custom Fields

When using your Help Center or a Widget as a support channel, you can create a contact form with custom fields to gain valuable information about your customers and the issues they're experiencing. You can then view the custom fields submitted by your customer directly from their ticket. The more you know about your customers the better your replies will be! Tip:When viewing your tickets, you can filter according to any of your custom fields and prioritize accordingly, helping you organize your tickets and gain helpful insights. Learn MoreTo create custom fields:Hover over Settings  in the side panel and click Custom Fields.Click Create New Field and select the field type. Learn MoreText: Allow your customers to enter a single line of text. Dropdown: Allow your customers to choose from a list of options. Click Add Option to add each additional option.Multi-line: Allow your customers  to write full paragraphs and describe the issue they're having.Checkbox: Allow your customers to choose one of two options (great for yes or no answers).Number: Allow your customers to enter numbers.Fill in the relevant information for each field:Enter a field name which allows you to identify the custom field, and can be used by agents to identify the field in the ticket page. This name does not appear live and is for your back-end use only.Enter a title for your field which your customers will see.Enter a description for the field, and give your customers more information about what you need.Enter placeholder text, which appears in the field before your customer starts typing. It can be used as a hint for what you want them to write.Click Create.

2 min read