Sign in

v1

latestOpenAPI 3.0.12026-07-2464217456.8 KB
Projects

Assign placeholders to an user in a project

post/1.0/projects/{projectId}/assign-placeholders

Path parameters

projectIdinteger required

The project's unique, system-generated identifier, which can be used to identify the project globally.

Request body

placeholderIdinteger required

The unique identifier for the placeholder.

Example request

[
  {
    "placeholderId": 201,
    "user": {
      "emailId": "john.doe@rocketlane.com",
      "userId": 201
    }
  }
]

Response

The requested action was successfully executed.

projectIdinteger

The project's unique, system-generated identifier, which can be used to identify the project globally.

projectNamestring

The name of the project.

startDatestring

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.

dueDatestring

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.

createdAtinteger

The time when the project was created. The referenced time will be in epoch millis.

updatedAtinteger

The time when the project was updated. Any changes that's related to the project are captured and specified here in epoch millis.

archivedboolean

The field archived denotes whether the project is archived or not. If the project is archived, there's an option to un-archive the project.

visibility'EVERYONE' | 'MEMBERS' | 'GROUP'

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 MEMBER restricts access to only those team members who have been specifically invited.

currency'AFN' | 'ALL' | 'DZD' | 'ARS' | 'AMD' | 'AUD' | 'AZN' | 'BHD' | 'BDT' | 'BYN' | 'BZD' | 'BOB' | 'BAM' | 'BWP' | 'BRL' | 'GBP' | 'BND' | 'BGN' | 'BIF' | 'KHR' | 'CAD' | 'CVE' | 'XAF' | 'CLP' | 'CNY' | 'COP' | 'KMF' | 'CDF' | 'CRC' | 'HRK' | 'CZK' | 'DKK' | 'DJF' | 'DOP' | 'EGP' | 'ERN' | 'EEK' | 'ETB' | 'EUR' | 'GEL' | 'GHS' | 'GTQ' | 'GNF' | 'HNL' | 'HKD' | 'HUF' | 'ISK' | 'INR' | 'IDR' | 'IRR' | 'IQD' | 'ILS' | 'JMD' | 'JPY' | 'JOD' | 'KZT' | 'KES' | 'KWD' | 'LVL' | 'LBP' | 'LYD' | 'LTL' | 'MOP' | 'MKD' | 'MGA' | 'MYR' | 'MUR' | 'MXN' | 'MDL' | 'MAD' | 'MZN' | 'MMK' | 'NAD' | 'NPR' | 'TWD' | 'NZD' | 'NIO' | 'NGN' | 'NOK' | 'OMR' | 'PKR' | 'PAB' | 'PYG' | 'PEN' | 'PHP' | 'PLN' | 'QAR' | 'RON' | 'RUB' | 'RWF' | 'SAR' | 'RSD' | 'SGD' | 'SOS' | 'ZAR' | 'KRW' | 'LKR' | 'SDG' | 'SEK' | 'CHF' | 'SYP' | 'TZS' | 'THB' | 'TOP' | 'TTD' | 'TND' | 'TRY' | 'USD' | 'UGX' | 'UAH' | 'AED' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'XOF' | 'YER' | 'ZMK' | 'ZWL'

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.

Example response

{
  "projectId": 201,
  "projectName": "Acme onboarding",
  "startDate": "2023-03-28",
  "dueDate": "2023-03-28",
  "createdAt": 1681319726000,
  "updatedAt": 1681319726000,
  "owner": {
    "emailId": "john.doe@rocketlane.com",
    "userId": 201,
    "firstName": "John",
    "lastName": "Doe"
  },
  "teamMembers": {
    "members": [
      {
        "emailId": "john.doe@rocketlane.com",
        "userId": 201,
        "firstName": "John",
        "lastName": "Doe"
      }
    ],
    "customers": [
      {
        "emailId": "rachel.green@acme.com",
        "userId": 301,
        "firstName": "Rachel",
        "lastName": "Green"
      }
    ],
    "customerChampion": {
      "emailId": "ruth.bell@acme.com",
      "userId": 302,
      "firstName": "Ruth",
      "lastName": "Bell"
    }
  },
  "status": {
    "value": 2,
    "label": "In progress"
  },
  "fields": [
    {
      "fieldId": 201,
      "fieldLabel": "MRR",
      "fieldValue": "1000",
      "fieldValueLabel": "1000"
    }
  ],
  "customer": {
    "companyId": 201,
    "companyName": "Acme Inc",
    "companyUrl": "https://www.acme.com"
  },
  "partnerCompanies": [
    {
      "companyId": 301,
      "companyName": "Modert Inc",
      "companyUrl": "https://www.modert.com"
    }
  ],
  "visibility": "EVERYONE",
  "createdBy": {
    "emailId": "john.doe@rocketlane.com",
    "userId": 201,
    "firstName": "John",
    "lastName": "Doe"
  },
  "updatedBy": {
    "emailId": "john.doe@rocketlane.com",
    "userId": 201,
    "firstName": "John",
    "lastName": "Doe"
  },
  "currency": "USD",
  "financials": {
    "fixedFeeContract": {
      "fixedFee": 100
    },
    "timeAndMaterialContract": {
      "rateCard": {
        "rateCardId": 21,
        "rateCardName": "US Project rate"
      },
      "projectBudget": 100
    },
    "subscriptionContract": {
      "subscriptionFrequency": "MONTHLY",
      "subscriptionStartDate": "2023-03-28",
      "periodMinutes": 60,
      "periodBudget": 10000,
      "noOfPeriods": 10
    },
    "metrics": {
      "actualRevenue": 10000,
      "estimatedRevenue": 200000,
      "actualCost": 200,
      "estimatedCost": 200,
      "actualProfit": 200,
      "estimatedProfit": 200,
      "actualProfitMargin": 200,
      "estimatedProfitMargin": 200,
      "estimateAtCompletion": 200,
      "estimationToCompletionInHours": 200
    }
  },
  "placeholders": [
    {
      "placeholder": {
        "placeholderId": 201,
        "placeholderName": "Customer Success"
      },
      "placeholderStatus": "ASSIGNED",
      "user": {
        "emailId": "john.doe@rocketlane.com",
        "userId": 201,
        "firstName": "John",
        "lastName": "Doe",
        "role": "Project Manager"
      },
      "hourlyCostRate": 100,
      "costRateCurrency": "USD",
      "hourlyBillRate": 200,
      "billRateCurrency": "USD"
    }
  ]
}