Update Group

POST 
/org/:orgId/groups/:groupId

Update a Group identified by groupId.

Request

Path Parameters

orgId stringrequired

The Organization ID (UUID) for which you are querying.

groupId stringrequired

The Group ID (UUID) for which you are querying.

application/json

Body

required

any

Responses

200

Success.

application/json

Schema

Schema

any

Example (from schema)

{
  "status": {
    "i18n_message": "response.ok",
    "message": "OK"
  },
  "response": {
    "ID": "2f81a670-6c9b-4af4-71fd-7a79adda0da2",
    "OrgID": "default",
    "Name": "My New Group Name"
  }
}

Example

{
  "status": {
    "i18n_message": "response.ok",
    "message": "OK"
  },
  "response": {
    "ID": "2f81a670-6c9b-4af4-71fd-7a79adda0da2",
    "OrgID": "default",
    "Name": "My New Group Name"
  }
}

401

This error will occur if calling user does not have access right for the API.

404

This error will occur if the org identified by orgId does not exist.

500

A server error occurred. Check the logs for more details.

Loading...