Emails

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 /emails	Returns all email sent objects by a business' account in array format.
GET /emails/{emailId}	Returns a JSON object for the specified email sent.
GET /emails/emailTemplates/{emailTemplateId}	Returns all email sent objects out that use specified email template in array format.
GET /emails/calendar/{calendarId}	Returns all email sent objects for specified appointment in array format.
GET /emails/recurringAppointment/{recurringAppointmentId}	Returns all email sent objects for specified recurring appointment in array format.
GET /emails/calendar/{calendarId}/recurringAppointment/{recurringAppointmentId}	Returns all email sent objects for specified appointment and any email objects sent for the recurring appointment series it belongs to in array format.
GET /emails/client/{clientId}	Returns all email sent objects to specified client in array format.
GET /emails/invoice/{invoiceId}	Returns all email sent objects for specified invoice in array format.
GET /emails/invitation/{invitationUUId}	Returns all emails sent out for specified invitation.
GET /emails/disclaimerForm/{disclaimerFormUUId}/DISCLAIMER_FORM_CLIENT	Returns email with proper link for client to click when they receive it to fill in specified disclaimer form.
GET /emails/status/bounced	Returns all email sent objects that have status = BOUNCED.
GET /emails/waitlist/{waitlistId}/{emailTemplateCode}	Returns an email object for a person to edit before it gets sent out for the specified waitlist ID.
POST /emailDelivery	Returns all emailDelivery objects on the sent email. Request body/payload: Must pass the sendId from the email send object in request body/payload.
POST /email/calendar/{calendarId}/{emailCategoryCode}	Returns an email set object with status sent to "QUEUED" and body property merged with correct values from specified calendarId.
POST /emails	Sends an email out to one appointment. Request body/payload: Must pass an email sent object in request body/payload. For these calls, you need to pass an email sent object with all required fields and any fields you want to set filled in the body of the payload, and with the calendarId property set to match the ID of the appointment it is sending for. We have an example of an email sent object in the responses section below and have indicated the required fields in the object values table at the bottom of this page.
POST /emails/calendar/{calendarIdList}	Sends an email out to multiple recipients. Request body/payload: Must pass an email sent object in request body/payload. For these calls, you need to pass an email sent object with all required fields and any fields you want to set filled in the body of the payload, and with the commaSeparatedCalendarIdList property set to match the IDs of the appointments it is sending for. We have an example of an email sent object in the responses section below and have indicated the required fields in the object values table at the bottom of this page.
POST /emails/invoice/{invoiceId}	Sends an email out for specified invoice. Request body/payload: Must pass an email template object in request body/payload. For these calls, you need to pass an email template object with all required fields and any fields you want to set filled in the body of the payload, and with the calendarId property set to match the ID of the appointment it is sending for. We have an example of an email template object in the responses section of the Email Templates API page and have indicated the required fields in the object values table at the bottom of this page.

Data points passed on in the request URL portion of the API call that are used to filter the data being requested.

Paramater	Type	Endpoints to be used with	Description
pageNumber	integer	GET /emails, GET /emails/status/bounced	Works with the pageSize parameter to determine how emails get returned following a GET emails/status/bounced call. The pageNumber value represents the number of pages on which the emails that get returned appear.
pageSize	integer	GET /emails, GET /emails/status/bounced	Works with the pageNumber parameter to determine how emails gets returned following a GET emails/status/bounced call. The pageSize value represents the number of emails appearing on each page that gets returned.

The objects below represent the minimum viable objects to pass that are needed to create or update an emails object. Check whether or not a property can be written to by looking at the Object Values table below to see if the property is writable.

POST /emails/calendar/{calendarIdList}

{
    "active": true,
    "addressCountsInvalid": false,
    "allowOnline": false,
    "attachFileLibraryUUids": null,
    "bccAddress": null,
    "bccAddressCharCountInvalid": false,
    "body": "(HTML coding for body of email)",
    "businessId": 43111,
    "ccAddress": null,
    "ccAddressCharCountInvalid": false,
    "createdDate": 1677615117543,
    "createdUser": "JoeSchmo",
    "emailBecause": null,
    "emailBody": "(HTML coding for body of email)",
    "emailBodyText": null,
    "emailCategory": {Email category object for email category of specified email - for more info, see Email Categories API page},
    "emailTemplateId": 214720,
    "externalName": null,
    "fromAddress": "noreply@timetap.com",
    "fromName": "Dog Groomers Anonymous!",
    "language": null,
    "level": 1,
    "location": null,
    "modifiedDate": null,
    "modifiedUser": "JoeSchmo",
    "noHeader": null,
    "reasonIdList": null,
    "reasonNameList": null,
    "replyToAddress": "noreply@timetap.com",
    "resellerId": 3,
    "s3FileName": "43111/templates/template-18-214720.html",
    "sendCompletedTemplate": {Email template object - for more info, see Email Templates API page},
    "sortOrder": null,
    "subject": "[Appointment] %STAFF_FULLNAME% on %APPT_DATE_TIME%",
    "templateName": "Default Template",
    "toAddress": "%CLIENT_EMAILADDRESS%",
    "toAddressCharCountInvalid": false,
    "toName": "%CLIENT_FULLNAME%"
}

