Grant or Invite Project Access

POST

/v1/project-access-grants

The projectRole property selects a built-in project role and is available for general-purpose project collaboration. Creating or managing custom project roles is an Enterprise feature; organizations without an Enterprise plan cannot create custom roles. The customProjectRoleId property selects an existing custom project role. That role must already exist, belong to the specified team, and be usable by the authenticated caller. This operation does not create a custom role. Exactly one of projectRole and customProjectRoleId must be supplied.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Query Params

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

The request completed with a grant, role update, unchanged result, skipped role change, or invitation result. granted added an existing active team member to the project; updated changed an existing project member role; already_granted means the same role was already assigned; skipped_role_downgrade means the requested role change was not applied; invited means an invitation was sent; invitation_failed means the invitation could not be delivered.

Bodyapplication/json

🟠401

🟠403

🟠422

🟠429

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.apidog.com/v1/project-access-grants?locale=en-US' \
--header 'X-Apidog-Api-Version: 2026-05-28' \
--header 'X-Apidog-Api-Version: 2024-03-28' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "projectRole": "string",
    "customProjectRoleId": null
}'

Response Example

200 - Project Member Added

{
    "success": true,
    "data": {
        "status": "granted",
        "teamId": 41,
        "projectId": 73,
        "email": "member@example.com",
        "projectRole": "readonly"
    }
}

Modified at 2026-09-01 06:21:01

Find Accessible Teams by Exact Match

List Available Project Roles for a Team