Skip to main content

Update a project

PATCH 
/api/projects/{id}

Required permissions:

  • pipeline.edit: to update a project where the user is PM or Account
  • pipeline.edit_other: to update a project where the user is not PM nor Account
  • pipeline.job_order: to update a project job order

Here the dedicated support page.

Project metadata​

You can set project metadata values using the dynamic field like metadata_13 where 13 is the ID of the project metadata you want to set.

You can get all the available project metadata using the related endpoint.

Only project metadata with a value will appear in the response.

Timesheet whitelist​

You can enable or disable the timesheet whitelist for the project using is_timesheet_whitelist_enabled. People can then be added to or removed from the whitelist using the timesheet whitelist endpoints.

info

As of today, this endpoint does not support the following functionalities:

  • Setting project risk
  • Setting won/lost feedback

Are you interested in any of these? Let us know!

Request​

Path Parameters

    id integerrequired

    The ID of the project to update

Header Parameters

    Wethod-Company stringrequired

    The company you want to interact with

    Wethod-Version stringrequired

    The API version you want to use

Body

    name string

    Possible values: <= 500 characters

    Project name

    client_id integer

    ID of the client of this project

    client_contact_id integer

    ID of the client contact for this project

    purchase_order string

    Project purchase order

    pm_id integer

    ID of the person designed to manage this project

    account_id integer

    ID of the person designed as account for this project

    job_order_category_id integer

    ID of the job order category to associate to this project

    project_type_id integer

    ID of the project type to associate to this project

    job_order string

    Possible values: <= 150 characters

    Project job order

    value float

    The value of the project in K

    probability integer

    Possible values: <= 100

    Duration of the project in months

    external_cost_percentage integer

    Estimate of the external costs as percentage of the project value

    start_date date

    Project start month. This follows the YYYY-MM-DD format

    duration integer

    Possible values: >= 1

    The probability of the project

    due_date date

    The date the project is supposed to end

    signed_on date

    The date the project has been signed

    project_stage_id integer

    ID of the opportunity stage

    business_unit_id integer

    ID of the business unit to which this project belongs

    is_timesheet_whitelist_enabled boolean

    Whether the timesheet whitelist is enabled for this project. When enabled, only whitelisted people can log time on the project. It cannot be disabled while the whitelist still has people in it.

Responses​

Returns the updated project.

Schema

    id integerrequired

    Possible values: >= 1

    The unique identifier of the resource

    created_at date-timerequired

    The date and time when the resource was created

    updated_at date-timerequired

    The date and time when the resource was last updated

    name stringrequired
    job_order string
    purchase_order string
    value floatrequired

    The value of the project in K

    probability integerrequired

    Possible values: <= 100

    The probability of the project

    external_cost_percentage integerrequired

    The amount of external costs in percentage of the project value

    date_start daterequired

    The first day of month where the project started

    duration integerrequired

    Possible values: >= 1

    Duration of the project in months

    is_archived booleanrequired
    archived_on date

    The date the project was archived

    due_date date

    The date the project is supposed to end

    signed_on date

    The date the project has been signed

    is_timesheet_whitelist_enabled booleanrequired

    Whether timesheet whitelist is enabled for the project

    job_order_category_id integerrequired

    Possible values: >= 1

    ID of the job order category

    project_type_id integer

    Possible values: >= 1

    ID of the project type

    client_id integerrequired

    Possible values: >= 1

    ID of the client

    pm_id integerrequired

    Possible values: >= 1

    ID of the person who is the project manager

    account_id integer

    Possible values: >= 1

    ID of the person who is the account

    client_contact_id integer

    Possible values: >= 1

    ID of the client contact

    reason_why_id integer

    Possible values: >= 1

    ID of the reason why the project is won or lost

    business_unit_id integer

    Possible values: >= 1

    ID of the business unit

    billing_group_id integer

    Possible values: >= 1

    ID of the billing group the project is in

    project_stage_id integer

    Possible values: >= 1

    ID of the opportunity stage

    job_order_category

    object

    id integerrequired

    Possible values: >= 1

    The unique identifier of the resource

    created_at date-timerequired

    The date and time when the resource was created

    updated_at date-timerequired

    The date and time when the resource was last updated

    name stringrequired

    Possible values: <= 50 characters

    The job order category name

    color stringrequired

    Possible values: <= 50 characters

    The job order category RGB color

    is_chargeable booleanrequired

    Whether the job order category is chargeable

    is_allocation_request_required booleanrequired

    Whether plannings on projects with this job order category must be approved

    is_planning_allowed_to_everybody booleanrequired

    Whether everybody can plan projects with this job order category, regardless of their permissions

    is_planning_unlimited booleanrequired

    Whether projects with this job order category have unlimited planning

    hours_type string

    The type of hours worked on projects with this job order category

    is_program_required booleanrequired

    Whether projects with this job order category must be in a program

    is_budget_invoice_driven booleanrequired

    Whether projects with this job order category use invoice-driven budget

    is_capex booleanrequired

    Whether projects with this job order category are capex

    external_costs_type stringrequired

    Possible values: [on-goods-sold, before-contribution-margin, on-g-and-a, on-marketing]

    The type of external costs for projects with this job order category

    is_won_lost_feedback_required booleanrequired

    Whether projects with this job order category track won/lost feedback

    is_opportunity_status_tracking_enabled booleanrequired

    Whether projects with this job order category track opportunity status

    is_timesheet_automatic booleanrequired

    Whether projects with this job order category use automatic timesheets

    is_external_drive_canvas_enabled booleanrequired

    Whether projects with this job order category use external drive canvas

    project_status_mode stringrequired

    Possible values: [remaining-days, percentage, time-based, timesheet-based]

    The project status mode for projects with this job order category

    is_project_review_required booleanrequired

    Whether projects with this job order category require a review after being archived

    project_review_value_threshold integer

    The minimum project value in K to require a review after being archived

    job_order_category_group_id integerrequired

    The ID of the job order category group

    job_order_template_id integer

    The ID of the job order template

    deleted_at date-time

    The date and time when the resource was deleted

    deleted_at date-time

    The date and time when the resource was deleted

Loading...