POST /emails/invoice/{invoiceId}

{
    "active": true,
    "addressCountsInvalid": false,
    "allowOnline": false,
    "attachFileLibraryUUids": null,
    "bccAddress": null,
    "bccAddressCharCountInvalid": false,
    "body": "(HTML coding for body of email)",
    "businessId": 43111,
    "ccAddress": null,
    "ccAddressCharCountInvalid": false,
    "createdDate": 1539011086954,
    "createdUser": "JoeSchmo",
    "emailBecause": null,
    "emailBody": "(HTML coding for body of email)",
    "emailBodyText": null,
    "emailCatagory": {Email category object for email category of specified email - for more info, see Email Categories API page},
    "emailTemplateId": 70722,
    "externalName": null,
    "fromAddress": "noreply@timetap.com",
    "fromName": "%BUSINESS_NAME%",
    "language": null,
    "level": 1,
    "location": null,
    "modifiedDate": 1539014322304,
    "modifiedUser": "JoeSchmo",
    "noHeader": null,
    "reasonIdList": null,
    "reasonNameList": null,
    "replyToAddress": "%PROFESSIONAL_EMAIL%",
    "resellerId": 3,
    "s3FileName": "43111/templates/template-63-70722.html",
    "sortOrder": null,
    "subject": "Invoice Summary Of Charges",
    "templateName": "Default Bulk Invoice Template",
    "toAddress": "%CLIENT_EMAILADDRESS%",
    "toAddressCharCountInvalid": false,
    "toName": "%CLIENT_FULLNAME%"
}

GET /emails

[{
    "attachFileLibraryUUids": null,
    "attachFileLibraryList": null,
    "attachments": null,
    "bccAddress": null,
    "body": null,
    "businessId": 43111,
    "calendarId": 18310417,
    "ccAdress": null,
    "classScheduleId": null,
    "clientAccountId": null,
    "clientId": null,
    "createdDate": 1539356286584,
    "createdUser": "JoeSchmo",
    "dateProcessed": 1539356286927,
    "disclaimerFormUUid": null,
    "emailBecause": null,
    "emailCategory": {Email category object for email category of specified email - for more info, see Email Categories API page},
    "emailFinal": (HTML coding for final part of email),
    "emailFooter": null,
    "emailId": 33384373,
    "emailStatusId": 5,
    "emailTemplateId": 11635,
    "fromAddress": "noreply@timetap.com",
    "fromName": "Dog Groomers Anonymous",
    "gateway": null,
    "icalText": null,
    "invitationUUId": null,
    "invoiceId": null,
    "jobRequisitionId": null,
    "locale": "en-US",
    "location": null,
    "modifiedDate": 1539356613885,
    "msgType": "EMAIL",
    "noHeader": null,
    "packageSoldId": null,
    "postmarkAPIKey": null,
    "professionalId": 77961,
    "recurringAppointmentId": null,
    "replyToAddress": "joeschmo@email.com",
    "s3FileName": null,
    "s3FinalFileName": "prod/43111/2018/final-bcee1b115ffe452fa061610f542167c8.html",
    "s3ICSFileName": "43111/2018/ical-ca892f3aflo092ecad73e78a9ccca8a7.ics",
    "sendError": null,
    "sendId": "490f7b08-92b9-46d3-9a4d-ec9d58b0f8fd",
    "sendgrisAPIKey": null,
    "sentAge": "2 hours ago",
    "status": "OPENED",
    "subject": "[Appointment] Jane Deer on Tuesday, Oct 16, 2018 at 8:00 AM EDT",
    "templateName": null,
    "textBody": null,
    "textMessage": false,
    "toAddress": "joeschmo@email.com",
    "toName": "Joe Schmo",
    "twilioAuthtoken": null,
    "twilioSID": null,
    "waitListId": null,
    "waitListInviteUUId": null
}]

GET /emails/{emailId}

