{"_id":"551cb06448564a2f0024d8a0","editedParams":true,"user":"543569cd35740020002a1c2d","__v":6,"category":{"_id":"551c03c1ff892b3700d1c57a","pages":["551c056aefc11923006421e8","551c0b2befc11923006421f3","551c0ce223a1ee190034d0ff","551ca30f7405910d00900a57","551ca412b7a32b3b00d1ef69","551ca4e335f9812f008ccd31","551cac0d35f9812f008ccd38","551cae3bd65a6d19007a8e6a","551caef7b7a32b3b00d1ef70","551cb06448564a2f0024d8a0","551cb24435f9812f008ccd3c","551cb2a8d65a6d19007a8e75","551cb4cfb7a32b3b00d1ef76","552926c5ceedaa0d00bc5c71"],"version":"5435693035740020002a1c1f","__v":14,"project":"5435693035740020002a1c1c","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-04-01T14:42:09.907Z","from_sync":false,"order":7,"slug":"spaces","title":"Spaces"},"parentDoc":null,"project":"5435693035740020002a1c1c","editedParams2":true,"githubsync":"","version":{"_id":"5435693035740020002a1c1f","__v":15,"project":"5435693035740020002a1c1c","createdAt":"2014-10-08T16:41:20.702Z","releaseDate":"2014-10-08T16:41:20.702Z","categories":["5435693035740020002a1c20","551c03c1ff892b3700d1c57a","551ca3927405910d00900a59","551cac6448564a2f0024d89e","551cb4d848564a2f0024d8a3","551cb52db7a32b3b00d1ef78","5526e2064a7ac121004c6073","5526e5147d4a4417009516b3","5526e9877d4a4417009516bb","5528362cd9e1db2d00cd924d","5580240ebe698419008f2ba2","5580a7dabe698419008f2db6","568161799de23c0d00c54750","5866c905a2cbb31900f6f1aa","5bfc066d8342500013783e0c"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-04-02T02:58:44.578Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{\n  \"meta\": {\n    \"status_code\": 201,\n    \"status\": \"CREATED\",\n    \"message\": \"\",\n    \"more_info\": {}\n  },\n  \"data\": {\n    \"id\": \"23481829\",\n    \"organizer_id\": 42,\n    \"organizer_email\": \"brian:::at:::robinpowered.com\",\n    \"creator_id\": 42,\n    \"creator_email\": \"brian@robinpowered.com\",\n    \"space_id\": 48,\n    \"title\": \"Weekly Round-Up\",\n    \"description\": \"Discuss the progress made during the week.\",\n    \"location\": \"Conference Room\",\n    \"remote_event_id\": \"j5q9k40530fj340f16hq8\",\n    \"remote_type\": \"google\",\n    \"creation_type\": \"manual\",\n    \"uid\": \"j5q9k40530fj340f16hq8@google.com\",\n    \"start\": {\n      \"date_time\": \"2017-01-06T01:00:00-0500\",\n      \"time_zone\": \"America/New_York\"\n    },\n    \"end\": {\n      \"date_time\": \"2017-01-06T02:00:00-0500\",\n      \"time_zone\": \"America/New_York\"\n    },\n    \"series_id\": null,\n    \"recurrence_id\": null,\n    \"status\": \"confirmed\",\n    \"recurrence\": [\n  \t   \"RRULE:FREQ=WEEKLY;UNTIL=20170127T170000Z\"\n    ],\n    \"is_all_day\": false,\n    \"visibility\": \"default\",\n    \"invitees\": [\n      {\n        \"id\": 108209227,\n        \"event_id\": \"23481829\",\n        \"user_id\": 42,\n        \"email\": \"example1@robinpowered.com\",\n        \"display_name\": \"Brian Muse\",\n        \"response_status\": \"accepted\",\n        \"is_organizer\": false,\n        \"is_resource\": false,\n        \"updated_at\": \"2016-12-30T20:22:36+0000\",\n        \"created_at\": \"2016-12-30T20:22:36+0000\"\n      },\n      {\n        \"id\": 108209228,\n        \"event_id\": \"23481829\",\n        \"user_id\": null,\n        \"email\": \"example2@robinpowered.com\",\n        \"display_name\": null,\n        \"response_status\": \"not_responded\",\n        \"is_organizer\": false,\n        \"is_resource\": false,\n        \"updated_at\": \"2016-12-30T20:22:36+0000\",\n        \"created_at\": \"2016-12-30T20:22:36+0000\"\n      },\n      {\n        \"id\": 108209229,\n        \"event_id\": \"23481829\",\n        \"user_id\": null,\n        \"email\": \"example3@robinpowered.com\",\n        \"display_name\": null,\n        \"response_status\": \"not_responded\",\n        \"is_organizer\": false,\n        \"is_resource\": false,\n        \"updated_at\": \"2016-12-30T20:22:36+0000\",\n        \"created_at\": \"2016-12-30T20:22:36+0000\"\n      }\n    ],\n    \"confirmation\": null\n  }\n}","language":"json","status":200}]},"settings":"","examples":{"codes":[{"code":"POST /v1.0/spaces/48/events HTTP/1.1\nHost: api.robinpowered.com\nContent-Type: application/json\nAuthorization: Access-Token :accessToken\n\n{\n  \"title\": \"Weekly Round-Up\",\n  \"description\": \"Discuss the progress made during the week.\",\n  \"start\": {\n  \t\"date_time\": \"2017-01-06T06:00:00Z\",\n  \t\"time_zone\": \"America/New_York\"\n  },\n  \"end\": {\n  \t\"date_time\": \"2017-01-06T07:00:00Z\",\n  \t\"time_zone\": \"America/New_York\"\n  },\n  \"recurrence\": [\n  \t\"RRULE:FREQ=WEEKLY;UNTIL=20170127T170000Z\"\n  ],\n  \"invitees\": [\n  \t{\n  \t\t\"display_name\": \"Brian Muse\",\n  \t\t\"email\": \"example1@robinpowered.com\"\n  \t},\n  \t{\n  \t\t\"display_name\": \"Jacob Struzik\",\n  \t\t\"email\": \"example2@robinpowered.com\"\n  \t},\n  \t{\n  \t\t\"display_name\": \"Trevor Suarez\",\n  \t\t\"email\": \"example3@robinpowered.com\"\n  \t}\n  ]\n}","language":"http"}]},"method":"post","auth":"required","params":[{"_id":"551c0ce223a1ee190034d100","ref":"","in":"path","required":true,"desc":"The ID of the space","default":"","type":"int","name":"id"},{"_id":"551cb06448564a2f0024d8a1","ref":"","in":"body","required":false,"desc":"A title for the event. If omitted, a title will be automatically generated from the space's name and the name of the user that is booking the event.","default":"","type":"string","name":"title"},{"_id":"551ca58035f9812f008ccd33","ref":"","in":"body","required":true,"desc":"A composite datetime / timezone object that represents the start of the event.","default":"","type":"object","name":"start"},{"_id":"5866bee13e21a72d0029a29c","ref":"","in":"body","required":true,"desc":"An ISO-8601 timestamp representing the start of the event.","default":"","type":"datetime","name":"start.date_time"},{"_id":"5866c023619bb21900445196","ref":"","in":"body","required":true,"desc":"A valid IANA timezone identifier, such as `America/New_York`.","default":"","type":"string","name":"start.time_zone"},{"_id":"551ca58035f9812f008ccd32","ref":"","in":"body","required":true,"desc":"A composite datetime / timezone object that represents the start of the event.","default":"","type":"object","name":"end"},{"_id":"5866c023619bb21900445195","ref":"","in":"body","required":true,"desc":"An ISO-8601 timestamp representing the end of the event.","default":"","type":"datetime","name":"end.date_time"},{"_id":"5866c023619bb21900445194","ref":"","in":"body","required":true,"desc":"A valid IANA timezone identifier, such as `America/New_York`.","default":"","type":"string","name":"end.time_zone"},{"_id":"56690260d000ff1700ca478e","ref":"","in":"body","required":false,"desc":"Description for event. Will show up in meeting invite.","default":"","type":"string","name":"description"},{"_id":"5866c023619bb21900445193","ref":"","in":"body","required":false,"desc":"The visibility type. See the event resource page for a list of valid types.","default":"","type":"string","name":"visibility"},{"_id":"5866c023619bb21900445192","ref":"","in":"body","required":false,"desc":"An array RFC-5545 compliant content-lines that are of the type `RRULE`, `RDATE`, and `EXDATE`.","default":"","type":"string","name":"recurrence"},{"_id":"5866c0c9a2cbb31900f6f1a4","ref":"","in":"body","required":false,"desc":"The invitees to invite.","default":"","type":"array_object","name":"invitees"},{"_id":"5866c2483e21a72d0029a2a1","ref":"","in":"body","required":true,"desc":"The email address of the invitee","default":"","type":"string","name":"invitees.email"},{"_id":"5866c2483e21a72d0029a2a0","ref":"","in":"body","required":false,"desc":"The name of the invitee.","default":"","type":"string","name":"invitees.display_name"}],"url":"/spaces/:id/events"},"isReference":true,"order":4,"body":"Creates an event and books space. This method will return an error if the event being created conflicts with an existing event already scheduled within the space.\n\nEvents must be longer than five minutes.\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"Robin will automatically check for existing scheduling conflicts when trying to book a new event, and reject the request if a collision is found. If you have a list of events synced to Robin handy, you will be able to know in advance which times are unavailable.\\n\\nKeep in mind that Robin will sync up to 3 months worth of events automatically for Google, and about a month for Microsoft calendars. When scheduling new events farther out, be sure to check for rejections before continuing.\",\n  \"title\": \"Double-check far future bookings.\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Recurrence\"\n}\n[/block]\nRecurrence must be iCal compliant:\n[block:embed]\n{\n  \"html\": false,\n  \"url\": \"https://tools.ietf.org/html/rfc5545\",\n  \"title\": \"RFC 5545 - Internet Calendaring and Scheduling Core Object Specification (iCalendar)\",\n  \"favicon\": \"https://tools.ietf.org/images/rfc.png\"\n}\n[/block]\nAn example recurrence might look like the following:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"[\\n  \\\"RRULE:FREQ=DAILY;COUNT=5\\\",\\n  \\\"RDATE:20170101T120000Z\\\"\\n]\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","excerpt":"Book an event in a space","slug":"add-space-event","type":"endpoint","title":"/spaces/:id/events"}

