Skip to content

Update a group

Request

Update a Group

Security
bearerToken
Path
idstringrequired

The unique ID of the group

Example:cff665ca-ce35-5418-b9d5-70ee815db4bc
Bodyapplication/jsonrequired
namestring or null

The name of the group

roleobject or null

The role of users in this group

Enum:"BASIC""CONTRIBUTOR"
Example:"BASIC"
fieldWhitelistobject or null
curl -i -X PATCH \
  https://api-v2.dash.app/groups/cff665ca-ce35-5418-b9d5-70ee815db4bc \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "role": "BASIC",
    "fieldWhitelist": {
      "fieldWhitelistType": "ALL_OPTIONS"
    }
  }'

Responses

Success

Bodyapplication/json
resultobjectrequired
permittedActionsArray of objectsrequired
Response
{
  "result": {
    "id": "cfb665ca-ce35-4418-b9d5-70ee815db4bd",
    "accountId": "cfb665ca-ce35-4418-b9d5-70ee815db4bd",
    "name": "My Group Name",
    "role": "BASIC",
    "numberOfUsers": 56,
    "fieldWhitelist": { … }
  },
  "permittedActions": [
    { … }
  ]
}