Skip to main content
New to Corsair? See API access, authentication, and error handling.

Anchor Time Dates

create

anchorTimeDates.create Use this function to create a new anchortime for a specific date. Risk: write
Input Output: undefined \| object \| object[]

delete

anchorTimeDates.delete Use this function to delete an anchortime by date. Risk: destructive
Input Output: undefined \| object \| object[]

list

anchorTimeDates.list Use this function if you want to get all information about anchortimes by date. Risk: read
Input Output: object[]

update

anchorTimeDates.update Use this function to update an anchortime by date. Risk: write
Input Output: undefined \| object \| object[]

Anchor Times

create

anchorTimes.create Use this function to create a new weekly anchortime. Risk: write
Input Output: undefined \| object \| object[]

delete

anchorTimes.delete Use this function to delete a weekly anchortime. Risk: destructive
Input Output: undefined \| object \| object[]

list

anchorTimes.list Use this function if you want to get all information about weekly anchortimes. Risk: read
Input Output: object[]

update

anchorTimes.update Use this function to update a weekly anchortime. Risk: write
Input Output: undefined \| object \| object[]

Appointments

create

appointments.create Use this function to create a new appointment in the eTermin calendar Risk: destructive
Input Output: empty object

delete

appointments.delete Use this function to delete an appointment in the eTermin calendar. You can either use the id of a specific appointment or the start/end parameters to delete all appointments within a specific time span. Risk: destructive
Input Output: undefined \| object \| object[]

list

appointments.list Use this function if you want to get all appointment details that are stored on the eTermin platform. You can use the start/end parameters the get all appointments within a specific time span or the id parameter to get the appointment details of a specific appointment. <br><b>At least one parameter is mandatory!</b> Risk: read
Input Output: object[]

update

appointments.update Use this function if you want to update details of an existing appointment. Risk: destructive
Input Output: undefined \| object \| object[]

Appointment Sync

create

appointmentSync.create Create a new appointment Risk: destructive
Input Output: undefined \| object \| object[]

delete

appointmentSync.delete Use this function to delete an appointment in the eTermin calendar. You can either use the id of a specific appointment or the start/end parameters to delete all appointments within a specific time span. Risk: destructive
Input Output: undefined \| object \| object[]

list

appointmentSync.list Gets all inserted (I), modified (U) and deleted (D) appointments that were modified on the eTermin platform. The parameter ‘SyncStatus’ contains the status of the appointment (U, I, D). You can call this function e.g. every 5 minutes to get all appointments that were added, modified or deleted within the last 5 minutes on the eTermin platform. Important: If the SyncStatus returns ‘U’ and the appointment does not exist in your application, please insert this appointment in your application. There can be cases that the ‘SyncStatus’ returns ‘U’ although the appointment does not yet exist in your application. Risk: read
Input Output

update

appointmentSync.update Update an existing appointment Risk: write
Input Output: undefined \| object \| object[]

Booking Page Logs

list

bookingPageLogs.list Use this function if you want to get all requests of your booking page. You can only get the booking page requests of the last 30 days. Risk: read
Input Output: object[]

Calendar Non Working Times

create

calendarNonWorkingTimes.create Use this function to create a new absence. Risk: write
Input Output: undefined \| object \| object[]

delete

calendarNonWorkingTimes.delete Use this function to delete an absence. Risk: destructive
Input Output: undefined \| object \| object[]

list

calendarNonWorkingTimes.list Use this function if you want to get information about absences for a calendar. Risk: read
Input Output: object[]

update

calendarNonWorkingTimes.update Use this function to update an absence. Risk: write
Input Output: undefined \| object \| object[]

Calendar Return Times

create

calendarReturnTimes.create Use this function to create a new return time. Risk: write
Input Output: undefined \| object \| object[]

delete

calendarReturnTimes.delete Use this function to delete a return time by its ID. Risk: destructive
Input Output: undefined \| object \| object[]

list

calendarReturnTimes.list Use this function if you want to get information about return times for a calendar. Risk: read
Input Output: object[]

update

calendarReturnTimes.update Use this function to update a return time. Risk: write
Input Output: undefined \| object \| object[]

Calendars

create

calendars.create Use this function to create a new calendar Risk: write
Input: empty object Output: undefined \| object \| object[]

delete

calendars.delete Use this function if you want to delete a calendar Risk: destructive
Input Output: undefined \| object \| object[]

list

calendars.list Returns all calendars that are available for the specific account. Risk: read
Input Output: object[]

update

calendars.update Use this function if you want to update details of an existing calendar/employee/ressource. Risk: write
Input Output: undefined \| object \| object[]

Calendar Services

create

calendarServices.create Creates a new service assignment of a calendar Risk: write
Input Output: undefined \| object \| object[]

delete

calendarServices.delete Use this function if you want to delete a calendar/service assignment, given by its calendar and service Risk: destructive
Input Output: undefined \| object \| object[]

list