{
    "attachFileLibraryUUids": null,
    "attachFileLibraryList": null,
    "attachments": null,
    "bccAddress": null,
    "body": null,
    "businessId": 43111,
    "calendarId": 17466114,
    "ccAdress": null,
    "classScheduleId": null,
    "clientAccountId": null,
    "clientId": null,
    "createdDate": 1539689885492,
    "createdUser": "ApptRemindStaffJob",
    "dateProcessed": 1539689899144,
    "disclaimerFormUUid": null,
    "emailBecause": null,
    "emailCategory": {Email category object for email category of specified email - for more info, see Email Categories API page},
    "emailFinal": (HTML coding for final part of email),
    "emailFooter": null,
    "emailId": 3383012,
    "emailStatusId": 5,
    "emailTemplateId": 4860,
    "fromAddress": "noreply@timetap.com",
    "fromName": "Dog Groomers Anonymous",
    "gateway": null,
    "icalText": (ical text),
    "invitationUUId": null,
    "invoiceId": null,
    "jobRequisitionId": null,
    "locale": null,
    "location": null,
    "modifiedDate": 1539694066629,
    "msgType": "EMAIL",
    "noHeader": null,
    "packageSoldId": null,
    "postmarkAPIKey": null,
    "professionalId": 77961,
    "recurringAppointmentId": null,
    "replyToAddress": "joeschmo@email.com",
    "s3FileName": null,
    "s3FinalFileName": "prod/43111/2018/final-2c68973fbc854882a471203b8fba7d73.html",
    "s3ICSFileName": "43111/2018/ical-ca892f3af56e42ecad73e78a9ccca8a7.ics",
    "sendError": null,
    "sendId": "c703ac97-2bd2-45d5-9f4f-66060f0ba9db",
    "sendgridAPIKey": null,
    "sentAge": "2 hours ago",
    "status": "OPENED",
    "subject": "[Appointment Reminder]  on Wednesday, Oct 17, 2018 at 8:00 AM EDT",
    "templateName": null,
    "textBody": null,
    "textMessage": false,
    "toAddress": "client@email.com",
    "toName": "Client Name",
    "twilioAuthToken": null,
    "twilioSID": null,
    "waitListId": null,
    "waitListInviteUUId": null
}

GET /emails/emailTemplates/{emailTemplateId}

[{
    "attachFileLibraryUUids": null,
    "attachFileLibraryList": null,
    "attachments": null,
    "bccAddress": null,
    "body": null,
    "businessId": 43111,
    "calendarId": 18310417,
    "ccAdress": someoneelse@email.com,
    "classScheduleId": null,
    "clientAccountId": null,
    "clientId": 5147353,
    "createdDate": 1539603458517,
    "createdUser": "ApptRemindClJob",
    "dateProcessed": 1539603461592,
    "disclaimerFormUUid": null,
    "emailBecause": null,
    "emailCategory": {Email category object for email category of specified email - for more info, see Email Categories API page},
    "emailFinal": (HTML coding for final part of email),
    "emailFooter": null,
    "emailId": 33441156,
    "emailStatusId": 5,
    "emailTemplateId": 72108,
    "fromAddress": "noreply@timetap.com",
    "fromName": "Dog Groomers Anonymous",
    "gateway": null,
    "icalText": null,
    "invitationUUId": null,
    "invoiceId": null,
    "jobRequisitionId": null,
    "locale": null,
    "location": "testfile",
    "modifiedDate": 1539603563902,
    "msgType": "EMAIL",
    "noHeader": null,
    "packageSoldId": null,
    "postmarkAPIKey": null,
    "professionalId": 77961,
    "recurringAppointmentId": null,
    "replyToAddress": "joeschmo@email.com",
    "s3FileName": null,
    "s3FinalFileName": "prod/43111/2018/final-405bd188e7a24f3cb532550caa12bc20.html",
    "s3ICSFileName": "43111/2018/ical-85a75bad624b4d46a1cf304fdcfcda42.ics",
    "sendError": null,
    "sendId": "5169e43d-9147-4a58-a7a5-061bbfc30120",
    "sendgridAPIKey": null,
    "sentAge": "1 day ago",
    "status": "DELIVERED",
    "subject": "[Appointment Reminder] Joe Schmo on Tuesday, Oct 16, 2018 at 8:00 AM EDT",
    "textBody": null,
    "textMessage": false,
    "toAddress": "janedeer@email.com",
    "toName": "Jane Deer",
    "twilioAuthToken": null,
    "twilioSID": null,
    "waitListId": null,
    "waitListInviteUUId": null
}]

GET /emails/calendar/{calendarId}

[{
    "attachFileLibraryUUids": null,
    "attachFileLibraryList": null,
    "attachments": null,
    "bccAddress": null,
    "body": null,
    "businessId": 43111,
    "calendarId": 18377225,
    "ccAdress": null,
    "classScheduleId": null,
    "clientAccountId": null,
    "clientId": null,
    "createdDate": 1539782877007,
    "createdUser": "JoeSchmo",
    "dateProcessed": 1539782877537,
    "disclaimerFormUUid": null,
    "emailBecause": null,
    "emailCategory": {Email category object for email category of specified email - for more info, see Email Categories API page},
    "emailFinal": (HTML coding for final part of email),
    "emailFooter": null,
    "emailId": 33528708,
    "emailStatusId": 5,
    "emailTemplateId": 11635,
    "fromAddress": "noreply@timetap.com",
    "fromName": "Dog Groomers Anonymous",
    "gateway": null,
    "icalText": null,
    "invitationUUId": null,
    "invoiceId": null,
    "jobRequisitionId": null,
    "locale":"en-US",
    "location": "null,
    "modifiedDate": 1539782877093,
    "msgType": "EMAIL",
    "noHeader": null,
    "packageSoldId": null,
    "postmarkAPIKey": null,
    "professionalId": 82275,
    "recurringAppointmentId": null,
    "replyToAddress": "majorhay@email.com",
    "s3FileName": null,
    "s3FinalFileName": "prod/43111/2018/final-ce3a646d3a32455bb58bcdc82ecf600a.html",
    "s3ICSFileName": "43111/2018/ical-bb7fb91a14e8419290b59fce89e7faae.ics",
    "sendError": null,
    "sendId": "408bf4d3-3632-4a3ba751-ac1256c0add0",
    "sendgridAPIKey": null,
    "sentAge": "moments ago",
    "status": "SENT",
    "subject": "[Appointment] Simon Sez on Friday, Oct 19, 2018 at 9:00 AM EDT",
    "textBody": null,
    "textMessage": null,
    "toAddress": "majorhay@email.com",
    "toName": "Major Hay",
    "twilioAuthToken": null,
    "twilioSID": null,
    "waitListId": null,
    "waitListInviteUUId": null
}]

