The Availability Of Slots object

Attributes

id string

Unique identifier for the object.

idx integer
parent_id string
parent_type string
day_of_week string required
from_time string required
to_time string required
The Availability Of Slots object 
{
  "id": "availability-of-slots_abc123",
  "idx": 1,
  "parent_id": null,
  "parent_type": "parent_type_example",
  "day_of_week": "day_of_week_example",
  "from_time": "from_time_example",
  "to_time": "to_time_example"
}
GET /api/crm/availability-of-slots?parent_id={id}

List availability of slotss by parent

Returns all availability of slotss belonging to the specified parent.

Query parameters

parent_id string required

The ID of the parent to list children for.

Returns

A list of availability of slots objects belonging to the parent.

GET /api/crm/availability-of-slots?parent_id={id} 
curl https://api.overplane.dev/api/crm/availability-of-slots?parent_id=parent_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "availability-of-slots_abc123",
      "idx": 1,
      "parent_id": null,
      "parent_type": "parent_type_example",
      "day_of_week": "day_of_week_example",
      "from_time": "from_time_example",
      "to_time": "to_time_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/crm/availability-of-slots

Create a availability of slots

Creates a new availability of slots object.

Body parameters

idx integer
parent_id string
parent_type string
day_of_week string required
from_time string required
to_time string required

Returns

Returns the newly created availability of slots object if the call succeeded.

POST /api/crm/availability-of-slots 
curl https://api.overplane.dev/api/crm/availability-of-slots \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"day_of_week":"day_of_week_example","from_time":"from_time_example","to_time":"to_time_example"}'
Response 
{
  "id": "availability-of-slots_abc123",
  "idx": 1,
  "parent_id": null,
  "parent_type": "parent_type_example",
  "day_of_week": "day_of_week_example",
  "from_time": "from_time_example",
  "to_time": "to_time_example"
}
PATCH /api/crm/availability-of-slots/{id}

Update a availability of slots

Updates the specified availability of slots by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Path parameters

id string required

The identifier of the availability of slots to update.

Body parameters

idx integer
parent_id string
parent_type string
day_of_week string
from_time string
to_time string

Returns

Returns the updated availability of slots object.

PATCH /api/crm/availability-of-slots/{id} 
curl https://api.overplane.dev/api/crm/availability-of-slots/availability-of-slots_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"idx":1,"parent_id":null}'
Response 
{
  "id": "availability-of-slots_abc123",
  "idx": 1,
  "parent_id": null,
  "parent_type": "parent_type_example",
  "day_of_week": "day_of_week_example",
  "from_time": "from_time_example",
  "to_time": "to_time_example"
}
DELETE /api/crm/availability-of-slots/{id}

Delete a availability of slots

Permanently deletes a availability of slots. This cannot be undone.

Path parameters

id string required

The identifier of the availability of slots to delete.

Returns

Returns a confirmation that the availability of slots has been deleted.

DELETE /api/crm/availability-of-slots/{id} 
curl https://api.overplane.dev/api/crm/availability-of-slots/availability-of-slots_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "availability-of-slots_abc123",
  "deleted": true
}
POST /api/crm/availability-of-slots/reorder

Reorder availability of slotss

Updates the sort order of availability of slotss within their parent by setting new index values.

Returns

Returns the reordered list.

POST /api/crm/availability-of-slots/reorder 
curl https://api.overplane.dev/api/crm/availability-of-slots/reorder \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "availability-of-slots_abc123",
  "idx": 1,
  "parent_id": null,
  "parent_type": "parent_type_example",
  "day_of_week": "day_of_week_example",
  "from_time": "from_time_example",
  "to_time": "to_time_example"
}