calendarServices.list Returns all assigned services of a calendar Risk: read
Input Output: object[]

Contact Frequencies

create

contactFrequencies.create Creates contact frequency that limites the amount of bookings a contact can have. The login on the booking page has to be activated to use this function. Risk: write
Input Output: empty object

list

contactFrequencies.list Returns the frequency setting of the contact. Risk: read
Input Output: object[]

Contacts

create

contacts.create Creates a new contact. You can see the new contact in the eTermin CRM. Risk: write
Input Output: empty object

delete

contacts.delete Use this function if you want to delete a contact in the eTermin CRM. You can either use the email address or the ID to delete the contact. Risk: destructive
Input Output: empty object

list

contacts.list Returns a list with all contacts that are maintained in the eTermin CRM. Risk: read
Input Output: object[]

update

contacts.update Use this function if you want to update details of an existing contact. Risk: write
Input Output: empty object

Contact Services

create

contactServices.create Creates contact permission to specific service groups. The login on the booking page has to be activated to use this function. Risk: write
Input Output: empty object

list

contactServices.list Returns a list of the permissions of the contact. Risk: read
Input Output: object[]

Deleted Appointments

list

deletedAppointments.list Returns all appointments that got deleted during the specified time span. Risk: read
Input Output: object[]

Message Logs

list

messageLogs.list Returns a list with all messages that are sent via eTermin. Note: You can only get the list for the last 30 days or less, depending on your privacy settings in the account Risk: read
Input Output: object[]

Ratings

list

ratings.list Returns all the ratings that were received from the customers. Risk: read
Input: empty object Output: object[]

Service Calendars

list

serviceCalendars.list Returns a list of all calendars that are compatible with one of the provided serviceid(s) Risk: read
Input Output: object[]

Service Groups

create

serviceGroups.create Creates a new service group Risk: write
Input Output: empty object

delete

serviceGroups.delete Use this function if you want to delete a service group. All services that are linked to this service group will be deleted automatically as well. Risk: destructive
Input Output: empty object

list

serviceGroups.list Returns all service groups that are available for the specific account. Risk: read
Input Output: object[]

update

serviceGroups.update Updates attributes of a service group Risk: write
Input Output: empty object

Services

create

services.create Use this function if you want to create a service. Note: Most services only need the first few parameters. However, since the services are very versatile, they have much more parameters, especially because they may override global settings. Risk: write
Input Output: empty object

delete

services.delete Use this function if you want to delete a service. Risk: destructive
Input Output: undefined \| object \| object[]

list

services.list Use this function if you want to get details of an existing service or all services. Risk: read
Input Output: object[]

update

services.update Use this function if you want to update details of an existing service. Risk: write
Input Output: empty object

Survey Results

list

surveyResults.list Returns all survey results that were received from the customers. Risk: read
Input Output: object[]

Time Slots

list

timeSlots.list Get available time slots of a specific day or a time range.<br><br> <font color=red>Important:</font> Please pay attention that <b>some fields might be mandatory</b> to not get an empty response, <b>depending how the account is set up</b> (for example serviceid). Risk: read
Input Output: object[]

User Mappings

create

userMappings.create Usermapping is used for the number search. Use this function to create a new entry for the number search. Risk: write
Input Output: empty object

delete

userMappings.delete Usermapping is used for the number search. Use this function to update an existing entry for the number search. Risk: destructive
Input Output: empty object

list

userMappings.list Usermapping is used for the number search. Use this function to validate a searchvalue to get the according calendarids and servicegroupids Risk: read
Input Output: object[]

update

userMappings.update Usermapping is used for the number search. Use this function to update an existing entry for the number search. Risk: write
Input Output: empty object

Vouchers

create

vouchers.create Creates a new voucher Risk: write
Input Output: empty object

delete

vouchers.delete Use this function if you want to delete a voucher. Use one of the given parameters! Risk: destructive
Input Output: empty object

list

vouchers.list Returns a list with all vouchers Risk: read
Input: empty object Output: object[]

update

vouchers.update Update an existing voucher, found by its internal iid (from vouchers.list), not its code Risk: write
Input Output: empty object

Working Time Dates

create

workingTimeDates.create Creates a new working slot for a specific day Risk: write
Input Output: empty object

delete

workingTimeDates.delete Delete a working slot for a specific date. Only one of the following parameters are needed Risk: destructive
Input Output: empty object

list

workingTimeDates.list Get working time slots for specific dates Risk: read
Input Output: object[]

update

workingTimeDates.update Update an existing working slot for a specific date Risk: write
Input Output: empty object

Working Times

create

workingTimes.create Creates a new working slot Risk: write
Input Output: empty object

delete

workingTimes.delete Deletes a working slot Risk: destructive
Input Output: empty object

list

workingTimes.list Get working time slots for weekdays Risk: read
Input Output: object[]

update

workingTimes.update Update an existing working slot Risk: write
Input Output: empty object