GET /emails/recurringAppointment/{recurringAppointmentId}

[{
    "attachFileLibraryUUids": null,
    "attachFileLibraryList": null,
    "attachments": null,
    "bccAddress": null,
    "body": null,
    "businessId": 43111,
    "calendarId": null,
    "ccAdress": null,
    "classScheduleId": null,
    "clientAccountId": null,
    "clientId": null,
    "createdDate": 1539784024186,
    "createdUser": "JoeSchmo",
    "dateProcessed": 1539784024814,
    "disclaimerFormUUid": null,
    "emailBecause": null,
    "emailCategory": {Email category object for email category of specified email - for more info, see Email Categories API page},
    "emailFinal": (HTML coding for final part of email),
    "emailFooter": null,
    "emailId": 33529680,
    "emailStatusId": 5,
    "emailTemplateId": 6033,
    "fromAddress": "noreply@timetap.com",
    "fromName": "Dog Groomers Anonymous",
    "gateway": null,
    "icalText": null,
    "invitationUUId": null,
    "invoiceId": null,
    "jobRequisitionId": null,
    "locale": null,
    "location": null,
    "modifiedDate": 1539784024217,
    "msgType": "EMAIL",
    "noHeader": null,
    "packageSoldId": null,
    "postmarkAPIKey": null,
    "professionalId": 77961,
    "recurringAppointmentId": 145055,
    "replyToAddress": "joeschmo@email.com",
    "s3FileName": null,
    "s3FinalFileName": "prod/43111/2018/final-0a0a8a9e055b48b2a5e5bfaf332ee170.html",
    "s3ICSFileName": null,
    "sendError": null,
    "sendId": "2fa10c89-c4c8-42a7-b4ae-1a9631472ae3",
    "sendgridAPIKey"; null,
    "sentAge": "8 hours ago",
    "status": "SENT",
    "subject": "[Appointments Changed] Your Appointments with Jimmy Begood",
    "templateName": null,
    "textBody": null,
    "textMessage": null,
    "toAddress": "joeschmo@email.com",
    "toName": Joe Schmo,
    "twilioAuthToken": null,
    "twilioSID": null,
    "waitListId": null,
    "waitListInviteUUId": null
}]

GET /emails/calendar/{calendarId}/recurringAppointment/{recurringAppointmentId}

[{
    "attachFileLibraryUUids": null,
    "attachFileLibraryList": null,
    "attachments": null,
    "bccAddress": null,
    "body": null,
    "businessId": 43111,
    "calendarId": 17558837,
    "ccAdress": null,
    "classScheduleId": null,
    "clientAccountId": null,
    "clientId": 4761823,
    "createdDate": 1539686856260,
    "createdUser": "ApptRemindClTextJob",
    "dateProcessed": 1539686864613,
    "disclaimerFormUUid": null,
    "emailBecause": null,
    "emailCategory": {Email category object for email category of specified email - for more info, see Email Categories API page},
    "emailFinal": (HTML coding for final part of email),
    "emailFooter": null,
    "emailId": 33481986,
    "emailStatusId": 6,
    "emailTemplateId": 11641,
    "fromAddress": "+1-704-315-6447",
    "fromName": "Dog Groomers Anonymous",
    "gateway": null,
    "icalText": null,
    "invitationUUId": null,
    "invoiceId": null,
    "jobRequisitionId": null,
    "locale": null,
    "location": null,
    "modifiedDate": 1539686856291,
    "msgType": "SMS",
    "noHeader": null,
    "professionalId": null,
    "recurringAppointmentId": null,
    "replyToAddress": "joeschmo@email.com",
    "s3FileName": null,
    "s3FinalFileName": "prod/43111/2018/final-8323c7fda1e94f3d826759c0e6ab0fe2.html",
    "s3ICSFileName": null,
    "sendError": "To Address is missing,
    "sendId": null,
    "sendgridAPIKey": null,
    "sentAge": "4 hours ago",
    "status": "FAILED",
    "subject": null,
    "templateName": null,
    "textBody": null,
    "textMessage": null,
    "toAddress": "",
    "toName": null,
    "twilioAuthToken": null,
    "twilioSID": null,
    "waitListId": null,
    "waitListInviteUUId": null
}]

