ConsumeGroupInvite

Consumes a group invite to join a group.

Path Parameters

• group_invite_code string required

  Provided by rivet.api.group#CreateGroupInviteOutput$code.

Responses

• 200
• 400
• 403
• 404
• 408
• 429
• 500

---

ConsumeGroupInvite 200 response

Schema

• group_id string

  Possible values: Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

  A universally unique identifier.

BadRequestError 400 response

Schema

• code string required
• message string required
• metadata

  Unstructured metadata relating to an error. Must be manually parsed.

ForbiddenError 403 response

Schema

• code string required
• message string required
• metadata

  Unstructured metadata relating to an error. Must be manually parsed.

NotFoundError 404 response

Schema

• code string required
• message string required
• metadata

  Unstructured metadata relating to an error. Must be manually parsed.

UnauthorizedError 408 response

Schema

• code string required
• message string required
• metadata

  Unstructured metadata relating to an error. Must be manually parsed.

RateLimitError 429 response

Schema

• code string required
• message string required
• metadata

  Unstructured metadata relating to an error. Must be manually parsed.

InternalError 500 response

Schema

• code string required
• message string required
• metadata

  Unstructured metadata relating to an error. Must be manually parsed.