Lists

Create a list

Create a named list of companies. purpose records what the list is for, monitor turns change alerts on for its companies, and alert_email, alert_webhook and webhook_url choose how alerts reach you. 409 when you already have a list with that name.

post/lists

Request

  • Base URL: https://api.companystack.co.uk
  • URL: https://api.companystack.co.uk/lists
  • Auth: one of:
    • HTTP bearer
    • API key in header X-Api-Key

Request body

namestring required
purpose'clients' | 'suppliers' | 'portfolio' | 'prospects' | 'other'
descriptionstring
monitorboolean

Watch every company for changes

alert_emailboolean

Daily email digest (defaults to on where your plan includes email alerts)

alert_webhookboolean
webhook_urlstring

Public https:// URL for signed company.alert webhooks

shared_with_teamboolean

Team plans: visible to the whole team

Response

Created

Changes

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