Projects API: Update contributor

Endpoint#

Property	Value
Type	mutation
Method	POST
Path	/api/external/v1/projects/update_contributor
Handler	OperatelyWeb.Api.Projects.UpdateContributor

Authentication#

• Requires a valid API token.
• Requires a write-enabled token.
• Read-only tokens return 403.

Inputs#

Field	Type	Required	Nullable	Default
contrib_id	id primitive (encoded as string)	Yes	No	-
person_id	id primitive (encoded as string)	No	Yes	-
responsibility	string	No	Yes	-
permissions	access_options enum (no_access, minimal_access, view_access, comment_access, edit_access, admin_access, full_access)	No	Yes	-
role	project_contributor_role enum (champion, reviewer, contributor)	No	Yes	-

Outputs#

Field	Type	Required	Nullable
contributor	project_contributor object	Yes	No

cURL Example#

Copied

curl --request POST \
  --url "https://app.operately.com/api/external/v1/projects/update_contributor" \
  --header "Authorization: Bearer ${OPERATELY_API_TOKEN}" \
  --header "Content-Type: application/json" \
  --data '{"contrib_id":"value", "permissions":"no_access", "person_id":"value", "responsibility":"value", "role":"champion"}'

Response Example#

{
  "contributor": {
    "__typename": "value",
    "access_level": "<access_options_int>",
    "id": "value",
    "permissions": "<project_permissions>",
    "person": "<person>",
    "project": "<project>",
    "responsibility": "value",
    "role": "champion"
  }
}