AFaffinda
Organization API - Invitation

Update an invitation

Changed on

Update the detail of an invitation.

patch/v3/invitations/{identifier}

Request

Path parameters

identifierstring required

Uniquely identify an invitation.

Example:mEFayXdO

Invitation identifier.

Request body

role'admin' | 'member'

Example request

{
  "role": "admin"
}

Response

Successfully updated invitation.

identifierstring

Uniquely identify an invitation.

emailstring

The email which the invitation is sent to.

role'admin' | 'member'
status'pending' | 'accepted' | 'declined'
expiryDatestring date

The date after which the invitation expires. Default is 10 days from now.

createdDtstring date-time

Example response

{
  "identifier": "mEFayXdO",
  "organization": {
    "identifier": "mEFayXdO",
    "name": "Grove Street King",
    "userRole": "admin",
    "avatar": "https://affinda-api.s3.amazonaws.com/media/org-avatar.png?AWSAccessKeyId=KEY&Signature=SIG",
    "resthookSignatureKey": "465c6598bd34c0558f0ce256c43209d49fa85b0ff3e4c18b24e408b7563143ad"
  },
  "email": "carljohnson@grove.street",
  "role": "admin",
  "invitedBy": {
    "id": 1,
    "name": "Carl Johnson",
    "username": "carljohnson",
    "email": "carljohnson@grove.street",
    "avatar": "https://affinda-api.s3.amazonaws.com/media/user-avatar.png?AWSAccessKeyId=KEY&Signature=SIG"
  },
  "respondedBy": {
    "id": 1,
    "name": "Carl Johnson",
    "username": "carljohnson",
    "email": "carljohnson@grove.street",
    "avatar": "https://affinda-api.s3.amazonaws.com/media/user-avatar.png?AWSAccessKeyId=KEY&Signature=SIG"
  }
}

Changes

  • acca5642c0bcRevision changes
    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      added the required property / to the response with the status

  • 978cf99a2ac0Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status