Classic APIs
ClassicGroupsApi
setGroupShout

setGroupShout

Sets group shout (status).

Parameters

NameTypeDescription
groupIdIdentifierThe id of the group to set the shout for.
message🤷The content of the new shout.

Example

const { data: newShout } = await ClassicGroupsApi.setGroupShout({ groupId: 5850082, newShout: "Hello World!" }); 

Example Data

{
  body: "Hello World!",
  poster: {
    hasVerifiedBadge: false,
    userId: 45348281,
    username: "MightyPart",
    displayName: "MightyPart",
  },
  created: 2020-03-31T18:36:51.607Z,
  updated: 2023-09-15T16:21:00.272Z,
} 

Endpoint

PATCH /v1/groups/{groupId}/status