GET /emails/client/{clientId}

[{
    "attachFileLibraryUUids": null,
    "attachFileLibraryList": null,
    "attachments": null,
    "bccAddress": null,
    "body": null,
    "businessId": 43111,
    "calendarId": 17713652,
    "ccAdress": null,
    "classScheduleId": null,
    "clientAccountId": null,
    "clientId": 5143212,
    "createdDate": 1535900711369,
    "createdUser": "ApptRemindClJob",
    "dateProcessed": 1535900713463,
    "disclaimerFormUUid": null,
    "emailBecause": null,
    "emailCategory": {Email category object for email category of specified email - for more info, see Email Categories API page},
    "emailFinal": (HTML coding for final part of email),
    "emailFooter": null,
    "emailId": 32296832,
    "emailStatusId": 5,
    "emailTemplateId": 11646,
    "fromAddress": "noreply@timetap.com",
    "fromName": "Dog Groomers Anonymous",
    "gateway": null,
    "icalText": null,
    "invitationUUId": null,
    "invoiceId": null,
    "jobRequisitionId": null,
    "locale": null,
    "location": null,
    "modifiedDate": 1535900775809,
    "msgType": "EMAIL",
    "packageSoldId": null,
    "postmarkAPIKey": null,
    "professionalId": null,
    "recurringAppointmentId": null,
    "replyToAddress": "joeschmo@email.com",
    "s3FileName": null,
    "s3FinalFileName": "prod/43111/2018/final-1d1e32a627be468fb65e68fcac35ab21.html",
    "s3ICSFileName": "43111/2018/ical-e366bc4c5b924ac4a04c3372016112b5.ics",
    "sendError": null,
    "sendId": "1b892b87-40a6-4ce0-ad37-892dae079daf",
    "sendgridAPIKey": null,
    "sentAge": "1 month ago",
    "status": "DELIVERED",
    "subject": "[Appointment Reminder] Mr. Biscuits on Monday, Sep 3, 2018 at 11:35 AM EDT",
    "templateName": null,
    "textBody": null,
    "textMessage": null,
    "toAddress": "samiam@email.com",
    "toName": "Sam Iam",
    "twilioAuthToken": null,
    "twilioSID": null,
    "waitListId": null,
    "waitListInviteUUId": null
}]

GET /emails/invoice/{invoiceId}

[{
    "attachFileLibraryUUids": null,
    "attachFileLibraryList": null,
    "attachments": null,
    "bccAddress": null,
    "body": (Html coding for body of email),
    "businessId": 43111,
    "calendarId": null,
    "ccAdress": null,
    "classScheduleId": null,
    "clientAccountId": null,
    "clientId": 4761823,
    "createdDate": 1539789567063,
    "createdUser": "JoeSchmo",
    "dateProcessed": 1539789567519,
    "disclaimerFormUUid": null,
    "emailBecause": null,
    "emailCategory": {Email category object for email category of specified email - for more info, see Email Categories API page},
    "emailFinal": (HTML coding for final part of email),
    "emailFooter": null,
    "emailId": 33534841,
    "emailStatusId": 6,
    "emailTemplateId": 11633,
    "fromAddress": "noreply@timetap.com",
    "fromName": "Dog Groomers Anonymous",
    "gateway": null,
    "icalText": null,
    "invitationUUId": null,
    "invoiceId": 453942,
    "jobRequisitionId": null,
    "locale": null,
    "location": null,
    "modifiedDate": 1539789567337,
    "msgType": "EMAIL",
    "noHeader": null,
    "packageSoldId": null,
    "postmarkAPIKey": null,
    "professionalId": null,
    "recurringAppointmentId": null,
    "replyToAddress": "joeschmo@email.com",
    "s3FileName": "prod/43111/body-a7575def34af48b38a977c7bfb9e599.html",
    "s3FinalFileName": "prod/43111/2018/final-33534841.html",
    "s3ICSFileName": null,
    "sendError": (Text of send error),
    "sendId": null,
    "sendgridAPIKey": null,
    "sentAge": "1 hour ago",
    "status": "FAILED",
    "subject": "Invoice",
    "templateName": null,
    "textBody": null,
    "textMessage": null,
    "toAddress": "janedeer@email.com",
    "toName": "Jane Deer",
    "twilioAuthToken": null,
    "twilioSID": null,
    "waitListId": null,
    "waitListInviteUUId": null
}]

GET /emails/invitation/{invitationUUId}

