Color theme

Overview

Your workspace's leads, from your own code.

The Swite API lets your own systems work with your Swite workspace over HTTPS. A form on your site, a CRM or a spreadsheet script can create the leads your agents then answer on WhatsApp, look them up, keep them current and remove them.

Every request carries a workspace API key and acts in that workspace, as the member who created the key. Requests and responses are JSON.

https://api.swite.co/v1

Leads, checked on WhatsApp

A lead is someone your workspace talks to who is not yet a customer. Creating one checks its phone number on the workspace's WhatsApp channel first, so a lead the API creates is one your agents can reach, and a number another lead or contact already has is refused instead of duplicated.

Answers you can act on

Every failure has an HTTP status that says what kind it is and a code that says exactly which one. When the problem is something you can fix, such as a number another lead holds, the response says what to do about it. See Errors.

A contract that holds

The API's contract is published as an OpenAPI document. Within v1 it only grows: new endpoints and new optional fields, never a renamed field or error code. Code written against v1 today keeps working.