Update project member

PATCH 
/v2/orgs/:org_id/teams/:team_id/projects/:project_id/members/:member_id

Updates details of a project member, such as the member's role.

Required scope

projects:write

Rate limiting

Level 1

Enterprise only

This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can request temporary access to Enterprise APIs using this form.

Request

Path Parameters

org_id stringrequired
The ID of the organization to which the project member belongs.
Example: 3074457345618265000
team_id stringrequired
The ID of the team to which the project member belongs.
Example: 3074457345619012000
project_id stringrequired
The ID of a Project.
Example: 3074457345618265000
member_id stringrequired
The ID of the member whose details you want to update.
Example: 307445734562315000

application/json

Body

required

role ProjectRole (string)

Possible values: [owner, editor, viewer, commentator, coowner]

Role of the project member.

Responses

200

Contains information about the project member, such as the member's role.

application/json

Schema

Schema

id stringrequired

ID of the project member.

email stringrequired

Email ID of the project member.

role ProjectRole (string)required

Possible values: [owner, editor, viewer, commentator, coowner]

Role of the project member.

type stringrequired

Default value: project_member

Type of the object

Example (from schema)

{
  "id": "3074457345618265000",
  "email": "someone@domain.com",
  "role": "viewer",
  "type": "project_member"
}

400

Malformed request

application/json

Schema

Schema

status number

Default value: 400

HTTP status code.

code string

Default value: invalidParameters

Description of the status code.

message string

Explanation of the error.

type string

Default value: error

Example (from schema)

{
  "status": 400,
  "code": "invalidParameters",
  "message": "string",
  "type": "error"
}

401

Invalid authentication credentials

application/json

Schema

Schema

status number

Default value: 401

HTTP status code.

code string

Default value: tokenNotProvided

Description of the status code.

message string

Explanation of the error.

type string

Default value: error

Example (from schema)

{
  "status": 401,
  "code": "tokenNotProvided",
  "message": "string",
  "type": "error"
}

403

Invalid access

application/json

Schema

Schema

status number

Default value: 403

HTTP status code.

code string

Description of the status code.

message string

Explanation of the error.

type string

Default value: error

Example (from schema)

{
  "status": 403,
  "code": "forbiddenAccess",
  "message": "string",
  "type": "error"
}

404

Not found

application/json

Schema

Schema

status number

Default value: 404

HTTP status code.

code string

Description of the status code.

message string

Explanation of the error.

type string

Default value: error

Example (from schema)

{
  "status": 404,
  "code": "notFound",
  "message": "string",
  "type": "error"
}

409

Conflict

application/json

Schema

Schema

status number

Default value: 409

HTTP status code.

code string

Description of the status code.

message string

Explanation of the error.

type string

Default value: error

Example (from schema)

{
  "status": 409,
  "code": "conflict",
  "message": "string",
  "type": "error"
}

429

Too many requests

application/json

Schema

Schema

status number

Default value: 429

HTTP status code.

code string

Description of the status code.

message string

Explanation of the error.

type string

Default value: error

Example (from schema)

{
  "status": 429,
  "code": "tooManyRequests",
  "message": "string",
  "type": "error"
}

Loading...