openproject/docs/api/apiv3/paths/project_form.yml

# /api/v3/projects/{id}/form
---
post:
  parameters:
  - description: Project id
    example: '1'
    in: path
    name: id
    required: true
    schema:
      type: integer
  requestBody:
    content:
      application/json:
        schema:
          type: object
        examples:
          "with custom fields":
            "$ref": "../components/examples/project_body.yml"
          "empty":
            description: Empty request to get the form initially in order to start the guided update of a project
            value: {}
  responses:
    '200':
      description: OK
      headers: {}
    '400':
      content:
        application/hal+json:
          schema:
            $ref: "../components/schemas/error_response.yml"
          examples:
            response:
              value:
                _type: Error
                errorIdentifier: urn:openproject-org:api:v3:errors:InvalidRequestBody
                message: The request body was not a single JSON object.
      description: Occurs when the client did not send a valid JSON object in the
        request body.
      headers: {}
    '403':
      content:
        application/hal+json:
          schema:
            $ref: "../components/schemas/error_response.yml"
          examples:
            response:
              value:
                _type: Error
                errorIdentifier: urn:openproject-org:api:v3:errors:MissingPermission
                message: You are not authorized to access this resource.
      description: |-
        Returned if the client does not have sufficient permissions.

        **Required permission:** edit projects in the project        
      headers: {}
  tags:
  - Projects
  description: ''
  operationId: Project_update_form
  summary: Project update form