[{
    "businessId": 43111,
    "calendarId": null,
    "coordinatorStaffId": null,
    "createdDate": 1565286832664,
    "createdUser": "COCOMOE",
    "description": "Campaign for Beach, Coco moe, Guided meditation sent on 08/08/2019 @ 1:53PM",
    "disclaimerFormUUid": null,
    "email": null,
    "emailTemplateId": 70689,
    "employmentDurationType": null,
    "eventDefinitionList": null,
    "expireDate": null,
    "invitationCampaignId": 214329,
    "jobRequisitionId": null,
    "jobTitle": null,
    "locationId": null,
    "locationName": null,
    "modifiedDate": null,
    "modifiedUser": null,
    "parameterMap": null,
    "parameters": "{\"staffId\":\"298660\",\"coordStaffId\":\"298660\",\"reasonId\":\"153346\",\"locationId\":\"81181\",\"jobId\":\"57804\",\"clientId\":\"6110946\",\"requisitionNumber\":\"1\",\"jobRequisitionId\":\"62883\"}",
    "professionalId": 298660,
    "reasonId": null,
    "requisitionNumber": null,
    "staffId": null,
    "status": null,
    "waitListId": null
}]

GET /email/disclaimerForm/{disclaimerFormUUid}/DISCLAIMER_FORM_CLIENT

{
    "attachFileLibraryUUids": null,
    "attachFileLibraryList": null,
    "attachments": null,
    "bccAddress": null,
    "body": (Html coding for body of email),
    "businessId": 43111,
    "calendarId": 18964648,
    "ccAdress": null,
    "classScheduleId": null,
    "clientAccountId": null,
    "clientId": 5146945,
    "createdDate": 1542207032006,
    "createdUser": "JoeSchmo",
    "dateProcessed": null,
    "disclaimerFormUUid": "4dc48a9a-fb20-4002-b208-88040f921a5b",
    "emailBecause": null,
    "emailCategory": {Email category object for email category of specified email - for more info, see Email Categories API page},
    "emailFinal": (HTML coding for final part of email),
    "emailFooter": null,
    "emailId": 33732751,
    "emailStatusId": 1,
    "emailTemplateId": 10470,
    "fromAddress": "noreply@timetap.com",
    "fromName": "Dog Groomers Anonymous",
    "gateway": null,
    "icalText": null,
    "invitationUUId": null,
    "invoiceId": null,
    "jobRequisitionId": null,
    "locale": null,
    "location": null,
    "modifiedDate": null,
    "msgType": null,
    "noHeader": null,
    "packageSoldId": null,
    "postmarkAPIKey": null,
    "professionalId": 82275,
    "recurringAppointmentId": null,
    "replyToAddress": "",
    "s3FileName": null,
    "s3FinalFileName": null,
    "s3ICSFileName": null,
    "sendError": null,
    "sendId": null,
    "sendgridAPIKey": null,
    "sentAge": null,
    "status": "QUEUED",
    "subject": "Please fill out this form",
    "templateName": null,
    "textBody": (Text for the body of the email),
    "textMessage": null,
    "toAddress": "jaykay@email.com",
    "toName": "Jay Kay",
    "twilioAuthToken": null,
    "twilioSID": null,
    "waitListId": null,
    "waitListInviteUUId": null
}

GET /emails/status/bounced

[{
    "attachFileLibraryUUids": null,
    "attachFileLibraryList": null,
    "attachments": null,
    "bccAddress": null,
    "body": null,
    "businessId": 43111,
    "calendarId": 17728011,
    "ccAdress": null,
    "classScheduleId": null,
    "clientAccountId": null,
    "clientId": 5147422,
    "createdDate": 1535557599326,
    "createdUser": "WebClient",
    "dateProcessed": 1535557599922,
    "disclaimerFormUUid": null,
    "emailBecause": null,
    "emailCategory": {Email category object for email category of specified email - for more info, see Email Categories API page},
    "emailFinal": (HTML coding for final part of email),
    "emailFooter": null,
    "emailId": 32219940,
    "emailStatusId": 5,
    "emailTemplateId": 11638,
    "fromAddress": "noreply@timetap.com",
    "fromName": "Dog Groomers Anonymous",
    "gateway": null,
    "icalText": null,
    "invitationUUId": null,
    "invoiceId": null,
    "jobRequisitionId": null,
    "locale": null,
    "location": null,
    "modifiedDate": 1535557629817,
    "msgType": "EMAIL",
    "noHeader": null,
    "packageSoldId": null,
    "postmarkAPIKey": null,
    "professionalId": 77961,
    "recurringAppointmentId": null,
    "replyToAddress": "joeschmo@email.com",
    "s3FileName": null,
    "s3FinalFileName": "prod/43111/2018/final-58d8e9484af844a879fbaa1258fef26db.html",
    "s3ICSFileName": "43111/2018/992c0b837b04b13bc0846dd71532743.ics",
    "sendError": "The server was unable to deliver your message.",
    "sendId": "8b386f11-fba1-4922-9dc0-8508673e83c0",
    "sendgridAPIKey": null,
    "sentAge": "2 months ago",
    "status": "BOUNCED",
    "subject": "[Appointment] Joe Schmo on Thursday, Aug 30, 2018 at 10:00 AM EDT",
    "templateName": null, 
    "textBody": null,
    "textMessage": null,
    "toAddress": "jair@email.com",
    "toName": "Joan Air",
    "twilioAuthToken": null,
    "twilioSID": null,
    "waitListId": null,
    "waitListInviteUUId": null
}]

