civis (version 2.1.2)

groups_patch: Update some attributes of this Group

Description

Update some attributes of this Group

Usage

groups_patch(id, name = NULL, description = NULL)

Arguments

id

integer required. The ID of this group.

name

string optional. This group's name.

description

string optional. The description of the group.

Value

A list containing the following elements:

id

integer, The ID of this group.

name

string, This group's name.

createdAt

string, The date and time when this group was created.

description

string, The description of the group.

slug

string, The slug for this group.

organizationId

integer, The ID of the organization this group belongs to.

organizationName

string, The name of the organization this group belongs to.

memberCount

integer, The total number of members in this group.

members

array, An array containing the following fields:

• id integer, The ID of this user.

• name string, This user's name.

• username string, This user's username.

• initials string, This user's initials.

• online boolean, Whether this user is online.