Post
/api/v1/groups.setCustomFields
Sets the custom fields for the private channel.
Permission required: edit-room
Changelog
| Version | Description |
|---|---|
| 0.62.0 | Added |
Header parameters
X-Auth-Token
stringRequired
The authToken of the authenticated user.
ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired
The userId of the authenticated user.
ExamplerbAXPnMktTFbNpwtJ
Body parameters
object
roomId
string Required
The private group's ID. Alternatively, use the roomName parameter and provide the room's name as the value. You can find the IDs by using any of the following endpoints:
- Get List of User Groups: This endpoint returns all private channels in the workspace, if you have the required permissions to view them.
- Get Groups: This endpoint returns the private channels that you are a member of.
customFields
object Required
The custom fields to set for the private group.
Responses
200
401
OK
object
group
object
_id
string
name
string
fname
string
t
string
msgs
integer
u
object
customFields
object
ts
string
ro
boolean
sysMes
boolean
_updatedAt
string
username
string
success
boolean
developerWarning
string