Group Set Custom Fields

Sets the custom fields for the private group.

URL Requires Auth HTTP Method
/api/v1/groups.setCustomFields yes POST


One of roomId or roomName is required.

Argument Example Required Description
roomId euzoT67Gx6nXcn66M Required The private group’s id
roomName channel.cf.1518990680083 Required The private group’s name
customFields {"company": "sell-and-more"} Required The custom fields to set for the private group.

Example Call

curl -H "X-Auth-Token: 8h2mKAwxB3AQrFSjLVKMooJyjdCFaA7W45sWlHP8IzO" \
     -H "X-User-Id: ew28FnZqipDpvKw3R" \
     -H "Content-type: application/json" \
     http://localhost:3000/api/v1/groups.setCustomFields \
     -d '{"roomId": "euzoT67Gx6nXcn66M", "customFields":{"company": "sell-and-more"} }'

Example Result

  "developerWarning":"[WARNING]: The \"usernames\" field has been removed for performance reasons. Please use the \"*.members\" endpoint to get a list of members/users in a room."

Change Log

Version Description
0.62.0 Added