Sign in
User / team / organization / usage

Changed on

Update Organization Invite

  • Update an organization invite to accept, decline, cancel, expire, or resend.
  • Update the role of the invitee to admin or member. Only the owner or admin can update the role.
patch/api/v2/organizations/{uid_organization}/invites/{guid}/

Request

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

Path parameters

guidstring required

GUID of the invite

uid_organizationstring required

UID of the organization asset

Request body

OR

Response

invitee_role'admin' | 'member' required
  • admin - admin
  • member - member
status'accepted' | 'cancelled' | 'declined' | 'expired' | 'pending' | 'resent' required
  • accepted - Accepted
  • cancelled - Cancelled
  • declined - Declined
  • expired - Expired
  • pending - Pending
  • resent - Resent
urlstring uri required
invited_bystring uri required
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