Sign in
Groups
Partners

Add a member to a group with a role.

Changed on

Adds the member to the given group in the given role.

Notes:

  • Look up the groupId by searching groups for the organization.
  • Look up the groupRoleId by fetching group types for the organization.
  • The role must belong to the group's type. Roles are not interchangeable between types.
  • This request is safe to retry. If the member already holds the role in the group, the existing record is returned and created is false. No error is raised and no duplicate record is created.
  • Adding a member to a group does not remove any other group membership. To give a member a second role in the same group, call this endpoint again with a different groupRoleId.
  • The group must be active. A group is inactive if it has been deactivated directly or if any of its ancestors have been deactivated.
  • A GROUP_MEMBER_CREATED webhook event is sent when a new membership is created. If your integration also subscribes to that event, you will receive events for memberships that you created.
post/api/partners/orgs/{orgId}/members/{memberId}/groups

Request

  • Base URL: https://api.mobilecoach.org (the document declares no server; this is the origin it was published from)
  • URL: https://api.mobilecoach.org/api/partners/orgs/{orgId}/members/{memberId}/groups
  • Auth: AuthToken (a scheme the document does not define)

Path parameters

orgIdinteger required
memberIdinteger required

Request body

groupIdinteger required
groupRoleIdinteger required

Response

OK

createdboolean required

Changes