User Groups API
Use the User Group API to specify user group information and whether groups can approve or watch documents.
Actions
User Group allows you to:
| Verb | Path | Action | Description | ||
|---|---|---|---|---|---|
| POST | /api/user_groups |
create | Create User Group | ||
| GET | /api/user_groups |
index | Query User Groups | ||
| GET | /api/user_groups/:id |
show | Show User Group | ||
| PATCH | /api/user_groups/:id |
update | Update User Group | ||
| PUT | /api/user_groups/:id |
update | Update User Group | ||
Elements
| Element | Description | Req'd | Unique | Allowable Value | In | Out | Data Type |
|---|---|---|---|---|---|---|---|
| active | Active | Yes/No, True/False | yes | yes | boolean | ||
| can-approve | User group has the ability to be an approver | Yes/No, True/False | yes | yes | boolean | ||
| created-at | Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ | yes | datetime | ||||
| created-by | User who created | yes | User | ||||
| description | Description | yes | yes | text | |||
| id | Coupa unique identifier | yes | integer | ||||
| mention-name | Mention name | yes | yes | string(255) | |||
| name | Name | yes | yes | yes | yes | string(255) | |
| open | User group is open for everyone to join or owner must invite others | Yes/No, True/False | yes | yes | boolean | ||
| owner | Owner | yes | yes | User Group | |||
| type | Blank for Groups, Project for Projects | yes | yes | string(255) | |||
| updated-at | Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ | yes | datetime | ||||
| updated-by | User who updated | yes | User | ||||
| users | Users | yes | yes | User | |||
| avatar-thumb-url | URL for avatar thumbnail | yes | string | ||||