Sign in
protocol_groups

Update Protocol Group

Update a protocol group's name and/or description.

Renaming a group affects every protocol in it, since membership is by reference rather than by copied name.

Parameters

group_id : str ID of the group to update. body : UpdateProtocolGroupBody Fields to update. Omitted fields are left unchanged; an explicit description: null clears the description.

Returns

ProtocolGroup The updated group.

Raises

NotFoundError If the group does not exist or belongs to another organization. ConflictError If the new name collides with another group in the same project.

patch/protocol_groups/{group_id}

Path parameters

group_idstring required

Request body

namestring nullable

New name for the group

descriptionstring nullable

New description

Response

Successful Response

idstring nullable

Unique identifier for the group

namestring required

Name of the group, unique within the project

descriptionstring nullable

Optional note on what relates the protocols in this group

organization_idstring required

ID of the organization that owns this group

project_idstring required

ID of the project that owns this group

created_bystring nullable

User ID of the user who created this group

created_atstring nullable

When the group was created

updated_atstring nullable

When the group was last updated

protocol_countinteger nullable

Number of protocols in this group. Present on list responses, None when the group is fetched on its own.

created_by_emailstring nullable

Email of the user who created this group

Changes