{"_id":"57028f0a18ad001700a2947d","user":"558435c2fb52ee0d0015d190","editedParams2":true,"version":{"_id":"558444ceafccfd0d00fcb2bb","forked_from":"55843604fd8d910d007b9505","project":"55843604fd8d910d007b9502","__v":46,"createdAt":"2015-06-19T16:35:26.435Z","releaseDate":"2015-06-19T16:35:26.435Z","categories":["558444cfafccfd0d00fcb2bc","558444cfafccfd0d00fcb2bd","55ad4ce733616a0d00599d2e","55ad4cef6aadf20d0015b764","55ad4cf36aadf20d0015b765","55ad4cfb24cf160d0013584f","55ad4d0024cf160d00135850","55ad4d0a24cf160d00135851","55ad4d0d24cf160d00135852","55ad4d126aadf20d0015b766","55ad4d1624cf160d00135853","55ad4d1933616a0d00599d2f","55ad4d2233616a0d00599d30","55ad4d2e24cf160d00135854","55d35b6bf77e6d0d00b1b092","55d3649a0168850d0073f14a","55d366d40168850d0073f15a","55d37fcff77e6d0d00b1b13f","55d383e50168850d0073f1e1","55d3ac26c336ec0d007c2251","55d3c51cb2330119009c31db","55d3c59bfe37111900e536f3","55d3c5a7fe37111900e536f4","55d3c5b4fe37111900e536f5","55d3c5d4fe37111900e536f6","55d3c5d6b2330119009c31df","55d3c5d71f478b170077c164","55d3c687b2330119009c31e4","55d3c6a4fe37111900e536f9","55d3c6befe37111900e536fa","55d3c6e8d2c66f0d00497f93","55d49dcfd7c16b2d007de905","55d4ca8f5082980d0009c79b","55d4cab9c95a3d2f0069ad3d","55d4d279c95a3d2f0069ad60","55d4d9355082980d0009c7e1","55d4f6b5988e130d000b3eb1","55d64dc8e60a2f0d00b88ecb","5627ca43fcbbc621004ec07d","56c64a0d8f98b50d0012c37c","56f1b8b13eb62a34003ea041","56f1b9df4476fb2200795e8c","57f6907dca5e5d1700039ae9","591dd06ca266c423002ec4ca","59234825e465c11900922518","5936f82eaa591e0027638d57","59972f54fd7078001992c136"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"3.0.0","version":"3"},"project":"55843604fd8d910d007b9502","parentDoc":null,"__v":0,"category":{"_id":"55d3c5a7fe37111900e536f4","version":"558444ceafccfd0d00fcb2bb","pages":["56ce2c26388ec62500cfc04c"],"project":"55843604fd8d910d007b9502","__v":1,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-08-18T23:54:15.731Z","from_sync":false,"order":12,"slug":"message-library","title":"Message Library"},"editedParams":true,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-04-04T15:58:02.618Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"curl -X POST -H 'X-API-TOKEN: yourapitokenhere' -H 'Content-Type: application/json' -d '{\n    \"category\": \"invite\",\n    \"messages\": {\"en\":\"Example english message.\", \"pt-br\":\"Mensagem em Portugues.\"},\n    \"description\": \"My New Invite Message\"\n}' 'https://yourdatacenterid.qualtrics.com/API/v3/libraries/UR_1M4aHozEkSxUfCl/messages/'","language":"curl"}]},"method":"post","results":{"codes":[{"language":"json","status":200,"name":"","code":"{\n  \"result\": {\n    \"id\": \"MS_5o5E28wJn7rDhSR\"\n  },\n  \"meta\": {\n    \"httpStatus\": \"200 - OK\"\n  }\n}"}]},"settings":"","auth":"required","params":[{"_id":"55d36ef8f77e6d0d00b1b0f9","ref":"","in":"path","required":true,"desc":"The Library ID can be one of the following IDs: (User ID, Group ID, ThreeSixty ID)","default":"","type":"string","name":"libraryId"},{"_id":"55d374920168850d0073f1a8","ref":"","in":"body","required":true,"desc":"Defines a description for the message","default":"","type":"string","name":"description"},{"_id":"55d374920168850d0073f1a7","ref":"","in":"body","required":true,"desc":"A JSON object - mapping language codes to messages. (example: {\"en\":\"Example english message.\",\"pt-br\":\"Mensagem em Portugues.\"})","default":"","type":"string","name":"messages"},{"_id":"55d37987b9ef4435006dedac","ref":"","in":"body","required":true,"desc":"The message can be grouped in the following categories: invite, inactiveSurvey, reminder, thankYou, endOfSurvey, general, validation, lookAndFeel, emailSubject, smsInvite","default":"","type":"string","name":"category"}],"url":"/v:version/libraries/:libraryId/messages"},"isReference":false,"order":1,"body":"","excerpt":"Add a new message to a library","slug":"create-library-message","type":"endpoint","title":"Create Library Message"}

postCreate Library Message

Add a new message to a library

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

libraryId:
required
string
The Library ID can be one of the following IDs: (User ID, Group ID, ThreeSixty ID)

Body Params

description:
required
string
Defines a description for the message
messages:
required
string
A JSON object - mapping language codes to messages. (example: {"en":"Example english message.","pt-br":"Mensagem em Portugues."})
category:
required
string
The message can be grouped in the following categories: invite, inactiveSurvey, reminder, thankYou, endOfSurvey, general, validation, lookAndFeel, emailSubject, smsInvite

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