Agregar o eliminar empresas en su lista

Use este endpoint para gestionar empresas en sus listas añadiendo (attaching) o eliminando (detaching) usando sus dominios o IDs.

Puede modificar hasta 1,000 empresas por solicitud API.

Regístrate para acceder a todas las características de nuestra API

Obtén tus 500 créditos gratuitos y comienza a enriquecer y buscar empresas.

No se requiere tarjeta de crédito

Parámetros

actionstring (opcional)

La acción a realizar sobre las empresas: 'attach' para agregarlas a la lista, o 'detach' para eliminarlas de la lista.

Valores posibles

attach

detach

domainsarray (opcional)

Un array de dominios de empresas (e.g. ['microsoft.com', 'apple.com']) para agregar o eliminar de la lista. Máximo 1,000 dominios.

companyIdsarray (opcional)

Un array de IDs de empresas para agregar o eliminar de la lista (cada ID para una empresa está disponible en metas.mysqlId). Máximo 1,000 IDs de empresa.

Esquema de respuesta

list. analyticsobject

The analytics of the list.

list. createdAtdate

When the list was created.

2022-02-22T07:23:52.000+00:00

list. dynamicboolean

If the list is dynamic or static.

true

list. idnumber

The id of the list.

3838

list. importedboolean

If the list has been imported.

true

list. integrationsarray

The integrations associated with the list.

list. namestring

The name of the list

SaaS with 100k+ MRR

list. processActiveboolean

The process active status of the list (for internal use).

true

list. processInitializedboolean

The process initialized flag (for internal use).

true

list. processingAtdate

When the list is being processed.

2022-02-22T07:23:52.000+00:00

list. queryarray

The query used to generate the list.

Respuesta de la API

{analytics :{companiesCount :30992,},createdAt : "2022-04-01T13:07:14.000+00:00" ,dynamic :false,id :4246,imported :false,integrations :[ ],name : "SaaS with 100k+ MRR" ,processActive :false,processInitialized :true,processingAt : "2022-04-01T13:07:15.000+00:00" ,query :[ ],}

Ejemplos de código

Selecciona tu lenguaje favorito:

JavaScript

PHP

Python

import createClient from '@thecompaniesapi/sdk'

const tca = createClient({ apiToken: 'YOUR_API_TOKEN' })

const response = await tca.listsToggleCompanies({
  listId: 1234,
  domains: ['apple.com', 'stripe.com']
})

const list = response.data // The updated list