PUT
/
admin
/
groups
/
{group_id}
Edit a specific group
curl --request PUT \
  --url https://api.helpyousponsor.com/v1/admin/groups/{group_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 301,
  "name": "HYS Demos",
  "client_id": "207",
  "group_all": "1",
  "account": "1",
  "groups": "1",
  "group-{group_id}": "1",
  "admins": "1",
  "forms": "1",
  "new_form": "1",
  "manage_programs": "1",
  "manage_settings": "1",
  "manage_designations": "1",
  "manage_email": "1",
  "email_manager": "1",
  "donations": "1",
  "form_report": "1",
  "program-{program_id}": "1",
  "donor-{donor_id}": "1",
  "program-all": "1",
  "donor-all": "1",
  "disable_entity_archive": "1",
  "disable_donor_archive": null,
  "disable_donor_delete": null,
  "disable_donor_restore": null,
  "disable_entity_delete": null,
  "disable_entity_restore": null,
  "group_id": 301,
  "disable_message_send_without_approval": null
}'
{
  "message": "Successfully Updated Group"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
group_id
integer
required

ID of the group to edit

Body

application/json
​
id
integer

The id of the group

Example:

301

​
name
string

The name of the group

Example:

"HYS Demos"

​
client_id
string
Example:

"207"

​
group_all
string
Example:

"1"

​
account
string
Example:

"1"

​
groups
string
Example:

"1"

​
group-{group_id}
string
Example:

"1"

​
admins
string
Example:

"1"

​
forms
string
Example:

"1"

​
new_form
string
Example:

"1"

​
manage_programs
string
Example:

"1"

​
manage_settings
string
Example:

"1"

​
manage_designations
string
Example:

"1"

​
manage_email
string
Example:

"1"

​
email_manager
string
Example:

"1"

​
donations
string
Example:

"1"

​
form_report
string
Example:

"1"

​
program-{program_id}
string
Example:

"1"

​
donor-{donor_id}
string
Example:

"1"

​
program-all
string
Example:

"1"

​
donor-all
string
Example:

"1"

​
disable_entity_archive
string
Example:

"1"

​
disable_donor_archive
string
Example:

null

​
disable_donor_delete
string
Example:

null

​
disable_donor_restore
string
Example:

null

​
disable_entity_delete
string
Example:

null

​
disable_entity_restore
string
Example:

null

​
group_id
integer

The group id

Example:

301

​
disable_message_send_without_approval
string
Example:

null

Response

Successfully Updated the Group

​
message
string
Example:

"Successfully Updated Group"