Update company by Id

put

https://api.rocketlane.com/api/1.0/companies/{companyId}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

companyId

int64

required

≥ 0

Defaults to 1

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

Query Params

includeFields

array of strings

Use this query parameter to opt in for companies to be returned in the response body. Use comma separated values to fetch the respective fields. If left blank, default properties are returned.

includeFields

Allowed:

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

companyName

string

The name of the company

companyUrl

string

The URL of the client's website. Unless explicitly stated, the value for this field can be left blank

visibility

string

enum

Set visibility parameters to restrict who can see your company. On create/update there are two options: EVERYONE and MEMBERS (same as projects). Selecting EVERYONE allows all team members from your firm to view the company, while selecting MEMBERS restricts access to only those team members who have been specifically invited.

Allowed:

description

string

A detailed description or notes about the company.

accountOwner

object

Optional. Updates the account owner. Provide either userId or emailId of an existing user.

fields

array of objects

Custom fields to update on the company. Provide fieldId and fieldValue for each field.

fields

notes

array of objects

Existing notes to update on this company. Each entry requires noteId. To create a new note, use POST /1.0/companies/{companyId}/add-notes.

notes

Responses

200The requested action was successfully executed.

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.

404If we were unable to locate the resource you were looking for or the proper API endpoint you were looking for, this error would show up.

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.