{"__v":3,"_id":"582ced32b5ecce0f0066a569","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":15,"_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","58db348aa32c8419002433bb"],"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-11-16T23:35:14.881Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"curl --request PATCH \\\n    --header 'Content-Type: application/json' \\\n    --header \"X-API-Token: <your token>\" \\\n    https://api.mixmax.com/v1/contactgroups/5810142fd61495a1799bba05 \\\n    -d '{\\\n    \t\"name\": \"Foo\"\\\n      \"shared\": {\"userEmail\": \"foo:::at:::mixmax.com\", \"accepted\": \"true\"}\\\n      \"teamIds\": [\"sFSmpc3C7PkkFxs7n\"]\\\n    }'","language":"curl"}]},"method":"patch","results":{"codes":[{"name":"","code":"{\n  \"_id\":\"5810142fd61495a1799bba05\",\n  \"userId\":\"pnrondsRr7MoYDR6x\",\n  \"name\":\"Foo\",\n  \"teamIds\":[\"sFSmpc3C7PkkFxs7n\"],\n  \"shared\":[{\"userEmail\":\"foo@mixmax.com\",\"accepted\":true}]\n}","language":"json","status":200},{"name":"","code":"","language":"json","status":404}]},"settings":"","auth":"required","params":[{"_id":"582668b8f31aba3900a676b2","ref":"","in":"path","required":true,"desc":"The _id of the Contact Group to edit","default":"","type":"string","name":"id"},{"_id":"582ced32b5ecce0f0066a56a","ref":"","in":"body","required":false,"desc":"Name for the Contact Group","default":"","type":"string","name":"name"},{"_id":"588930b27fe18319006855db","ref":"","in":"query","required":false,"desc":"Pass `expand=userId` to replace the userId with `_id` and `name`","default":"","type":"string","name":"expand"}],"url":"/v1/contactgroups/:id"},"isReference":true,"order":22,"body":"You must either own or have edit access to the group to use this.\n\nFor response format, see [/contactgroups](http://developer.mixmax.com/docs/contactgroups).","excerpt":"Edit a Contact Group","slug":"contactgroupsid-1","type":"endpoint","title":"/contactgroups/:id"}

patch/contactgroups/:id

Edit a Contact Group

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
string
The _id of the Contact Group to edit

Query Params

expand:
string
Pass `expand=userId` to replace the userId with `_id` and `name`

Body Params

name:
string
Name for the Contact Group

Examples


Result Format


Documentation

You must either own or have edit access to the group to use this. For response format, see [/contactgroups](http://developer.mixmax.com/docs/contactgroups).

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