Lists

Update a list

Rename, change purpose, turn monitoring or alert channels on or off, share with your team, archive (archived: true) or restore (archived: false).

patch/lists/{id}

Request

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

Path parameters

idinteger required

Request body

namestring
purpose'clients' | 'suppliers' | 'portfolio' | 'prospects' | 'other'
descriptionstring nullable
monitorboolean
alert_emailboolean
alert_webhookboolean
webhook_urlstring nullable
shared_with_teamboolean
archivedboolean

true archives the list, false restores it

Response

Updated

Changes

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