Update Companies Table

PATCH

companies

tables

{table_id}

curl --request PATCH \
  --url https://api.lusha.com/v3/companies/tables/{table_id} \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "name": "postman-renamed",
  "visibility": "shared",
  "owner": {
    "email": "user@example.com"
  }
}
'

import requests

url = "https://api.lusha.com/v3/companies/tables/{table_id}"

payload = {
    "name": "postman-renamed",
    "visibility": "shared",
    "owner": { "email": "user@example.com" }
}
headers = {
    "api_key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {api_key: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'postman-renamed',
    visibility: 'shared',
    owner: {email: 'user@example.com'}
  })
};

fetch('https://api.lusha.com/v3/companies/tables/{table_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

HttpResponse<String> response = Unirest.patch("https://api.lusha.com/v3/companies/tables/{table_id}")
  .header("api_key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"postman-renamed\",\n  \"visibility\": \"shared\",\n  \"owner\": {\n    \"email\": \"user@example.com\"\n  }\n}")
  .asString();

package main

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

func main() {

	url := "https://api.lusha.com/v3/companies/tables/{table_id}"

	payload := strings.NewReader("{\n  \"name\": \"postman-renamed\",\n  \"visibility\": \"shared\",\n  \"owner\": {\n    \"email\": \"user@example.com\"\n  }\n}")

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

	req.Header.Add("api_key", "<api-key>")
	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))

}

{
  "data": {
    "tableId": "482910",
    "name": "VP Sales US Tech Q2",
    "entityType": "contacts",
    "visibility": "private",
    "status": "active",
    "owner": {
      "id": 12345,
      "email": "owner@lusha.com",
      "name": "Ada Lovelace"
    },
    "createdBy": {
      "surface": "api",
      "createdByUserId": 12345
    },
    "workspaceUrl": "https://workspace.lusha.com/tables/482910",
    "entityCount": 5,
    "isProcessing": false,
    "columns": [
      {
        "columnId": "c1",
        "name": "Job title",
        "type": "lusha",
        "key": "jobTitle",
        "isDefault": false,
        "addedAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "rowsNotRun": 123,
        "rowsProcessing": 123,
        "rowsSuccess": 123,
        "rowsNoData": 123,
        "rowsFailed": 123
      }
    ]
  },
  "billing": {
    "creditsCharged": 3,
    "resultsReturned": 1,
    "lowBalance": false
  }
}

Authorizations

api_key

string

header

required

Your Lusha API key. You can find this in your Lusha dashboard under API settings. Include this key in the api_key header for all requests.

Path Parameters

table_id

string

required

The table's ID.

Body

application/json

name, visibility, and archived are all optional - send any subset; omitted fields stay unchanged. Sending none of them is a no-op. A partial update re-reads the persisted table first, so fields you don't send are never clobbered.

owner

object

required

Identifies the user acting on the table, and resolves to a user on your account. Required on every table-route call when authenticating with an API key (there is no signed-in user) - omitting it returns 400. Optional for OAuth/token callers, since the caller is already identified by the token; still accepted if you want to act on behalf of another owner.

Show child attributes

name

string

New name, up to 250 characters. Allowed: letters in any language, digits, spaces, and - _ . , ' & ( ) / # + : ! ? @. Other characters - including [ ], emojis, symbols, and invisible characters such as line breaks, tabs, and zero-width spaces - are rejected with 400. Leading and trailing spaces are trimmed, and repeated spaces are collapsed to one.

Required string length: 1 - 250

Example:

"renamed"

visibility

enum<string>

Available options:

private,

shared

Example:

"shared"

archived

boolean

Set true to archive the table (hides it from default List Tables results), false to restore it.

Example:

true

Response

Table updated

data

object

Response payload for Get Table - TableDto fields plus live entity/column counts.

Show child attributes

billing

object

Credit usage summary for a V3 API request

Show child attributes

⌘I

Update Companies Table

curl --request PATCH \
  --url https://api.lusha.com/v3/companies/tables/{table_id} \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "name": "postman-renamed",
  "visibility": "shared",
  "owner": {
    "email": "user@example.com"
  }
}
'

import requests

url = "https://api.lusha.com/v3/companies/tables/{table_id}"

payload = {
    "name": "postman-renamed",
    "visibility": "shared",
    "owner": { "email": "user@example.com" }
}
headers = {
    "api_key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {api_key: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'postman-renamed',
    visibility: 'shared',
    owner: {email: 'user@example.com'}
  })
};

fetch('https://api.lusha.com/v3/companies/tables/{table_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

HttpResponse<String> response = Unirest.patch("https://api.lusha.com/v3/companies/tables/{table_id}")
  .header("api_key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"postman-renamed\",\n  \"visibility\": \"shared\",\n  \"owner\": {\n    \"email\": \"user@example.com\"\n  }\n}")
  .asString();

package main

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

func main() {

	url := "https://api.lusha.com/v3/companies/tables/{table_id}"

	payload := strings.NewReader("{\n  \"name\": \"postman-renamed\",\n  \"visibility\": \"shared\",\n  \"owner\": {\n    \"email\": \"user@example.com\"\n  }\n}")

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

	req.Header.Add("api_key", "<api-key>")
	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))

}

{
  "data": {
    "tableId": "482910",
    "name": "VP Sales US Tech Q2",
    "entityType": "contacts",
    "visibility": "private",
    "status": "active",
    "owner": {
      "id": 12345,
      "email": "owner@lusha.com",
      "name": "Ada Lovelace"
    },
    "createdBy": {
      "surface": "api",
      "createdByUserId": 12345
    },
    "workspaceUrl": "https://workspace.lusha.com/tables/482910",
    "entityCount": 5,
    "isProcessing": false,
    "columns": [
      {
        "columnId": "c1",
        "name": "Job title",
        "type": "lusha",
        "key": "jobTitle",
        "isDefault": false,
        "addedAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "rowsNotRun": 123,
        "rowsProcessing": 123,
        "rowsSuccess": 123,
        "rowsNoData": 123,
        "rowsFailed": 123
      }
    ]
  },
  "billing": {
    "creditsCharged": 3,
    "resultsReturned": 1,
    "lowBalance": false
  }
}

Overview

Resources

Endpoints

Authorizations

Path Parameters

Body

Response