Add External User to Group

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Authorization

This endpoint requires Authorization.

Path Parameters

ParameterTypeDescriptionRequired
idstringUUID of the group.Yes

Request Body

KeyTypeDescriptionRequired
emailstringEmail address of the external user to add.Yes
{
  "email": "[email protected]"
}

Response

Returns the updated group with its current members, reflecting the addition.

📘

Note

This operation is idempotent — if the user is already in the group the request succeeds without error.

Errors

StatusMessageDescription
404User not foundNo user with that email exists in the partner or approved organizations.
400Provided email is ambiguousThe email matches more than one user.
404Group not foundThe group does not exist or does not belong to this organization.
422Parameter email is requiredThe email field is missing.
Path Params
string
required
Body Params
string
required
Response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json