Public Web API: Response model for editing a group’s data (Edit group data)

Methods

PUT — Edit group data

Resource

{
    "error": "string",
    "group": {
        "__createdAt": "date-time",
        "__createdBy": "uuid",
        "__deletedAt": "date-time",
        "__id": "uuid",
        "__name": "string",
        "__updatedAt": "date-time",
        "__updatedBy": "uuid",
        "description": "string",
        "isDefault": "boolean",
        "isRole": "boolean"
    },
    "success": "boolean"
}

Properties

Name	Type	Description	Additional
error	string	Error message if `success == false`	Optional
group	object	Full metadata description of a group	Optional
group.__createdAt	date-time	Date the item was created	Optional
group.__createdBy	uuid	Unique ID of the user who created the current item	Optional
group.__deletedAt	date-time	Date the item was deleted	Optional
group.__id	uuid	Unique ID	Optional
group.__name	string	Name	Optional
group.__updatedAt	date-time	Date the data was last changed	Optional
group.__updatedBy	uuid	Unique ID of the user who edited the current item	Optional
group.description	string	Description	Optional
group.isDefault	boolean	Default group	Optional
group.isRole	boolean	Role flag	Optional
success	boolean	Successful request flag	Optional