Skip to main content

Create a project

POST 
/api/projects

Required permissions:

  • pipeline.create: to create a project the user is PM or Account
  • pipeline.create_other: to create a project where the user is not PM nor Account

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.

info

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

  • Archiving or unarchiving a project
  • Manage timesheet whitelist for a project
  • Setting opportunity stage
  • Setting project risk
  • Setting won/lost feedback

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

Request​

Header Parameters

    Wethod-Company stringrequired

    The company you want to interact with

    Wethod-Version stringrequired

    The API version you want to use

Body

    name stringrequired

    Possible values: <= 500 characters

    Project name

    client_id integerrequired

    ID of the client of this project

    client_contact_id integer

    ID of the client contact for this project. This may be required if it has been configured as such in the company settings.

    purchase_order string

    Project purchase order

    pm_id integerrequired

    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 integerrequired

    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 floatrequired

    The value of the project in K

    probability integerrequired

    Possible values: <= 100

    The likelihood of this project actually starting, in percentage

    external_cost_percentage integerrequired

    Estimate of the external costs as percentage of the project value

    start_date daterequired

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

    duration integerrequired

    Possible values: >= 1

    The duration of the project in months

    due_date date

    The date the project is supposed to end

    signed_on date

    The date the project has been signed

    business_unit_id integer

    ID of the business unit to which this project belongs

Responses​

Returns the project created.

Schema

    id integerrequired

    Possible values: >= 1

    created_at date-timerequired
    updated_at date-timerequired
    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

    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

    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

Loading...