Create a blockout time for an employee

This API helps you to create a blockout time for the specified employee.

You must specify the unique identifier of the employee as employee_id in the API request.

Request Body Parameters

NameTypeDescription
center_idguidUnique 32-character identifier of the center in which the blockout time is to be created.
block_out_time_type_idintType of blockout time.
start_timedatetimeDate and time (center) on which block out time started.
end_timedatetimeDate and time (center) on which block out time ended.
notesstringNotes/description stored during the creation of blockout time.
modeint0 - create new recurrence breaks and 1 - modify recurrence existing breaks.
recurring_block_out_timeobjectObject that contains all recurring blockout time-related elements.

Response Details

NameTypeDescription
block_out_timesobjectObject that contains the list of block out times between start date and end date.
errorobjectObject that contains error code and error message-related details. For more information, refer to the error Object table.

error Object

Error CodeError Message
502Cannot create the blockouttime on center holiday.
1004Not a valid Employee. Please check.
500Object reference not set to an instance of an object.
503Any one of center_id, employee_id, block_out_time_type_id, start_time, or end_time are missing"
400The request is invalid.
1004time difference between start_time and end_time should be greater than zero and should not exceed 12hours".
712service_provider_01 e is busy at this time.
503Invalid interval or occurences or rec_end_date are passed.
503Any one of the time_period, rec_start_date or interval is missing while creating recurring block out time.
503both occurences or rec_end_date are passed.
503BlockOutTimeRequest object is not supplied.
503any one of the occurences or rec_end_date are not passed.
503Any one of the time_period, rec_start_date or interval is missing while creating recurring block out time.
Language
Authentication
Header
Click Try It! to start a request and see the response here!