{"__v":0,"_id":"58640c554f771f2f008ec9af","category":{"__v":0,"_id":"57f53fb368a53b2000e03f0f","project":"5588b8a2f6c18d0d005bba03","version":"5588b8a2f6c18d0d005bba06","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-10-05T18:00:19.547Z","from_sync":false,"order":0,"slug":"api","title":"REST API"},"parentDoc":null,"project":"5588b8a2f6c18d0d005bba03","user":"5588b847f6c18d0d005bba01","version":{"__v":14,"_id":"5588b8a2f6c18d0d005bba06","project":"5588b8a2f6c18d0d005bba03","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"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-12-28T19:02:45.429Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"curl","code":"curl -XPATCH -H 'X-API-Token: <your token>' -H \"Content-type: application/json\" -d '{\n  name: \"My test snippet tag\",\n  shared: [{\n  \tuserEmail: \"email:::at:::domain.com\"\n  }],\n  teamIds: [\"5680c1d00000000000000000\"]\n}' https://api.mixmax.com/v1/snippettags/586346d00000000000000000"}]},"results":{"codes":[{"name":"","code":"{\n  _id: \"586346d00000000000000000\",\n  userId: \"586346d00000000000000000\",\n  name: \"My test snippet tag\",\n  snippetIds: [\"5680c1f00000000000000000\"],\n  shared: [{\n  \tuserEmail: \"email@domain.com\",\n    confirmed: true\n  }],\n  teamIds: [\"5680c1d00000000000000000\"]\n}","language":"json","status":200}]},"settings":"","auth":"required","params":[{"_id":"58640253e024922500d366e8","ref":"","in":"path","required":true,"desc":"Snippet tag Id","default":"","type":"string","name":"id"},{"_id":"5864068b0355f31900380477","ref":"","in":"body","required":false,"desc":"Snippet tag name.","default":"","type":"string","name":"name"},{"_id":"5864068b0355f31900380475","ref":"","in":"body","required":false,"desc":"Array of users shared with. Each user object only has an `email` field. The `confirmed` field will be ignored if passed.","default":"","type":"array_object","name":"shared"},{"_id":"5864068b0355f31900380474","ref":"","in":"body","required":false,"desc":"Array of team ids shared with.","default":"","type":"array_string","name":"teamIds"}],"url":"/v1/snippettags/:id"},"isReference":true,"order":56,"body":"","excerpt":"Updates a snippet tag","slug":"snippettags-id-patch","type":"patch","title":"/snippettags/:id"}

patch/snippettags/:id

Updates a snippet tag

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
string
Snippet tag Id

Body Params

name:
string
Snippet tag name.
shared:
array of objects
Array of users shared with. Each user object only has an `email` field. The `confirmed` field will be ignored if passed.
teamIds:
array of strings
Array of team ids shared with.

Examples


Result Format


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