Invite Actions

Accept an invitation

post

Accepts a pending invitation using the invite ID or code

Path parameters
inviteIdstring · uuidRequired

Unique ID of the invite to accept

Example: invite123-def6-7890-abcd-ef1234567890
Responses
200

Invitation accepted successfully

application/json
post
POST /memberships/invites/{inviteId}/accept HTTP/1.1
Host: api.example.com
Accept: */*

{
  "success": true,
  "message": "Invitation accepted successfully",
  "invite": {
    "id": "invite123-def6-7890-abcd-ef1234567890",
    "code": "ABC12345",
    "status": "accepted"
  },
  "membership": {
    "id": "membership456-abc1-2345-6789-abcdef123456",
    "type": "team",
    "teamId": "team123-def6-7890-abcd-ef1234567890",
    "userId": "user789-def6-7890-abcd-ef1234567890"
  }
}

Reject an invitation

post

Rejects a pending invitation

Path parameters
inviteIdstring · uuidRequired

Unique ID of the invite to reject

Example: invite123-def6-7890-abcd-ef1234567890
Body
reasonstringOptional

Optional reason for rejecting the invitation

Example: Not interested at this time
Responses
200

Invitation rejected successfully

application/json
post
POST /memberships/invites/{inviteId}/reject HTTP/1.1
Host: api.example.com
Content-Type: application/json
Accept: */*
Content-Length: 40

{
  "reason": "Not interested at this time"
}
{
  "success": true,
  "message": "Invitation rejected",
  "invite": {
    "id": "invite123-def6-7890-abcd-ef1234567890",
    "code": "ABC12345",
    "status": "rejected",
    "rejectionReason": "Not interested at this time"
  }
}
PreviousOrganization InvitesNextOrganization Knocks