Sign in
User / team / organization / usage

Changed on

Create Organization Invite

  • Create organization invites for registered and unregistered users.
  • Set the role for which the user is being invited - (Choices: member, admin). Default is member.
post/api/v2/organizations/{uid_organization}/invites/

Request

  • The document declares no server URL.
  • Auth: one of:
    • HTTP basic
    • API key in header Authorization

Path parameters

uid_organizationstring required

UID of the organization asset

Request body

role'admin' | 'member' required
  • admin - admin
  • member - member
inviteesstring[] required

Response

urlstring uri required
invited_bystring uri required
statusstring required
invitee_role'admin' | 'member' required
  • admin - admin
  • member - member
organization_namestring required
createdstring date-time required
modifiedstring date-time required
inviteestring required

Example response

[
  {
    "url": "https://kf.kobotoolbox.org/api/v2/organizations/orgR6zUBwMHop2mgGygtFd6c/invites/f3ba00b2-372b-4283-9d57-adbe7d5b1bf1/",
    "invited_by": "https://kf.kobotoolbox.org/api/v2/users/bob/"
  }
]

Changes