{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/available_slots","auth":"required","examples":{"codes":[{"code":"curl -X POST -H 'Content-Type: application/json' -d '{\"stage_ids\":[\"6cfc448c-c146-4594-82bb-55f6eb962601\"],\"recruiter_email\":\"recruiter:::at:::example.com\",\"start_time\":\"2018-08-14T18:25:00.000Z\",\"end_time\":\"2018-08-14T18:45:00.000Z\",\"max_attendees\":\"2\",\"instructions\":\"my instructions\",\"api_token\":\"secret-token\"}' 'https://api.fountain.com/v2/available_slots'","language":"curl"}]},"method":"post","results":{"codes":[{"language":"json","code":"[{\"start_time\":\"Wed, Oct 24 @11:25am PDT\",\"end_time\":\"Wed, Oct 24 @11:45am PDT\",\"location\":null,\"recruiter\":\"My Name\",\"max_attendees\":2,\"booked_slots_count\":0,\"id\":\"c3481151-82bf-4cde-a612-b1f77fa372c5\"}]","name":"","status":201},{"status":422,"language":"json","code":"{\"message\":\"Validation failed: Stages can't be blank\"}","name":""},{"status":401,"language":"text","code":"{\"message\":\"Authentication is required\"}"}]},"settings":"","params":[{"name":"api_token","type":"string","default":"secret-api-token","desc":"required if not passed in through header","required":true,"in":"query","ref":"","_id":"56cb4a720549f0130068ded6"},{"name":"stage_ids","type":"array_string","default":"[\"d22f7b84-d401-46bf-8347-91a140985557\",\"74acbd7d-cb9d-4e9d-9247-a945152b2b4f\"]","desc":"List of stages","required":true,"in":"query","ref":"","_id":"5ea1e2547d59a00043e76b70"},{"name":"recruiter_email","type":"string","default":"[email protected]","desc":"Email address of recruiter","required":true,"in":"query","ref":"","_id":"5ea1e2547d59a00043e76b6f"},{"name":"start_time","type":"timestamp","default":"2020-04-23T18:25:00.000Z","desc":"Start time of the appointment in toJson() format","required":false,"in":"query","ref":"","_id":"5ea1e2547d59a00043e76b6e"},{"name":"end_time","type":"timestamp","default":"2020-04-23T18:45:00.000Z","desc":"End time of the appointment in toJson() format","required":true,"in":"query","ref":"","_id":"5ea1e2547d59a00043e76b6d"},{"name":"max_attendees","type":"string","default":"5","desc":"Maximum number of attendees, must be greater than zero","required":true,"in":"query","ref":"","_id":"5ea1e2547d59a00043e76b6c"},{"name":"location","type":"string","default":"Stoltenbergburgh","desc":"Location of the appointment","required":false,"in":"query","ref":"","_id":"5ea1e2547d59a00043e76b6b"},{"name":"period","type":"string","default":"weekly","desc":"Repeat this slot? Values can be “daily”, “weekly”, or “weekdays”","required":false,"in":"query","ref":"","_id":"5ea1e2547d59a00043e76b6a"},{"name":"frequency","type":"int","default":"2","desc":"Number of days or weeks to repeat this slot; number between 1 and 30","required":false,"in":"query","ref":"","_id":"5ea1e2547d59a00043e76b69"},{"name":"split","type":"int","default":"15","desc":"Number of minutes to split each session into","required":false,"in":"query","ref":"","_id":"5ea1e2547d59a00043e76b68"},{"name":"title","type":"string","default":"In-person interview","desc":"Name of the event","required":false,"in":"query","ref":"","_id":"5ea1e2547d59a00043e76b67"},{"name":"instructions","type":"string","default":"Please arrive on time!","desc":"Instructions for attendees","required":false,"in":"query","ref":"","_id":"5ea1e2547d59a00043e76b66"}]},"next":{"description":"","pages":[]},"title":"Create Slots","type":"endpoint","slug":"create-slots","excerpt":"","body":"Create calendar slots.","updates":[],"order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5bd0c4a399cfce002a3ba432","project":"59de6011debd1200240f68ec","version":{"version":"2.0","version_clean":"2.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["59de6011debd1200240f68fb","59de6011debd1200240f68fa","59de6011debd1200240f68fc","59de6011debd1200240f68f8","59de6011debd1200240f68f7","59de6011debd1200240f68f9","59de6011debd1200240f68fd","59de6011debd1200240f68fe","59de6011debd1200240f68ff","5a8bfb99f4146e00449cec47","5a8bfcf2e86f530012159bb2","5cd4c29c6ea1040056ec0f55"],"_id":"59de6011debd1200240f68ee","__v":3,"project":"59de6011debd1200240f68ec","createdAt":"2016-06-20T18:15:42.514Z","releaseDate":"2016-06-20T18:15:42.514Z"},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Session and Slot Management","slug":"available-slots-management","order":6,"from_sync":false,"reference":false,"_id":"59de6011debd1200240f68f8","__v":0,"project":"59de6011debd1200240f68ec","version":"59de6011debd1200240f68ee","createdAt":"2016-02-22T07:01:46.643Z"},"user":"547504ed59fade080004cb8b","createdAt":"2018-10-24T19:14:43.840Z","__v":12,"parentDoc":null}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

api_token:
required
stringsecret-api-token
required if not passed in through header
stage_ids:
required
array of strings["d22f7b84-d401-46bf-8347-91a140985557","74acbd7d-cb9d-4e9d-9247-a945152b2b4f"]
List of stages
recruiter_email:
required
string[email protected]
Email address of recruiter
start_time:
timestamp2020-04-23T18:25:00.000Z
Start time of the appointment in toJson() format
end_time:
required
timestamp2020-04-23T18:45:00.000Z
End time of the appointment in toJson() format
max_attendees:
required
string5
Maximum number of attendees, must be greater than zero
location:
stringStoltenbergburgh
Location of the appointment
period:
stringweekly
Repeat this slot? Values can be “daily”, “weekly”, or “weekdays”
frequency:
integer2
Number of days or weeks to repeat this slot; number between 1 and 30
split:
integer15
Number of minutes to split each session into
title:
stringIn-person interview
Name of the event
instructions:
stringPlease arrive on time!
Instructions for attendees

Examples


Result Format


Documentation

Create calendar slots.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}