Unavailable Block

UnavailableBlock

archived_at
string or null <date-time>
object
object or null
created_at
string <date-time>
deleted_at
string or null <date-time>
ends_at
string <date-time>
id
string <int64>
object
notes
string or null
object
object or null
object
object or null
starts_at
string <date-time>
updated_at
string <date-time>
{}

List unavailable blocks

get/unavailable_blocks
SecuritybasicAuth
Request
query Parameters
order
string
Deprecated
Enum: "asc" "desc"
page
integer
per_page
integer [ 1 .. 100 ]
q[]
Array of strings

Filter result by one or more fields.

See Filtering Results

Available filters:

Value Format
archived_at date-time
business_id int64
created_at date-time
deleted_at date-time
ends_at date-time
id int64
practitioner_id int64
repeated_from_id int64
starts_at date-time
updated_at date-time
sort
Array of strings

Comma separated search fields. See: Ordering

Example: sort=created_at:desc
Responses
200

successful operation

Request samples
Response samples
application/json
{}

Create unavailable block

post/unavailable_blocks
SecuritybasicAuth
Request
Request Body schema: application/json
business_id
string <int64>

business id

ends_at
string <date-time>
notes
string or null
practitioner_id
string <int64>

practitioner id

object or null
starts_at
string <date-time>
Responses
201

Resource was created

422

Resource could not be saved due to validation errors

Request samples
application/json
{
  • "business_id": "1",
  • "ends_at": "2019-08-24T14:15:22Z",
  • "notes": "string",
  • "practitioner_id": "1",
  • "starts_at": "2019-08-24T14:15:22Z",
  • "repeat_rule": {
    • "number_of_repeats": 0,
    • "repeat_type": "Daily",
    • "repeating_interval": 0
    }
}
Response samples
application/json
{}

Get unavailable block

get/unavailable_blocks/{id}
SecuritybasicAuth
Request
path Parameters
id
required
string <int64>
query Parameters
q[]
Array of strings

Filter result by one or more fields.

See Filtering Results

Available filters:

Value Format
archived_at date-time
deleted_at date-time
Responses
200

Successful operation

Request samples
Response samples
application/json
{}

Update unavailable block

patch/unavailable_blocks/{id}
SecuritybasicAuth
Request
path Parameters
id
required
string <int64>
Request Body schema: application/json
business_id
string <int64>

business id

ends_at
string <date-time>
notes
string or null
practitioner_id
string <int64>

practitioner id

object or null
starts_at
string <date-time>
Responses
200

Resource was updated

422

Resource could not be saved due to validation errors

Request samples
application/json
{
  • "business_id": "1",
  • "ends_at": "2019-08-24T14:15:22Z",
  • "notes": "string",
  • "practitioner_id": "1",
  • "starts_at": "2019-08-24T14:15:22Z",
  • "repeat_rule": {
    • "number_of_repeats": 0,
    • "repeat_type": "Daily",
    • "repeating_interval": 0
    }
}
Response samples
application/json
{}

Archive unavailable blockDeprecated

delete/unavailable_blocks/{id}
SecuritybasicAuth
Request
path Parameters
id
required
string <int64>
Responses
204

Resource was archived successfully

Request samples

Archive unavailable block

post/unavailable_blocks/{id}/archive
SecuritybasicAuth
Request
path Parameters
id
required
string <int64>
Responses
204

Resource was archived

Request samples

Get conflicts for an unavailable block

get/unavailable_blocks/{id}/conflicts
SecuritybasicAuth
Request
path Parameters
id
required
string <int64>
Responses
200

Successful operation

Request samples
Response samples
application/json
{
  • "conflicts": {
    • "exist": true
    }
}