{"_id":"5864068b0355f31900380473","version":{"_id":"5588b8a2f6c18d0d005bba06","project":"5588b8a2f6c18d0d005bba03","__v":16,"createdAt":"2015-06-23T01:38:42.696Z","releaseDate":"2015-06-23T01:38:42.696Z","categories":["5588b8a3f6c18d0d005bba07","5588e9689cfea70d00371df3","5588f5921163180d00b64704","561598b121e9110d0078025a","5616f1c9d170d00d00189306","5616f5c3a410c90d00c6121e","561803dcf8c9632100ac7592","563667280441020d0000e9eb","5642570d9417b40d00c0fcd3","57bf5f02efe0050e00d50bd5","57f53fb368a53b2000e03f0f","57f55187440418170086325a","582e3afa72fd270f0006926d","5841faa973967b0f004b4a2b","58db348aa32c8419002433bb","5a31c9409a6f2000125c079f"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"__v":3,"project":"5588b8a2f6c18d0d005bba03","category":{"_id":"57f53fb368a53b2000e03f0f","version":"5588b8a2f6c18d0d005bba06","project":"5588b8a2f6c18d0d005bba03","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-10-05T18:00:19.547Z","from_sync":false,"order":0,"slug":"api","title":"REST API: Access your Mixmax data"},"parentDoc":null,"githubsync":"","user":"5588b847f6c18d0d005bba01","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-12-28T18:38:03.015Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"curl -XPATCH -H 'X-API-Token: <your token>' -H \"Content-type: application/json\" -d '{\n  title: \"My test snippet\",\n  source: \"<div>My snippet</div>\"\n}' 'https://api.mixmax.com/v1/snippets/586346d00000000000000000'","language":"curl"}]},"method":"patch","results":{"codes":[{"name":"","status":200,"language":"json","code":"{\n  _id: \"586346d00000000000000000\",\n  userId: \"586346d00000000000000000\",\n  createdAt: 1478122191866,\n  savedAt: 1478122199067,\n  title: \"Interested in a new opportunity?\",\n  source: \"<p data-m-id=\\\"xz\\\">Hello there!<br></p>\",\n  name: \"My test snippet tag\",\n  shared: [{\n    userEmail: \"email:::at:::domain.com\",\n    confirmed: true\n  }],\n  isInline: false\n}"}]},"settings":"","auth":"required","params":[{"_id":"58640253e024922500d366e8","ref":"","in":"path","required":true,"desc":"Snippet Id","default":"","type":"string","name":"id"},{"_id":"5864068b0355f31900380478","ref":"","in":"body","required":false,"desc":"(Optional) Snippet subject. If `name` is empty when this is set, `name` will be automatically set to this value (as a convenience, as the UI only shows the name)","default":"","type":"string","name":"title"},{"_id":"5864068b0355f31900380477","ref":"","in":"body","required":false,"desc":"(Optional) Snippet name.","default":"","type":"string","name":"name"},{"_id":"5864068b0355f31900380476","ref":"","in":"body","required":false,"desc":"(Optional) Snippet source.","default":"","type":"string","name":"source"},{"_id":"58f153333b1a920f004acf02","ref":"","in":"query","required":false,"desc":"(Optional) Pass `expand=savedBy` to expand `savedBy` to include id, name, and email of user who last saved this snippet.","default":"","type":"string","name":"expand"},{"_id":"5ab07ae783af740041e43568","ref":"","in":"body","required":false,"desc":"(Optional) Snippet custom shortcut for quick matching.","default":"","type":"string","name":"customShortcut"}],"url":"/v1/snippets/:id"},"isReference":true,"order":130,"body":"You must either own or have edit access to the snippet or the snippet's parent tag to use this.\n\nFor response format, see [/snippets](doc:snippets)","excerpt":"Updates a snippet","slug":"snippets-id-patch","type":"endpoint","title":"/snippets/:id"}

patch/snippets/:id

Updates a snippet

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
string
Snippet Id

Query Params

expand:
string
(Optional) Pass `expand=savedBy` to expand `savedBy` to include id, name, and email of user who last saved this snippet.

Body Params

title:
string
(Optional) Snippet subject. If `name` is empty when this is set, `name` will be automatically set to this value (as a convenience, as the UI only shows the name)
name:
string
(Optional) Snippet name.
source:
string
(Optional) Snippet source.
customShortcut:
string
(Optional) Snippet custom shortcut for quick matching.

Examples


Result Format


Documentation

You must either own or have edit access to the snippet or the snippet's parent tag to use this. For response format, see [/snippets](doc:snippets)

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