{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/devices/:device_id/events","auth":"required","examples":{"codes":[{"language":"curl","code":"# Basic Event\ncurl -X POST -u :API_KEY -d '{\"events\":[{\"name\":\"event_name\", \"date\":\"2016-09-11T18:04:23Z\"}]}' -H \"Content-Type:application/json\" -H 'Accept: application/json' https://api.carnivalmobile.com/v4/devices/:device_id/events\n\n# Basic Events (multiple)\ncurl -X POST -u :API_KEY -d '{\"events\":[{\"name\":\"event_name\", \"date\":\"2016-09-11T18:04:23Z\"},{\"name\":\"event_name_2\", \"date\":\"2016-09-11T19:04:23Z\"}]}' -H \"Content-Type:application/json\" -H 'Accept: application/json' https://api.carnivalmobile.com/v4/devices/:device_id/events\n\n# Basic Event (without date)\ncurl -X POST -u :API_KEY -d '{\"events\":[{\"name\":\"event_name\"}]}' -H \"Content-Type:application/json\" -H 'Accept: application/json' https://api.carnivalmobile.com/v4/devices/:device_id/events\n"}]},"method":"post","params":[{"name":"device_id","type":"string","default":"","desc":"A Carnival Device ID","required":false,"in":"path","ref":"","_id":"57f1cfb31d89490e003b28a4"},{"name":"events","type":"object","default":"","desc":"JSON object containing array of events","required":false,"in":"body","ref":"","_id":"57f1cfb31d89490e003b28a3"}],"results":{"codes":[{"name":"","code":"// your events have been successfully registered\n{}","language":"json","status":202},{"code":"//your event data is not in the correct format\n//common issues include: no event name, invalid event object, no events\n{}","language":"json","status":400,"name":""},{"code":"// This error is given when your API client credentials are not correct. \n{\n  \"error\":\"unauthorized\"\n}","language":"json","status":401}]},"settings":"","apiSetting":null},"next":{"description":"","pages":[]},"title":"Devices / Events","type":"endpoint","slug":"devices-events","excerpt":"Add events for a specific device","body":"**Note 1:** the date property on an event is optional and if left off UTC time will be used in its place.\n\nDates should be formatted using an [ISO 6801](https://en.wikipedia.org/wiki/ISO_860) formatted string.\n\n**Note 2:** In versions prior to v5, the `/devices/events` endpoint would prepend `Public Api:` to events when viewed in the web view. In v5, this behavior has been removed, but if your code depends on this, then you can use the `/v4/devices/events/` endpoint.","updates":[],"order":6,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5b1f2cbdfd653400031d8d88","createdAt":"2016-10-03T00:40:53.581Z","version":{"version":"1.3","version_clean":"1.3.0","codename":"rebrand","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5b1f2cbdfd653400031d8d42","5b1f2cbdfd653400031d8d43","5b1f2cbdfd653400031d8d44","5b1f2cbdfd653400031d8d45","5b1f2cbdfd653400031d8d46","561c61b4ad272c0d00a892df","586c014c0abf1d0f000d04d4","58991d2ad207df0f0002186b","5b1f2cbdfd653400031d8d47","5b1f2cbdfd653400031d8d48","5af0fe494ca2730003cbc98a","5af0fe55ec80af0003804ca2"],"_id":"5b1f2cbdfd653400031d8d9f","project":"55e67aaa9cc7c62b00c4a1ea","__v":0,"forked_from":"55e67aab9cc7c62b00c4a1ed","createdAt":"2015-09-02T04:27:23.612Z","releaseDate":"2015-09-02T04:27:23.612Z"},"__v":4,"githubsync":"","project":"55e67aaa9cc7c62b00c4a1ea","category":{"sync":{"isSync":false,"url":""},"pages":["5b1f2cbdfd653400031d8d59","55ed079b0d968e2100de8339","5b1f2cbdfd653400031d8d5a","55ed0bb078319821005005cf","5b1f2cbdfd653400031d8d5b","5b1f2cbdfd653400031d8d5c","5b1f2cbdfd653400031d8d5d","5b1f2cbdfd653400031d8d5e","5b1f2cbdfd653400031d8d5f","5b1f2cbdfd653400031d8d60","5b1f2cbdfd653400031d8d61","5b1f2cbdfd653400031d8d62","5b1f2cbdfd653400031d8d63","5b1f2cbdfd653400031d8d64","5b1f2cbdfd653400031d8d65","5b1f2cbdfd653400031d8d66","5b1f2cbdfd653400031d8d67","5b1f2cbdfd653400031d8d6f","5b1f2cbdfd653400031d8d70","5b1f2cbdfd653400031d8d78"],"title":"REST API","slug":"rest-api","order":5,"from_sync":false,"reference":true,"_id":"5b1f2cbdfd653400031d8d44","__v":20,"createdAt":"2015-09-02T04:30:21.948Z","project":"55e67aaa9cc7c62b00c4a1ea","version":"5b1f2cbdfd653400031d8d9f"},"parentDoc":null,"user":"57e9c9dc80c0490e00480948"}

postDevices / Events

Add events for a specific device

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

device_id:
string
A Carnival Device ID

Body Params

events:
object
JSON object containing array of events

Examples


Result Format


Documentation

**Note 1:** the date property on an event is optional and if left off UTC time will be used in its place. Dates should be formatted using an [ISO 6801](https://en.wikipedia.org/wiki/ISO_860) formatted string. **Note 2:** In versions prior to v5, the `/devices/events` endpoint would prepend `Public Api:` to events when viewed in the web view. In v5, this behavior has been removed, but if your code depends on this, then you can use the `/v4/devices/events/` endpoint.

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