Ajouter ou supprimer des entreprises dans votre liste

Utilisez cet endpoint pour gérer les entreprises dans vos listes en les ajoutant (attaching) ou en les supprimant (detaching) en utilisant leurs domaines ou IDs.

Vous pouvez modifier jusqu'à 1,000 entreprises par requête API.

Inscrivez-vous pour accéder à toutes les fonctionnalités de notre API

Recevez vos 500 crédits gratuits et commencez à enrichir et rechercher des entreprises.

Aucune carte de crédit requise

Paramètres

actionstring (optionnel)

L'action à effectuer sur les entreprises: 'attach' pour les ajouter à la liste, ou 'detach' pour les supprimer de la liste.

Valeurs possibles

attach

detach

domainsarray (optionnel)

Un tableau de domaines d'entreprises (e.g. ['microsoft.com', 'apple.com']) à ajouter ou à supprimer de la liste. Maximum 1,000 domaines.

companyIdsarray (optionnel)

Un tableau de IDs de sociétés pour ajouter ou supprimer de la liste (chaque ID pour une société est disponible dans metas.mysqlId). Maximum 1,000 IDs de société.

Schéma de réponse

list. analyticsobject

L'analytics de la liste.

list. createdAtdate

Quand la liste a été créée.

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

list. dynamicboolean

Si la liste est dynamique ou statique.

true

list. idnumber

L'identifiant de la liste.

3838

list. importedboolean

Si la liste a été importée.

true

list. integrationsarray

Les intégrations associées à la liste.

list. namestring

Le nom de la liste

SaaS with 100k+ MRR

list. processActiveboolean

Le statut de processus actif de la liste (pour usage interne).

true

list. processInitializedboolean

L'indicateur d'initialisation du processus (à usage interne).

true

list. processingAtdate

Lorsque la liste est en cours de traitement.

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

list. queryarray

La requête utilisée pour générer la liste.

Réponse de l'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 :[ ],}

Exemples de code

Sélectionnez votre langage favori :

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