group_update

Update a group.

You must be authorized to edit the group.

Note

Update methods may delete parameters not explicitly provided in the data_dict. If you want to edit only a specific attribute use group_patch instead.

Plugins may change the parameters of this function depending on the value of the group's type attribute, see the IGroupForm plugin interface.

Authorization

apiTokenHeader

Authorization<token>

CKAN API token

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

id?string

the name or id of the group to update

name?string

the name of the group, a string between 2 and 100 characters long, containing only lowercase alphanumeric characters, -, and _

title?string

the title of the group

description?string

the description of the group

image_url?string

the URL to an image to be displayed on the group's page

type?string

the type of the group (default: 'group'), IGroupForm plugins associate themselves with different group types and provide custom group handling behavior for these types cannot be 'organization'

state?string

the current state of the group, e.g. 'active' or 'deleted', only active groups show up in search results and other lists of groups, this parameter will be ignored if you are not authorized to change the state of the group (default: 'active')

approval_status?string

extras?array<>

the group's extras, extras are arbitrary (key: value) metadata items that can be added to groups, each extra dictionary should have keys 'key' (a string), 'value' (a string), and optionally 'deleted'

packages?array<>

the datasets (packages) that belong to the group, a list of dictionaries each with keys 'name' (string, the id or name of the dataset) and optionally 'title' (string, the title of the dataset)

groups?array<>

the groups that belong to the group, a list of dictionaries each with key 'name' (string, the id or name of the group) and optionally 'capacity' (string, the capacity in which the group is a member of the group)

users?array<>

the users that belong to the group, a list of dictionaries each with key 'name' (string, the id or name of the user) and optionally 'capacity' (string, the capacity in which the user is a member of the group)

curl -X PUT "http://localhost:5000/api/3/action/group_update" \  -H "Content-Type: application/json" \  -d '{}'