{"_id":"57bb01195c849b1700f1e515","githubsync":"","parentDoc":null,"project":"54aa7f773b56130b0056c86e","user":"57a45e5726785a0e00b69a49","__v":4,"version":{"_id":"55781fe25129590d003ff4f7","project":"54aa7f773b56130b0056c86e","forked_from":"54aa7f773b56130b0056c871","__v":6,"createdAt":"2015-06-10T11:30:42.700Z","releaseDate":"2015-06-10T11:30:42.700Z","categories":["55781fe35129590d003ff4f8","55781fe35129590d003ff4f9","55781fe35129590d003ff4fa","55781fe35129590d003ff4fb","55781fe35129590d003ff4fc","55781fe35129590d003ff4fd","55781fe35129590d003ff4fe","564bbc7e8841060d00abb2ee","565b66c446118c0d00dcb0bb","56898269f8dc340d00308c13","582318b23b961a0f009516a1","594a848c9f4771001a43c959"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"Developers","version_clean":"2.0.0","version":"2.0"},"category":{"_id":"564bbc7e8841060d00abb2ee","__v":10,"pages":["564bbf454bf5c80d0020901e","564bc1b08b1c5521002bb914","564c387b9baa330d00faa622","564c3a7b61008d17006ffa3a","564c3e4083b72c2b00b36fb6","564c431b61008d17006ffa46","564c4bc9b9cdb41700a0eae7","564c4e955f9d102b00fc3b4a","564c5f32c241881700d85981","564c68a93eb8f81700838a25"],"project":"54aa7f773b56130b0056c86e","version":"55781fe25129590d003ff4f7","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-11-17T23:47:10.058Z","from_sync":false,"order":1,"slug":"pulsate-cms-api","title":"Pulsate CMS API"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-08-22T13:41:45.377Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"curl -X POST \"https://control.pulsatehq.com/api/v1/apps/$APP_ID/talks\"\n  -H \"Authorization: Token token=$MY_ADMIN_API_TOKEN\"\n  -d '{\n      \"talk\": {\n          \"starter\": \"admin\",\n          \"starter_id\": \"535a47bb20096982ef000001\",\n          \"admin_id\": \"535a47bb20096982ef000001\",\n          \"user_id\": \"582ad8d361707074a3191100\",\n          \"subject\": \"sample_subject\",\n          \"starred\": true,\n          \"messages\": [\n              {\n                  \"content\": \"sample_content1\",\n                  \"sender\": \"admin\",\n                  \"admin_id\": \"535a47bb20096982ef000001\",\n                  \"user_id\": \"582ad8d361707074a3191100\"         \n              }\n          ]\n      }\n  }'","language":"shell"}]},"method":"post","results":{"codes":[{"status":200,"name":"","code":"{\n  \"id\": \"587779fa636f6e63bdf60400\",\n  \"starter\": \"admin\",\n  \"starter_id\": \"535a47bb20096982ef000001\",\n  \"admin_id\": \"535a47bb20096982ef000001\",\n  \"user_id\": \"582ad8d361707074a3191100\",\n  \"read\": true,\n  \"subject\": \"sample_subject\",\n  \"starred\": true,\n  \"created_at\": \"2017-01-12T12:43:38.632Z\",\n  \"messages\": [\n    {\n      \"id\": \"587779fa636f6e63bdf50400\",\n      \"content\": \"sample_content1\",\n      \"sender\": \"admin\",\n      \"admin_id\": \"535a47bb20096982ef000001\",\n      \"user_id\": \"582ad8d361707074a3191100\",\n      \"created_at\": \"2017-01-12T12:43:38.493Z\"\n    }\n  ]\n}","language":"json"}]},"settings":"564bbbf80cbcc91700b8171c","auth":"required","params":[{"_id":"57ff848ce7218a1900673d10","ref":"","in":"path","required":true,"desc":"App ID. It can be fetched by using \"Apps: Get All (Index)\" or \"Apps: Get One (Show)\" endpoints.","default":"","type":"string","name":"app_id"},{"_id":"58777abbb8e8fb1900608ee6","ref":"","in":"body","required":true,"desc":"Talk to be created","default":"","type":"object","name":"talk"},{"_id":"57bb01195c849b1700f1e51e","ref":"","in":"body","required":true,"desc":"Talk starter, can be one of: [\"admin\", \"user\"]","default":"","type":"string","name":"talk.starter"},{"_id":"57bb01195c849b1700f1e51d","ref":"","in":"body","required":true,"desc":"Talk starter_id, Id of the user or admin","default":"","type":"string","name":"talk.starter_id"},{"_id":"57bb01195c849b1700f1e51c","ref":"","in":"body","required":true,"desc":"Talk admin Id","default":"","type":"string","name":"talk.admin_id"},{"_id":"57bb01195c849b1700f1e51b","ref":"","in":"body","required":true,"desc":"Talk user Id","default":"","type":"string","name":"talk.user_id"},{"_id":"57bb01195c849b1700f1e51a","ref":"","in":"body","required":true,"desc":"Talk subject","default":"","type":"string","name":"talk.subject"},{"_id":"58777d83e3deb13100cbcbef","ref":"","in":"body","required":false,"desc":"Talk starred","default":"","type":"boolean","name":"talk.starred"},{"_id":"58777abbb8e8fb1900608ee5","ref":"","in":"body","required":true,"desc":"Array of messages for the talk","default":"","type":"array_object","name":"talk.messages"},{"_id":"57bb01195c849b1700f1e519","ref":"","in":"body","required":true,"desc":"Message content","default":"","type":"string","name":"talk.messages[].content"},{"_id":"57bb01195c849b1700f1e518","ref":"","in":"body","required":true,"desc":"Message sender, can be one of: [\"user\", \"admin\"]","default":"","type":"string","name":"talk.messages[].sender"},{"_id":"57bb01195c849b1700f1e517","ref":"","in":"body","required":true,"desc":"Message admin Id","default":"","type":"string","name":"talk.messages[].admin_id"},{"_id":"57bb01195c849b1700f1e516","ref":"","in":"body","required":true,"desc":"Message user Id","default":"","type":"string","name":"talk.messages[].user_id"}],"url":"/apps/:app_id/talks"},"isReference":true,"order":56,"body":"","excerpt":"","slug":"talks-create-one","type":"endpoint","title":"Talks: Create One"}

postTalks: Create One


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

app_id:
required
string
App ID. It can be fetched by using "Apps: Get All (Index)" or "Apps: Get One (Show)" endpoints.

Body Params

talk:
required
object
Talk to be created
talk.starter:
required
string
Talk starter, can be one of: ["admin", "user"]
talk.starter_id:
required
string
Talk starter_id, Id of the user or admin
talk.admin_id:
required
string
Talk admin Id
talk.user_id:
required
string
Talk user Id
talk.subject:
required
string
Talk subject
talk.starred:
boolean
Talk starred
talk.messages:
required
array of objects
Array of messages for the talk
talk.messages[].content:
required
string
Message content
talk.messages[].sender:
required
string
Message sender, can be one of: ["user", "admin"]
talk.messages[].admin_id:
required
string
Message admin Id
talk.messages[].user_id:
required
string
Message user Id

Examples


Result Format


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