{"_id":"5bd0c4a399cfce002a3ba432","project":"59de6011debd1200240f68ec","version":{"_id":"59de6011debd1200240f68ee","__v":3,"project":"59de6011debd1200240f68ec","createdAt":"2016-06-20T18:15:42.514Z","releaseDate":"2016-06-20T18:15:42.514Z","categories":["59de6011debd1200240f68fb","59de6011debd1200240f68fa","59de6011debd1200240f68fc","59de6011debd1200240f68f8","59de6011debd1200240f68f7","59de6011debd1200240f68f9","59de6011debd1200240f68fd","59de6011debd1200240f68fe","59de6011debd1200240f68ff","5a8bfb99f4146e00449cec47","5a8bfcf2e86f530012159bb2","5cd4c29c6ea1040056ec0f55"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2.0"},"category":{"_id":"59de6011debd1200240f68f8","__v":0,"project":"59de6011debd1200240f68ec","version":"59de6011debd1200240f68ee","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-02-22T07:01:46.643Z","from_sync":false,"order":6,"slug":"available-slots-management","title":"Session and Slot Management"},"user":"547504ed59fade080004cb8b","__v":11,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-10-24T19:14:43.840Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"curl","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'"}]},"method":"post","results":{"codes":[{"status":201,"name":"","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\"}]","language":"json"},{"name":"","code":"{\"message\":\"Validation failed: Stages can't be blank\"}","language":"json","status":422},{"code":"{\"message\":\"Authentication is required\"}","language":"text","status":401}]},"settings":"","auth":"required","params":[{"_id":"56cb4a720549f0130068ded6","ref":"","in":"query","required":true,"desc":"required if not passed in through header","default":"secret-api-token","type":"string","name":"api_token"},{"_id":"5bd0c5108699ee004a4108fc","ref":"","in":"body","required":true,"desc":"List of stages","default":"[\"d22f7b84-d401-46bf-8347-91a140985557\",\"74acbd7d-cb9d-4e9d-9247-a945152b2b4f\"]","type":"array_string","name":"stage_ids"},{"_id":"5bd0c5108699ee004a4108fb","ref":"","in":"body","required":true,"desc":"Email address of recruiter","default":"user@example.com","type":"string","name":"recruiter_email"},{"_id":"5bd0c5108699ee004a4108fa","ref":"","in":"body","required":true,"desc":"Start time of the appointment in toJson() format","default":"2020-04-23T18:25:00.000Z","type":"timestamp","name":"start_time"},{"_id":"5bd0c5108699ee004a4108f9","ref":"","in":"body","required":true,"desc":"End time of the appointment in toJson() format","default":"2020-04-23T18:45:00.000Z","type":"timestamp","name":"end_time"},{"_id":"5bd0c5108699ee004a4108f7","ref":"","in":"body","required":true,"desc":"Maximum number of attendees, must be greater than zero","default":"5","type":"string","name":"max_attendees"},{"_id":"5bd0c5108699ee004a4108f8","ref":"","in":"body","required":false,"desc":"Location of the appointment","default":"Stoltenbergburgh","type":"string","name":"location"},{"_id":"5bd0c5108699ee004a4108f6","ref":"","in":"body","required":false,"desc":"Repeat this slot? Values can be “daily”, “weekly”, or “weekdays”","default":"weekly","type":"string","name":"period"},{"_id":"5bd0c5108699ee004a4108f5","ref":"","in":"body","required":false,"desc":"Number of days or weeks to repeat this slot; number between 1 and 30","default":"2","type":"int","name":"frequency"},{"_id":"5bd0c5108699ee004a4108f4","ref":"","in":"body","required":false,"desc":"Number of minutes to split each session into","default":"15","type":"int","name":"split"},{"_id":"5bd0c5108699ee004a4108f3","ref":"","in":"body","required":false,"desc":"Name of the event","default":"In-person interview","type":"string","name":"title"},{"_id":"5bd0c5108699ee004a4108f2","ref":"","in":"body","required":false,"desc":"Instructions for attendees","default":"Please arrive on time!","type":"string","name":"instructions"}],"url":"/available_slots"},"isReference":false,"order":0,"body":"Create calendar slots.","excerpt":"","slug":"create-slots","type":"endpoint","title":"Create Slots"}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

api_token:
required
stringsecret-api-token
required if not passed in through header

Body Params

stage_ids:
required
array of strings["d22f7b84-d401-46bf-8347-91a140985557","74acbd7d-cb9d-4e9d-9247-a945152b2b4f"]
List of stages
recruiter_email:
required
stringuser@example.com
Email address of recruiter
start_time:
required
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 }}