Create company

Create a new company. Authentication required.

POST /companies

Create company

cURL

curl --request POST \
  --url https://productlane.com/api/v2/companies \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "logo_url": "<string>",
  "domains": [
    "<string>"
  ],
  "size": 1,
  "revenue": 1,
  "external_ids": [
    "<string>"
  ],
  "status_id": "<string>",
  "tier_id": "<string>",
  "owner_id": "<string>"
}
'

import requests

url = "https://productlane.com/api/v2/companies"

payload = {
    "name": "<string>",
    "logo_url": "<string>",
    "domains": ["<string>"],
    "size": 1,
    "revenue": 1,
    "external_ids": ["<string>"],
    "status_id": "<string>",
    "tier_id": "<string>",
    "owner_id": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    logo_url: '<string>',
    domains: ['<string>'],
    size: 1,
    revenue: 1,
    external_ids: ['<string>'],
    status_id: '<string>',
    tier_id: '<string>',
    owner_id: '<string>'
  })
};

fetch('https://productlane.com/api/v2/companies', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://productlane.com/api/v2/companies",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'logo_url' => '<string>',
    'domains' => [
        '<string>'
    ],
    'size' => 1,
    'revenue' => 1,
    'external_ids' => [
        '<string>'
    ],
    'status_id' => '<string>',
    'tier_id' => '<string>',
    'owner_id' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://productlane.com/api/v2/companies"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"logo_url\": \"<string>\",\n  \"domains\": [\n    \"<string>\"\n  ],\n  \"size\": 1,\n  \"revenue\": 1,\n  \"external_ids\": [\n    \"<string>\"\n  ],\n  \"status_id\": \"<string>\",\n  \"tier_id\": \"<string>\",\n  \"owner_id\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://productlane.com/api/v2/companies")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"logo_url\": \"<string>\",\n  \"domains\": [\n    \"<string>\"\n  ],\n  \"size\": 1,\n  \"revenue\": 1,\n  \"external_ids\": [\n    \"<string>\"\n  ],\n  \"status_id\": \"<string>\",\n  \"tier_id\": \"<string>\",\n  \"owner_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://productlane.com/api/v2/companies")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"logo_url\": \"<string>\",\n  \"domains\": [\n    \"<string>\"\n  ],\n  \"size\": 1,\n  \"revenue\": 1,\n  \"external_ids\": [\n    \"<string>\"\n  ],\n  \"status_id\": \"<string>\",\n  \"tier_id\": \"<string>\",\n  \"owner_id\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "id": "<string>",
  "name": "<string>",
  "logo_url": "<string>",
  "domains": [
    "<string>"
  ],
  "size": 123,
  "revenue": 123,
  "status_id": "<string>",
  "status_name": "<string>",
  "tier_id": "<string>",
  "tier_name": "<string>",
  "owner": {
    "id": "<string>",
    "name": "<string>",
    "avatar_url": "<string>"
  },
  "external_ids": [
    "<string>"
  ],
  "created_at": "<string>",
  "updated_at": "<string>"
}

{
  "message": "<string>",
  "code": "<string>",
  "issues": [
    {
      "message": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

name · string · required

Required string length: 1 - 255

logo_url · string<uri> | null

domains · string[]

Required string length: 1 - 63

Pattern: [0-9a-z-]+\.(?:(?:co|or|gv|ac|com)\.)?[a-z]{2,7}$

size · integer

Required range: x >= 0

revenue · integer

Required range: x >= 0

external_ids · string[]

Replaces the company's full external-id set. Use for cross-system identifiers (CRM ids, etc.).

status_id · string | null

Linear customer-status id. Fetch valid ids from GET /companies/linear-options. Pass null to clear.

tier_id · string | null

Linear customer-tier id. Fetch valid ids from GET /companies/linear-options. Pass null to clear.

owner_id · string | null

Linear user id of the owner. Fetch valid ids from GET /companies/linear-options. Pass null to clear.

Response

200

application/json

Successful response

id · string · required

name · string · required

logo_url · string | null · required

domains · string[] · required

size · number | null · required

revenue · number | null · required

status_id · string | null · required

status_name · string | null · required

tier_id · string | null · required

tier_name · string | null · required

owner · object | null · required

Show child attributes

external_ids · string[] · required

Caller-owned cross-system identifiers (CRM ids, etc.). Replaced wholesale on create/update.

created_at · string · required

updated_at · string · required