Quickstart

From a blank account to your first registered contact, in 3 calls.

Create the account

POST/v1/auth/register

{
  "tenantName": "My Company",
  "name": "Your Name",
  "email": "you@company.com",
  "password": "..."
}

Keep the accessToken from the response — or create an API Key as soon as you have a tenant, if you'd rather integrate from a backend instead of a user session.

Register your first contact

POST/v1/contacts

curl -X POST https://api.allyone.com.br/v1/contacts \
  -H "Authorization: Bearer eyJhbGci..." \
  -H "Content-Type: application/json" \
  -d '{
    "firstName": "Maria",
    "phone": "+5511999998888",
    "optInWhatsapp": true
  }'

email or phone — at least one of the two is required.

Connect a channel and talk to that contact

Integrations send messages through one of the three automation engines or a campaign, always tied to a connected channel. (Replying inside an open conversation, as an agent does in the inbox, uses POST /v1/chat/conversations/:id/messages with a user session.) The shortest path to a real message:

Connect a WhatsApp number via Embedded Signup.
Create a simple Chat Flow, or trigger a manual campaign to the contact you just created.

Done

You have an account, a contact, and you know where to connect the first channel. The natural next step: Connect WhatsApp.

OpenAPI and Postman

The CRM integration surface (authentication, API keys, contacts, lists, segments, campaigns, forms, sales, conversations, WhatsApp and webhooks) is described in OpenAPI 3.1 and a Postman collection. Import it into Postman, Insomnia or the SDK generator of your choice.

OpenAPI specification — crm-openapi.json
Postman collection — crm.postman_collection.json

Routes outside the specification are internal and may change without notice. An automated test compares the specification with the code on every change, so it does not fall behind.