Update a Group - Aladia API

This endpoint updates a group by its unique ID.

curl --location --request PATCH 'https://api.aladia.io/v2/organizations/6673e4486aebfd80ed604b22/groups/6673ea233b89939082fa4c36' \ --header 'apikey: ' \ --header 'Content-Type: application/json' \ --data-raw '{ "name": "Yohannes groups updated", "picture": { "fileId": "66fd603aabf359a0460ebc34", "metadata": { "mimetype": "image/png", "size": -50292426, "name": "harum minima quas", "offset_x": -52312727, "offset_y": -75607888, "encoding": "nostrud" } }, "color": "#43235c", "icon": "red" }'

{ "id": "670775694daebf393b266ea1", "name": "Maple Grove", "picture": "https://loremflickr.com/640/480/fashion", "color": "0.14,0.71,0.09,0.84", "icon": "https://cloudflare-ipfs.com/ipfs/Qmd3W5DuhgHirLHGVixi6V76LhCkZUz6pnFt5AJBiyvHye/avatar/927.jpg", "createdAt": "2009-08-08", "updatedAt": "1972-02-17", "description": "Est occaecati laudantium dolor laudantium occaecati. Illo earum natus eum unde non deserunt cum eius. Beatae blanditiis quaerat impedit.", "creatorProfile": { "id": "670775694daebf393b266ea1", "username": "Wilma97", "firstName": "Darwin", "lastName": "Dare", "picture": "https://loremflickr.com/640/480/nature", "email": "Giovani_Bradtke68@hotmail.com", "totalFollowers": 7862228.194532588, "totalFollowings": 11305626.86822106, "type": "teacher", "online": true }, "organization": { "id": "veniam sit ut dolor", "name": "cumque culpa nisi", "picture": "https://loremflickr.com/640/480/technics" } }

Request

Path Params

organizationId

string

required

Example:

6673e4486aebfd80ed604b22

groupId

string

required

Example:

6673ea233b89939082fa4c36

Header Params

apikey

string

optional

Example:

Body Params application/json

name

string

optional

name of the group

picture

object (fileUrl.rto)

optional

ref to picture

fileId

string

optional

Example:

66fd603aabf359a0460ebc34

metadata

object (metaData.rto)

optional

color

string

optional

default to #FAFAFA

icon

string

optional

default to ""

description

string

optional

Description of a group

role

object

optional

role

string

required

organization role

secondaryRoles

array[string]

required

Sedondary organizatio roles

spaces

array [object {2}]

optional

courses

array [object {3}]

optional

calendars

array [object {2}]

required

numberOf

object

optional

member

string

optional

Examples

Responses

🟢200Success

application/json

Body

string

optional

Example:

670775694daebf393b266ea1

name

string

optional

name of the group

picture

string | null

optional

ref to picture

color

string

optional

default to #FAFAFA

icon

string

optional

default to ""

createdAt

string <date>

optional

date cretation

updatedAt

string <date>

optional

date

description

string | null

optional

Description of a group

role

object

optional

role

string

optional

organization role

secondaryRoles

array[string]

optional

Sedondary organizatio roles

spaces

array [object {2}]

optional

courses

array [object {3}]

optional

calendars

array [object {2}]

optional

numberOf

object

optional

member

string

optional

creatorProfile

object (populatedProfile.rto)

optional

string

optional

ID of the user

Example:

670775694daebf393b266ea1

username

string

optional

unique username

firstName

string

optional

first name of profile

lastName

string

optional

last name of profile

picture

string | null

optional

url avatar image

string <email> | null

optional

Email of the profile

type

enum<string>

optional

user or teacher

Allowed values:

userteacher

address

object | null

optional

lastActivity

string

optional

Last activiy by the user

online

boolean

optional

organization

object (profileOrganization.rto)

optional

string

required

id of organization

name

string

required

Name of organization

picture

string

optional

picture of the organization

🟠401Unauthorized

🟠403Forbidden