Approve or deny access request

<Info>This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.</Info>

Approves or denies someone's request to join the app.

Approving a request from someone who confirmed their email adds them to the app's users with the request's role, and emails them that they're in. A request made before email confirmation existed is marked approved instead, and the person joins when they next sign in. Someone who signed up with a password can't be approved until they confirm their email. Approving an entry that's already approved or completed sends the approval email again.

Denying deletes the request without notifying the person, and denying an invitation withdraws it. Denying a completed entry deletes only the entry; remove the person with Remove app user.

<Note>This endpoint accepts a personal API key belonging to a user with editor access to the app. A read-only key is refused, and workspace API keys are not accepted.</Note>

post/api/apps/{app_id}/access-requests/{request_id}/{action}

Path parameters

request_idstring required

ID of the access request, as id in the response of List access requests.

ID of the access request, as id in the response of List access requests.

action'approve' | 'deny' required

approve to let the person in, or deny to delete the request.

approve to let the person in, or deny to delete the request.

app_idstring required

ID of the app.

ID of the app.

Response

The reviewed access request.

successboolean required

Always true. A review that doesn't happen returns an error instead.

messagestring required

Access request approved or Access request denied.

Example response

{
  "success": true,
  "message": "Access request approved",
  "access_request": {
    "id": "68d4a1f7c2b9e5001a7f3c60",
    "app_id": "6820f3a4e7b91d003c45a1f2",
    "email": "jane@acme.com",
    "status": "completed"
  }
}

Changes

Changed in 1 of the 14 revisions of this API.1