post/spaces/:id/events

Book an event in a space

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
integer
The ID of the space

Body Params

title:
string
A title for the event. If omitted, a title will be automatically generated from the space's name and the name of the user that is booking the event.
start:
required
object
A composite datetime / timezone object that represents the start of the event.
start.date_time:
required
datetime
An ISO-8601 timestamp representing the start of the event.
start.time_zone:
required
string
A valid IANA timezone identifier, such as `America/New_York`.
end:
required
object
A composite datetime / timezone object that represents the start of the event.
end.date_time:
required
datetime
An ISO-8601 timestamp representing the end of the event.
end.time_zone:
required
string
A valid IANA timezone identifier, such as `America/New_York`.
description:
string
Description for event. Will show up in meeting invite.
visibility:
string
The visibility type. See the event resource page for a list of valid types.
recurrence:
string
An array RFC-5545 compliant content-lines that are of the type `RRULE`, `RDATE`, and `EXDATE`.
invitees:
array of objects
The invitees to invite.
invitees.email:
required
string
The email address of the invitee
invitees.display_name:
string
The name of the invitee.

Examples


Result Format


Documentation

Creates an event and books space. This method will return an error if the event being created conflicts with an existing event already scheduled within the space. Events must be longer than five minutes. [block:callout] { "type": "warning", "body": "Robin will automatically check for existing scheduling conflicts when trying to book a new event, and reject the request if a collision is found. If you have a list of events synced to Robin handy, you will be able to know in advance which times are unavailable.\n\nKeep in mind that Robin will sync up to 3 months worth of events automatically for Google, and about a month for Microsoft calendars. When scheduling new events farther out, be sure to check for rejections before continuing.", "title": "Double-check far future bookings." } [/block] [block:api-header] { "type": "basic", "title": "Recurrence" } [/block] Recurrence must be iCal compliant: [block:embed] { "html": false, "url": "https://tools.ietf.org/html/rfc5545", "title": "RFC 5545 - Internet Calendaring and Scheduling Core Object Specification (iCalendar)", "favicon": "https://tools.ietf.org/images/rfc.png" } [/block] An example recurrence might look like the following: [block:code] { "codes": [ { "code": "[\n \"RRULE:FREQ=DAILY;COUNT=5\",\n \"RDATE:20170101T120000Z\"\n]", "language": "json" } ] } [/block]

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 }}