Knock Actions

Approve a knock request

post

https://api.example.comhttps://staging-api.example.com

/memberships/knocks/{knockId}/approve

Approves a pending knock request and creates the corresponding membership

Path parameters

knockIdstring · uuidRequired

Unique ID of the knock to approve

Example: knock123-def6-7890-abcd-ef1234567890

Body

application/json

approvalMessagestringOptional

Optional message for the approval

Example: Welcome to the team! We're excited to have you.

customRolestringOptional

Override the requested role (optional)

Example: member

customPermissionsstring[]Optional

Override the requested permissions (optional)

Example: ["read","write"]

Responses

200

Knock approved successfully

application/json

500

Internal server error

application/json

post

/memberships/knocks/{knockId}/approve

HTTPcURLJavaScriptPython

POST /memberships/knocks/{knockId}/approve HTTP/1.1
Host: api.example.com
Content-Type: application/json
Accept: */*
Content-Length: 69

{
  "approvalMessage": "Welcome to the team! We're excited to have you."
}

{
  "success": true,
  "message": "Knock request approved successfully",
  "knock": {
    "id": "knock123-def6-7890-abcd-ef1234567890",
    "status": "approved",
    "approvalMessage": "Welcome to the team!"
  },
  "membership": {
    "id": "membership456-abc1-2345-6789-abcdef123456",
    "type": "team",
    "teamId": "team123-def6-7890-abcd-ef1234567890",
    "userId": "user789-def6-7890-abcd-ef1234567890"
  }
}

Reject a knock request

post

https://api.example.comhttps://staging-api.example.com

/memberships/knocks/{knockId}/reject

Rejects a pending knock request

Path parameters

knockIdstring · uuidRequired

Unique ID of the knock to reject

Example: knock123-def6-7890-abcd-ef1234567890

Body

application/json

rejectionReasonstringOptional

Reason for rejecting the knock request

Example: We are not hiring at this time

rejectionMessagestringOptional

Optional message for the rejection

Example: Thank you for your interest. We'll keep your information for future opportunities.

Responses

200

Knock rejected successfully

application/json

500

Internal server error

application/json

post

/memberships/knocks/{knockId}/reject

HTTPcURLJavaScriptPython

POST /memberships/knocks/{knockId}/reject HTTP/1.1
Host: api.example.com
Content-Type: application/json
Accept: */*
Content-Length: 156

{
  "rejectionReason": "We are not hiring at this time",
  "rejectionMessage": "Thank you for your interest. We'll keep your information for future opportunities."
}

{
  "success": true,
  "message": "Knock request rejected",
  "knock": {
    "id": "knock123-def6-7890-abcd-ef1234567890",
    "status": "rejected",
    "rejectionReason": "We are not hiring at this time",
    "rejectionMessage": "Thank you for your interest."
  }
}