Skip to content

Project Templates API: Create person

Endpoint#

PropertyValue
Typemutation
MethodPOST
Path/api/external/v1/project_templates/create_person
HandlerOperatelyWeb.Api.ProjectTemplates.CreatePerson

Authentication#

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

Inputs#

FieldTypeRequiredNullableDefault
template_idid primitive (encoded as string)YesNo-
person_idid primitive (encoded as string)YesNo-
roleproject_template_person_role enum (champion, reviewer, contributor)YesNo-
responsibilitystringNoYes-
access_levelaccess_options_int enum (0, 10, 40, 70, 100)YesNo-

Outputs#

FieldTypeRequiredNullable
personproject_template_person objectYesNo

cURL Example#

Copied
curl --request POST \
  --url "https://app.operately.com/api/external/v1/project_templates/create_person" \
  --header "Authorization: Bearer ${OPERATELY_API_TOKEN}" \
  --header "Content-Type: application/json" \
  --data '{"access_level":"<access_options_int>", "person_id":"value", "responsibility":"value", "role":"champion", "template_id":"value"}'

Response Example#

{
  "person": {
    "__typename": "value",
    "access_level": "<access_options_int>",
    "active": true,
    "id": "value",
    "person": "<person>",
    "responsibility": "value",
    "role": "champion"
  }
}