These are the endpoints that are available under the /emailCategories path, which lists all the different email categories on your business' account.
Endpoint | Description |
---|---|
GET /emailCategories/sentTo/{recipient} | Returns all email category objects sent to specified recipient on an account in array format, where the recipient would be either "Client" or "Staff". |
GET /emailCategories/{emailCategoryId} | Returns a JSON object for specified email category. |
There are no parameters included with emailCategories calls.
Property Name | Type | Description |
---|---|---|
allowChange | boolean | Indicates whether or not specified email category allows changes to be made to it. |
allowDuplicates | boolean | Indicates whether or not specified email category allows duplicates to be made of it. If it is set to true, then multiple email templates can be added to the email category with the level property set to a value of 1. If it is set to false, then you must create email templates in that category following the level rules described on the email templates page. |
businessId | integer | Provides unique numeric ID for the business to which specified coupon belongs. |
code | string | All email categories TimeTap provides at the point of account creation have a unique code representative of that email category. This property displays that code. |
countOfTemplates | integer | Displays as the number of email templates that fall within specified email category. |
emailCategory | string | Displays as name of specified email category. |
emailCategoryId | integer | Provides unique numeric ID for specified email category. |
objectType | string | Displays as the object type of specified email category. Has available options CALENDAR, RECURRING_APPOINTMENT, WAIT_LIST, STAFF, DISCLAIMER_FORM_DATA, CLASS_SCHEDULE, INVOICE, BULK, INVITE_REMIND_BULK, INVITE_COMPLETE_BULK, REQUEST, PROFESSIONAL, PACKAGE, and RECALL. |
sentTo | string | Displays as the "recipient" from the endpoint URL. Has available options "Client" and "Staff". |
sentToClient | boolean | Indicates whether or not specified email category is sent to a Client. |
sms | boolean | Indicates whether or not type of communication used for specified email category is SMS. |
type | string | Displays the type of of communication used in specified email category. Has available options "EMAIL" and "SMS". Only filled for GET /emailCategory/{emailCategory/{emailCategoryId} calls. |