{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/apps/:app_id/talks","auth":"required","examples":{"codes":[{"language":"shell","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  }'"}]},"method":"post","params":[{"name":"app_id","type":"string","default":"","desc":"App ID. It can be fetched by using \"Apps: Get All (Index)\" or \"Apps: Get One (Show)\" endpoints.","required":true,"in":"path","ref":"","_id":"57ff848ce7218a1900673d10"},{"name":"talk","type":"object","default":"","desc":"Talk to be created","required":true,"in":"body","ref":"","_id":"58777abbb8e8fb1900608ee6"},{"name":"talk.starter","type":"string","default":"","desc":"Talk starter, can be one of: [\"admin\", \"user\"]","required":true,"in":"body","ref":"","_id":"57bb01195c849b1700f1e51e"},{"name":"talk.starter_id","type":"string","default":"","desc":"Talk starter_id, Id of the user or admin","required":true,"in":"body","ref":"","_id":"57bb01195c849b1700f1e51d"},{"name":"talk.admin_id","type":"string","default":"","desc":"Talk admin Id","required":true,"in":"body","ref":"","_id":"57bb01195c849b1700f1e51c"},{"name":"talk.user_id","type":"string","default":"","desc":"Talk user Id","required":true,"in":"body","ref":"","_id":"57bb01195c849b1700f1e51b"},{"name":"talk.subject","type":"string","default":"","desc":"Talk subject","required":true,"in":"body","ref":"","_id":"57bb01195c849b1700f1e51a"},{"name":"talk.starred","type":"boolean","default":"","desc":"Talk starred","required":false,"in":"body","ref":"","_id":"58777d83e3deb13100cbcbef"},{"name":"talk.messages","type":"array_object","default":"","desc":"Array of messages for the talk","required":true,"in":"body","ref":"","_id":"58777abbb8e8fb1900608ee5"},{"name":"talk.messages[].content","type":"string","default":"","desc":"Message content","required":true,"in":"body","ref":"","_id":"57bb01195c849b1700f1e519"},{"name":"talk.messages[].sender","type":"string","default":"","desc":"Message sender, can be one of: [\"user\", \"admin\"]","required":true,"in":"body","ref":"","_id":"57bb01195c849b1700f1e518"},{"name":"talk.messages[].admin_id","type":"string","default":"","desc":"Message admin Id","required":true,"in":"body","ref":"","_id":"57bb01195c849b1700f1e517"},{"name":"talk.messages[].user_id","type":"string","default":"","desc":"Message user Id","required":true,"in":"body","ref":"","_id":"57bb01195c849b1700f1e516"}],"results":{"codes":[{"language":"json","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}","name":"","status":200}]},"settings":"564bbbf80cbcc91700b8171c"},"next":{"description":"","pages":[]},"title":"Talks: Create One","type":"endpoint","slug":"talks-create-one","excerpt":"","body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"`admin_id` can be retrieved by querying the [Admins: Get All (index) endpoint](https://pulsate.readme.io/docs/admins-get-all-index) and `user_id` can be retrieved by querying the [Users: Get One (Show) endpoint](https://pulsate.readme.io/docs/get-user).\"\n}\n[/block]","updates":[],"order":60,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5e4fced159815700262d28e7","githubsync":"","parentDoc":null,"createdAt":"2016-08-22T13:41:45.377Z","project":"54aa7f773b56130b0056c86e","user":"57a45e5726785a0e00b69a49","__v":5,"version":{"version":"2.2","version_clean":"2.2.0","codename":"CMS API","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5e4fced159815700262d2899","55781fe35129590d003ff4f9","55781fe35129590d003ff4fa","5e4fced159815700262d289a","5e4fced159815700262d289b","5e4fced159815700262d289c","5e4fced159815700262d289d","5e4fced159815700262d289e","565b66c446118c0d00dcb0bb","56898269f8dc340d00308c13","5e4fced159815700262d289f","5e4fced159815700262d28a0","5c73dd27e8fdc000572a206a","5e4fced159815700262d28a1","5e53c04c1d11110018b56e12"],"_id":"5e4fced159815700262d2930","project":"54aa7f773b56130b0056c86e","forked_from":"55781fe25129590d003ff4f7","__v":1,"createdAt":"2015-06-10T11:30:42.700Z","releaseDate":"2015-06-10T11:30:42.700Z"},"category":{"sync":{"isSync":false,"url":""},"pages":["5e4fced159815700262d28c6","5e4fced159815700262d28c7","5e4fced159815700262d28c8","5e4fced159815700262d28c9","5e4fced159815700262d28ca","5e4fced159815700262d28cb","5e4fced159815700262d28cc","5e4fced159815700262d28cd","5e4fced159815700262d28ce","564c68a93eb8f81700838a25"],"title":"Pulsate CMS API","slug":"pulsate-cms-api","order":1,"from_sync":false,"reference":true,"_id":"5e4fced159815700262d289e","__v":10,"createdAt":"2015-11-17T23:47:10.058Z","project":"54aa7f773b56130b0056c86e","version":"5e4fced159815700262d2930"}}

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


Documentation

[block:callout] { "type": "info", "body": "`admin_id` can be retrieved by querying the [Admins: Get All (index) endpoint](https://pulsate.readme.io/docs/admins-get-all-index) and `user_id` can be retrieved by querying the [Users: Get One (Show) endpoint](https://pulsate.readme.io/docs/get-user)." } [/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 }}