Sign in
Manage projects and library content

Changed on

Update an invite status

Update the status of an invite. Status accepted:

  • cancelled
  • accepted
  • declined

Notes:

  • When submitting accepted the invite status becomes automatically in_progress
  • Only the sender can cancel an invite, and if only if the invite is still pending.
  • Only the recipient can accept or decline, if and only if the invite is still pending.
patch/api/v2/project-ownership/invites/{uid_invite}/

Request

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

Path parameters

uid_invitestring required

Request body

status'accepted' | 'cancelled' | 'declined' | 'expired' | 'pending' | 'resent'
  • accepted - Accepted
  • cancelled - Cancelled
  • declined - Declined
  • expired - Expired
  • pending - Pending
  • resent - Resent

Response

urlstring uri required
sender | recipientstring uri required
status'accepted' | 'cancelled' | 'declined' | 'expired' | 'pending' | 'resent' required
  • accepted - Accepted
  • cancelled - Cancelled
  • declined - Declined
  • expired - Expired
  • pending - Pending
  • resent - Resent
date_createdstring date-time required
date_modifiedstring date-time required

Example response

{
  "url": "https://kf.kobotoolbox.org/api/v2/project-ownership/invites/poi52fGkwDjQeZkUxcaou39q/",
  "sender |  recipient": "https://kf.kobotoolbox.org/api/v2/users/bob/",
  "transfers": [
    {
      "url": "https://kf.kobotoolbox.org/api/v2/project-ownership/invites/poi52fGkwDjQeZkUxcaou39q/transfers/pot54pTqM5qwKdZ4wnNdiwDY/",
      "asset": "https://kf.kobotoolbox.org/api/v2/assets/a3C9wWefqZVkChNLKqqXVZ/"
    }
  ]
}

Changes