lists

PATCH /v2/lists/{listId}/companies/toggle

Toggle one or more companies in a list.

Request

Base URL
https://api.thecompaniesapi.com
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/thecompaniesapi/apis/the-companies-api/docs/v2/lists/:listId/companies/toggle/patch.ts
A function with typed inputs. Its response is checked against the schema.

listIdnumber required

action'attach' | 'detach' required

companyIdsnumber[]

domainsstring[]

refreshboolean

Toggle one or more companies in a list.

companyListIdnumber nullable

createdAtstring nullable required

dynamicboolean nullable required

exportingboolean required

exportingAtstring nullable required

idnumber required

importedboolean required

mailFrequenciesobject nullable

maxCompaniesnumber nullable required

namestring required

processActiveboolean required

processDisabledboolean nullable

processingAtstring nullable required

processInitializedboolean required

processMessagestring nullable required

querySimilarstring[] required

teamIdstring nullable

userIdnumber nullable

No recorded changes to this operation across all 1 revision of this API.