GET /email/waitlist/{waitlistId}/{emailTemplateCode}

{
    "attachFileLibraryUUids": null,
    "attachmentFileLibraryList": null,
    "attachments": null,
    "bccAddress": null,
    "body": null,
    "businessId": 19714,
    "calendarId": null,
    "ccAddress": null,
    "classScheduleId": null,
    "clientAccountId": null,
    "clientId": 2177331,
    "createdDate": 1610726381931,
    "createdUser": "JoeSchmo",
    "dateProcessed": null,
    "disclaimerFormUUid": null,
    "emailBecause": null,
    "emailCatagory": {Email category object for email category of specified email - for more info, see email categories API page},
    "emailFinal": (HTML coding for final part of email),
    "emailFooter": null,
    "emailId": null,
    "emailStatusId": 1,
    "emailTemplateId": 7910,
    "fromAddress": "noreply@timetap.com",
    "fromName": "tt-tpr9",
    "gateway": null,
    "icalText": null,
    "invitationUUId": null,
    "invoiceId": null,
    "jobRequisitionId": null,
    "locale": null,
    "location": null,
    "modifiedDate": null,
    "msgType": null,
    "noHeader": null,
    "packageSoldId": null,
    "postmarkAPIKey": null,
    "professionalId": 42945,
    "recurringAppointmentId": null,
    "replyToAddress": "joel@addysystems.com",
    "s3FileName": null,
    "s3FinalFileName": null,
    "s3ICSFileName": null,
    "sendError": null,
    "sendId": null,
    "sendgridAPIKey": null,
    "sentAge": null,
    "status": "QUEUED",
    "subject": (Subject for email sent),
    "templateName":
    "textBody": (Text for body of email sent),
    "textMessage": false,
    "toAddress": "joel@timetap.com",
    "toName": "Joel Test",
    "twilioAuthToken": null,
    "twilioSID": null,
    "waitListId": 15907,
    "waitListInviteUUId": null
}

POST /emailDelivery

[{
    "bounceSubType": null,
    "bounceType": null,
    "dateCreated": 1539786211929,
    "diagnosticCode": null,
    "emailAddress": "joeschmo@email.com",
    "emailDeliveryId": "8a8082e6666e6fe30166826902592dbf",
    "emailId": null,
    "jsonText": {Json text for specified email},
    "messageId": "d9da3647-e0f0-48bb-8081-a6e14ec7f651",
    "notificationType": "open"
}]

POST /email/calendar/{calendarId}/{emailCategoryCode}

{
    "attachFileLibraryUUids": null,
    "attachFileLibraryList": null,
    "attachments": null,
    "bccAddress": null,
    "body": (Html coding for body of email sent),
    "businessId": 43111,
    "calendarId": 18377225,
    "ccAdress": null,
    "clientId": 5360110,
    "createdDate": 1540223449022,
    "createdUser": "JoeSchmo",
    "dateProcessed": null,
    "disclaimerFormUUid": null,
    "emailBecause": null,
    "emailCategory": {Email category object for email category of specified email sent - for more info, see Email Categories API page},
    "emailFinal": null,
    "emailFooter": null,
    "emailId": 32219940,
    "emailStatusId": 1,
    "emailTemplateId": 72108,
    "fromAddress": "noreply@timetap.com",
    "fromName": "Dog Groomers Anonymous",
    "gateway": null,
    "icalText": null,
    "invitationUUId": null,
    "invoiceId": null,
    "jobRequisitionId": null,
    "locale": null,
    "location": "testfile",
    "modifiedDate": 1535557629817,
    "msgType": null,
    "professionalId": 82275,
    "recurringAppointmentId": null,
    "replyToAddress": "joeschmo@email.com",
    "s3FileName": null,
    "s3FinalFileName": null,
    "s3ICSFileName": null,
    "sendError": null,
    "sendId": "8b386f11-fba1-4922-9dc0-8508673e83c0",
    "sentAge": "2 months ago",
    "status": "BOUNCED",
    "subject": "[Appointment] Joe Schmo on Thursday, Aug 30, 2018 at 10:00 AM EDT",
    "textBody": null,
    "toAddress": "jair@email.com",
    "toName": "Joan Air",
    "waitListId": null,
    "waitListInviteUUId": null
}

emails

