Create a project

post

https://api.rocketlane.com/api/1.0/projects

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

includeFields

array of strings

This query parameter allows you to specify which fields should be returned in the response body by selecting from the drop down. To get the relevant fields, use comma separated values. If the field is left blank, the default properties are returned.

includeFields

includeAllFields

boolean

This query parameter allows you to specify if all the fields should be returned in the response body. If the field is left blank, the default properties are returned.

Body Params

projectName

string

required

The name of the project. The name specified will be displayed everywhere else and can be used for filtering purposes.

startDate

string

On this date the project's execution officially begins. If sources (templates) are mentioned in the request, the start date is required. For projects without any defined sources, it may be empty. The format for the start date is YYYY-MM-DD.

dueDate

string

The day on which the project's execution is planned to be completed. The due date is not required and can be left blank. If sources (templates) are included as part of the project creation, the project's due date will be calculated depending on the duration of the specified sources. For projects where both startDate and dueDate are specified, the latter must be on or after the given startDate. The format for the due date is YYYY-MM-DD.

visibility

string

enum

Set visibility parameters to restrict who can see your project. There are two options: EVERYONE and MEMBERS. Selecting EVERYONE allows all team members from your firm to view the project, while selecting MEMBERS restricts access to only those team members who have been specifically invited.

Allowed:

owner

object

required

The project owner is mandatory to be specified along with the project creation. The owner gets access to everything in the project and can be used to control the activities that happens in the project. Project owner will receive project invite email based on their notification configuration

teamMembers

object

The teamMembers field can be used to specify the project members, customers and customerChampion. Once the project is created, an invite will be emailed to all the teamMembers specified.

status

object

The value of the project status can be specified here and this is essential to keep track of the project.

fields

array of objects

The custom fields can be set during the project creation with the help of fields. The fieldValue can be either a string or a number or an array and it has to comply with the type of the field. Refer examples to know how to assign fieldValue based on their field_type.

fields

customer

object

required

This field is required to identify the customer as part of the request. The customer's name is case-sensitive, and an exact match is required for further processing. It should be noted that once the customer information is entered, it cannot be modified during the project's lifespan.

partners

array of objects

The partners field is used to specify partner companies.

partners

sources

array of objects

Sources denotes the project templates involved in creation/ imported post creation of the project.

sources

assignProjectOwner

boolean

When a project is created, you can use this param to automatically assign any unassigned tasks to the project owner. Note: If the project hasn't been created using sources, this value will be skipped.

placeholders

array of objects

Rocketlane's placeholders are associated with roles. Based on the kind of roles and expertise that are needed to execute a task, placeholders can be added as assignees to templates as well as projects. Eventually, you can resolve placeholders by replacing them with team members according to their availability and role. Note: If the project is not built using sources, this value will be ignored but the mappings are retained and can be used in the future.

placeholders

annualizedRecurringRevenue

int64

Indicates the value of the recurring revenue of the customer's subscriptions for a single calendar year.

projectFee

int64

The total fee that is charged for the project.

autoAllocation

boolean

The field autoAllocation defines whether Auto Allocation is enabled for the project or not. If auto allocation is enabled, instead of adding it manually, the allocations are computed from the tasks duration, effort and the assignees specified in the project.

autoCreateCompany

boolean

The field auto create company defines whether company should be created as part of the project creation. If the field is set to true, then if the company exists we re-use the company and proceed further. Else we will create a new company.

budgetedHours

double

≥ 0

Budgeted hours represent the total hours allocated for project execution. This value can be edited at any point throughout the project's duration. You can enter the budgeted hours in decimal form, including both hours and minutes, with up to two decimal places of precision. Eg: 1.65 hrs = 1h 39m(1.65h * 60m = 99m).

financials

object

This section addresses the financial aspects of the projects and the associated fields.

currency

string

enum

The currency for handling the project’s financials. You can only specify a currency for a project that is added at the account level. Please note that the project’s currency cannot to changed once set.

externalReferenceId

string

An externalReferenceId is a unique identifier that links entities or transactions between external systems and Rocketlane, ensuring accurate data correlation and consistency.

Responses

201The resource was successfully created in the database.

400This error typically happens when the request payload contains an error. If you want to make sure that the request's parameters are named correctly and are the right data types, you can examine the request's syntax.

401You see this error when trying to access this resource without being authenticated. Check the API request header to make sure it is not empty and has a valid api-key that you acquired from the Rocketlane API Settings tab.

500This error denotes that there is an error that occured within our servers. The response body could help narrow down the cause for the error by our support team.