Sign in

Update pending invitee

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

Sets custom User fields on someone who hasn't joined the app yet. When they join, the values are copied onto their user record.

The fields you send are merged into the stored ones, and a field you leave out keeps its value. Built-in fields such as email, full_name, role and id are ignored. Field-level security rules on the User entity apply, and a value over 20,000 characters is refused. Once the person has joined, change them with Update app user instead, because this endpoint returns a 404 for them.

<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>

put/api/apps/{app_id}/access-requests/{request_id}

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.

app_idstring required

ID of the app.

ID of the app.

Request body

dataobject required

Custom User fields to set on the invitation, as field names and values.

Example request

{
  "data": {
    "department": "sales",
    "team": "EMEA"
  }
}

Response

The invitation's custom fields after the update.

successboolean required

Always true. An update that doesn't happen returns an error instead.

dataobject required

The invitation's custom User fields after the update, limited by the User entity's field-level read rules.

Example response

{
  "success": true,
  "data": {
    "department": "sales",
    "team": "EMEA"
  }
}

Changes

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