Create an access request

POST

/teams/:teamId/access-requests

Creates an access request for a team. Access requests include actions such as request to join a team, upgrading a user’s role, adding members, and requesting team role access to another team.

Note:

If a team discovery is enabled, the team’s access request is automatically approved.

Authentication

x-api-keystring

API Key authentication via header

Authorizationstring

A valid SCIM API key for calls to SCIM endpoints.

A valid [SCIM API key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key) for calls to SCIM endpoints.

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Path parameters

teamIdintegerRequired

The team's ID.

Request

This endpoint expects an object.

entityListlist of objectsRequired

A list of the entities for which to create access requests.

roleenum or nullRequired

The team role to request.

reasonstringRequired

The reason for the access request.

requestTypeenumRequired

The type of access request.

Response

Successful Response

resultlist of objects

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error

$	curl -X POST https://api.getpostman.com/teams/123/access-requests \
>	-H "x-api-key: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"entityList": [
>	{
>	"entityType": "user",
>	"entityId": "12345678"
>	}
>	],
>	"role": "TEAM_MANAGER",
>	"reason": "Needs the manager role.",
>	"requestType": "UPGRADE_ROLE"
>	}'

1	{
2	"result": [
3	{
4	"entityType": "user",
5	"entityId": 12345678,
6	"role": "TEAM_MANAGER",
7	"status": "Skipped",
8	"reason": "Entity has this role"
9	}
10	]
11	}

Authentication

Path parameters

Headers

Request

Response

Errors