{"_id":"5866ca461bd8d723003c7dad","__v":1,"user":"543568c135740020002a1c10","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"},"project":"5435693035740020002a1c1c","category":{"_id":"5866c905a2cbb31900f6f1aa","version":"5435693035740020002a1c1f","__v":0,"project":"5435693035740020002a1c1c","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-12-30T20:52:21.720Z","from_sync":false,"order":8,"slug":"events","title":"Events"},"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-12-30T20:57:42.169Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","examples":{"codes":[{"name":"","code":"POST /v1.0/events/92234 HTTP/1.1\nHost: api.robinpowered.com\nContent-Type: application/json\nAuthorization: Access-Token :accessToken\n\n{\n  \"title\": \"Weekly Round-Up [MOVED]\"\n  \"start\": {\n  \t\"date_time\": \"2017-01-06T06:30:00Z\",\n  \t\"time_zone\": \"America/New_York\"\n  },\n  \"end\": {\n  \t\"date_time\": \"2017-01-06T07:30:00Z\",\n  \t\"time_zone\": \"America/New_York\"\n  }\n}","language":"http"}]},"method":"patch","results":{"codes":[{"language":"json","code":"{\n  \"meta\": {\n    \"status_code\": 200,\n    \"status\": \"OK\",\n    \"message\": \"\",\n    \"more_info\": {}\n  },\n  \"data\": {}\n}","name":"","status":200}]},"auth":"required","params":[{"_id":"551c0b2befc11923006421f7","ref":"","in":"path","required":true,"desc":"The ID of the event to update","default":"","type":"int","name":"id"},{"_id":"551c0b2befc11923006421f6","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":"551c0b2befc11923006421f5","ref":"","in":"body","required":false,"desc":"Description for event. Will show up in meeting invite.","default":"","type":"string","name":"description"},{"_id":"551c0b2befc11923006421f4","ref":"","in":"body","required":false,"desc":"A composite datetime / timezone object that represents the start of the event.","default":"","type":"object","name":"start"},{"_id":"5866bd5b1bd8d723003c7da2","ref":"","in":"body","required":false,"desc":"An ISO-8601 timestamp representing the start of the event.","default":"","type":"datetime","name":"start.date_time"},{"_id":"5866bd5b1bd8d723003c7da1","ref":"","in":"body","required":false,"desc":"A valid IANA timezone identifier, such as `America/New_York`.","default":"","type":"string","name":"start.time_zone"},{"_id":"5866bd5b1bd8d723003c7da0","ref":"","in":"body","required":false,"desc":"A composite datetime / timezone object that represents the end of the event.","default":"","type":"object","name":"end"},{"_id":"5866bd5b1bd8d723003c7d9f","ref":"","in":"body","required":false,"desc":"An ISO-8601 timestamp representing the end of the event.","default":"","type":"datetime","name":"end.date_time"},{"_id":"5866cafb619bb2190044519d","ref":"","in":"body","required":false,"desc":"A valid IANA timezone identifier, such as `America/New_York`.","default":"","type":"string","name":"end.time_zone"},{"_id":"5866cafb619bb2190044519c","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":"5866cafb619bb2190044519b","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":"5866cafb619bb2190044519a","ref":"","in":"body","required":false,"desc":"The invitees to invite.","default":"","type":"array_object","name":"invitees"},{"_id":"5866cafb619bb21900445199","ref":"","in":"body","required":false,"desc":"The email address of the invitee","default":"","type":"string","name":"invitees.email"},{"_id":"5866cafb619bb21900445198","ref":"","in":"body","required":false,"desc":"The name of the invitee.","default":"","type":"string","name":"invitees.name"}],"url":"/events/:id"},"isReference":true,"order":1,"body":"","excerpt":"Update's the properties of an existing [Event](doc:event).","slug":"eventsid-1","type":"endpoint","title":"/events/:id"}

patch/events/:id

Update's the properties of an existing [Event](doc:event).

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
integer
The ID of the event to update

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.
description:
string
Description for event. Will show up in meeting invite.
start:
object
A composite datetime / timezone object that represents the start of the event.
start.date_time:
datetime
An ISO-8601 timestamp representing the start of the event.
start.time_zone:
string
A valid IANA timezone identifier, such as `America/New_York`.
end:
object
A composite datetime / timezone object that represents the end of the event.
end.date_time:
datetime
An ISO-8601 timestamp representing the end of the event.
end.time_zone:
string
A valid IANA timezone identifier, such as `America/New_York`.
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:
string
The email address of the invitee
invitees.name:
string
The name of the invitee.

Examples


Result Format


User Information

Try It Out

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