Function createOrUpdateGroup

createOrUpdateGroup(connectionOptions: {
    apiUrl: string;
    headers: Object;
}, groupId: string, newOrUpdatedGroup: {
    description?: string;
    groupid?: string;
    name: string;
}): Promise<Group>
See
createOrUpdateGroup: https://h.readthedocs.io/en/latest/api-reference/#tag/groups/paths/~1groups~1{id}/put

Throws
ApiError
Parameters
- connectionOptions: {
  apiUrl: string;
  headers: Object;
  }
  - apiUrl: string
    
    Target annotation database API URL
  - headers: Object
    
    Headers responsible for authenticating the request and the Hypothes.is Accept header
- groupId: string
  
  ID of the group to update
- newOrUpdatedGroup: {
      description?: string;
      groupid?: string;
      name: string;
  }
  
  New or updated group
  - Optional description?: string
  - Optional groupid?: string
  - name: string
Returns Promise<Group>
- Defined in src/api/createOrUpdateGroup.ts:21

Generated using TypeDoc