Property Name	Type	Description
atachFileLibraryUUids	array	Displays as an array containing all UUIds of attachments for the specified email.
bccAddress	string	Displays as the Bcc of the specified email.
body	string	Displays as the HTML coding for Body of the specified email.
businessId	integer	Provides unique numeric ID for the business to which the specified email belongs.
calendarId	integer	Provides unique numeric ID for the appointment connected to the specified email.
ccAddress	string	Displays as the Cc of the specified email.
clientId	integer	Provides unique numeric ID for the client connected to the specified email.
classScheduleId	integer	Provides unique numeric ID for the class schedule connected to the specified email.
clientAccountId	integer	If the client connected to the specified email has registered on the scheduler or you have provided the client with a password to the scheduler, this would provide their unique numeric ID for the scheduler login.
createdDate	integer	Displays as date the specified email was created in milliseconds elapsed since January 1, 1970 00:00:00 UTC form.
createdUser	string	Displays the username of user who created the specified email.
dateProcessed	integer	Displays as date the specified email got processed in milliseconds elapsed since January 1, 1970 00:00:00 UTC form.
disclaimerFormUUid	string	Provides unique alphanumeric ID of any disclaimer form connected to the specified email.
emailBecause	string	Displays as the reason the specified email was sent.
emailCategory	object	Displays as email category object of the specified email.
emailFinal	string	Displays as the final part of the specified email.
emailFooter	string	Displays as the Footer of the specified email.
emailId	integer	Provides unique numeric ID for the specified email.
emailStatusId	integer	Provides unique numeric ID for the email status connected to the specified email.
emailTemplateId	integer	Provides unique numeric ID for the email template connected to the specified email.
fromAddress	string	Displays as the From Address of the specified email.
fromName	string	Displays as the From Name of the specified email.
gateway	string	Displays as unique email sending provider/gateway if default (Postmark) is not used.
icalText	string	Set to the HTML value for any .ics file attachment sent with the specified email.
invitationUUId	string	Provides unique alphanumeric ID for any invitation connected to the specified email.
invoiceId	integer	Displays as unique numeric ID of any invoice connected to the specified email.
jobRequisitionId	integer	Provides unique numeric ID for any job requisitions connected to the specified email.
locale	string	Displays as language/locale of the specified email.
location	string	Displays as the Location of the specified email.
modifiedDate	integer	Displays as date the specified email was last modified in milliseconds elapsed since January 1, 1970 00:00:00 UTC form.
msgType	string	Displays as the message type of the specified email. Has available options "EMAIL" and "SMS".
noHeader	boolean	Indicates whether or not the specified email uses no header.
packageSoldId	integer	Provides unique numeric ID for any packages sold connected to the specified email.
postmarkAPIKey	string	If the account uses Postmark to send emails, this displays as the Postmark API key connected to the specified email.
professionalId	integer	Provides unique numeric ID of any staff connected to the specified email.
recurringAppointmentId	integer	Displays as unique numeric ID of any recurring appointment series the specified email belongs to.
replyToAddress	string	Displays as the Reply to Address of the specified email.
s3FileName	string	Displays as the location/name of the specified email file as stored in Amazon Web Services repository.
s3FinalFileName	string	Displays as the final file location/name of the specified email file as stored in Amazon Web Services repository.
s3ICSFileName	string	Displays as the ICS file name of the specified email file as stored in Amazon Web Services repository.
sendError	string	Displays as the Send Error of the specified email.
sendId	string	Provides unique alphanumeric ID for sent email.
sendgridAPIKey	string	If the account uses Sendgrid to send emails, this displays as the Sendgrid API Key connected to the specified email.
sentAge	string	Displays as how long ago the specified email was sent.
status	string	Displays as status of the specified email. Has available options "DELIVERED", "OPENED", "FAILED", "BOUNCED".
subject	string	Displays as the Subject of the specified email.
toAddress	string	Displays as the To Address of the specified email.
toName	string	Displays as the To Name of the specified email.
twilioAuthToken	string	Provides the Twilio auth token connected to the specified email.
twilioSID	string	Displays as the Twilio String Identifier connected to the specified email.
waitListId	integer	Provides unique numeric ID of any waitlist connected to the specified email.
waitListInviteUUId	string	Provides unique alphanumeric ID of any waitlist invite connected to the specified email.

emailDelivery

Property Name	Type	Description
bounceSubType	string	Gives greater description as to the bounce type reason
bounceType	string	Indicates whether the bounce was a permanent bounce, transient bounce, or if it was undetermined
dateCreated	integer	Displays as date the specified email delivery was created in milliseconds elapsed since January 1, 1970 00:00:00 UTC form.
diagnosticsCode	string	Displays as reason the specified email delivery was unable to send.
emailAddress	string	Displays as email address the specified email delivery was sent to.
emailDeliveryId	string	Provides unique numeric ID for the specified email delivery.
emailId	integer	Provides unique numeric ID for email connected to the specified email delivery.
jsonText	string	Displays as JSON text for the specified email delivery.
messageId	string	Provides unique alphanumeric ID for the specified email delivery.
notificationType	string	Displays as type of notification connected to the specified email delivery.

TimeTap API

Emails

Emails API Endpoints

Emails API Parameters

Emails API Request Body/Payloads

Emails API Responses

Emails Object Values

emails

emailDelivery