Awesome Support Developer Documentation

Settings: Schema

The schema defines all the fields that exist for a settings object.

assignee_default
string
Who to assign tickets to in the case that auto-assignment wouldn’t work. This does NOT mean that all tickets will be assigned to this user. This is a fallback option. To enable/disable auto assignment for an agent, please do so in the user profile settings.

Context:

allow_registrations
string
Allow users to register on the support page. This setting can be enabled even though the WordPress setting is disabled.

Context:

One of: allow, disallow, disallow_silent

tickets_per_page_front_end
string
How many tickets per page should be displayed to the customer/client/end-user?

Context:

replies_order
string
In which order should the replies be displayed (for both client and admin side)?

Context:

One of: ASC, DESC

replies_per_page
string
How many replies should be displayed per page on a ticket details screen?

Context:

hide_closed
boolean
Only show open tickets when agents click the “All Tickets” link.

Context:

show_count
boolean
Display the number of open tickets in the admin menu.

Context:

old_ticket
string
After how many days should a ticket be considered «old»?

Context:

departments
boolean
Enable departments management.

Context:

multiple_agents_per_ticket
boolean
Show the two extra agent fields on the ticket?

Context:

show_secondary_agent_in_ticket_list
boolean
Show the secondary agent in the ticket list?

Context:

show_tertiary_agent_in_ticket_list
boolean
Show the Tertiary agent in the ticket list?

Context:

show_third_party_fields
boolean
Show the third party fields on the ticket?

Context:

show_third_party_01_in_ticket_list
boolean
Show Third Party #1 Data in the Ticket List?

Context:

show_third_party_02_in_ticket_list
boolean
Show Third Party #2 Data in the Ticket List?

Context:

show_open_date_in_activity_column
boolean
Show the open date in the activity column?

Context:

show_open_date_gmt_in_activity_column
boolean
Show the open date in GMT in the activity column?

Context:

show_close_date_gmt_in_activity_column
boolean
Show the close date in GMT in the activity column?

Context:

show_length_of_time_ticket_was_opened
boolean
Show how long the ticket was opened? Note that this applies to closed tickets only.

Context:

channel_show_in_ticket_list
boolean
Show Channel Field In Ticket List? (Channel allows you to select where a ticket originated – web, email, facebook etc.)

Context:

ticket_list_show_doc_tab
boolean

Context:

ticket_list_show_bulk_actions_tab
boolean

Context:

ticket_list_show_preferences_tab
boolean

Context:

ticket_submit
string
The page used for ticket submission. This page should contain the shortcode ticket-submit

Context:

WordPress Page ID

ticket_list
string
The page that will list all tickets for a client. This page should contain the shortcode tickets

Context:

WordPress Page ID

terms_conditions
string
Terms & conditions are not mandatory. If you add terms, a mandatory checkbox will be added in the registration form. Users won’t be able to register if they don’t accept your terms

Context:

remove_admin_ratings_request
boolean
Remove the rating request footer in the admin screen.

Context:

theme
string
Which theme to use for the front-end.

Context:

One of: default

theme_stylesheet
boolean
Load the theme stylesheet. Don’t uncheck if you don’t know what this means

Context:

frontend_wysiwyg_editor
boolean
Show a editor editor for the ticket description when user submits a ticket.

Context:

color_open
string

Context:

color_closed
string

Context:

color_old
string

Context:

color_awaiting_reply
string

Context:

color_queued
string

Context:

color_processing
string

Context:

color_hold
string

Context:

use_email_template
boolean
Outgoing notifications are styled with a built-in template. If you are using an e-mail templating plugin you should deactivate this option.

Context:

email_template_header
string

Context:

sender_name
string

Context:

sender_email
string

Context:

reply_email
string

Context:

enable_confirmation
boolean
Do you want to activate this e-mail template?

Context:

subject_confirmation
string

Context:

content_confirmation
string

Context:

enable_assignment
boolean
Do you want to activate this e-mail template?

Context:

subject_assignment
string

Context:

content_assignment
string

Context:

enable_reply_agent
boolean
Do you want to activate this e-mail template?

Context:

subject_reply_agent
string

Context:

content_reply_agent
string

Context:

enable_reply_client
boolean
Do you want to activate this e-mail template?

Context:

subject_reply_client
string

Context:

content_reply_client
string

Context:

enable_closed
boolean
Do you want to activate this e-mail template?

Context:

subject_closed
string

Context:

content_closed
string

Context:

enable_closed_client
boolean
Do you want to activate this e-mail template?

Context:

subject_closed_client
string

Context:

content_closed_client
string

Context:

enable_attachments
boolean
Do you want to allow your users (and agents) to upload attachments to tickets and replies?

Context:

attachments_max
string
How many files can a user attach to a ticket or a reply?

Context:

filesize_max
string
What is the maximum size allowed for one file (in MB)? Your server allows up to 1000M

Context:

login_page
string
Only use this option if you know how to create your own registration page, otherwise you might create an infinite redirect. If you need help on creating a registration page you should start by reading this guide.

Context:

One of: , 358, 286, 285, 284, 283, 5, 4

admin_see_all
boolean
Administrators can see all tickets in the tickets list. If unchecked admins will only see tickets assigned to them.

Context:

agent_see_all
boolean
Agents can see all tickets in the tickets list. If unchecked agents will only see tickets assigned to them.

Context:

ticket_topic_slug
string
What to use for the indivdual ticket slug. The default is the ticket topic transformed into a slug.

Context:

One of: default, ticketid, randomnumber, guid

select2_js_file
string
Which select2 file should be loaded? Minimized version of files will load faster but cannot be used for debugging.

Context:

One of: full, full-min, partial, partial-min

select2_css_file
string
Which select2 css file should be loaded? Minimized version of files will load faster but cannot be used for debugging.

Context:

One of: min, full

load_bs4_files_fe
string

Context:

One of: 0, 1, 2

load_bs4_files_be
string

Context:

One of: 0, 1, 2

bs4_theme
string

Context:

One of: default, awesome, cerulean, cosmo, cyborg, darkly, flatly, journal, litera, lumen, lux, materia, minty, pulse, sandstone, simplex, slate, solar, spacelab, united, yeti, custom

secure_cookies
boolean

Context:

delete_data
boolean
Delete ALL plugin data on uninstall? This cannot be undone.

Context:


Example Request

$ curl -X OPTIONS -i http://demo.getawesomesupport.com/wp-json/wpas-api/v1/settings

Share: