AllyOneCRM / Contacts & Companies
Contacts & Companies
The CRM's core data model. Every automation, campaign and conversation revolves around a Contact.
Contact
email or phone is required — the other fields are optional.
{
"email": "maria@company.com",
"phone": "+5511999998888",
"mobile": "+5511999998888",
"firstName": "Maria",
"lastName": "Silva",
"companyId": "cmp_...",
"cpf": "000.000.000-00",
"attributes": { "plan": "premium" },
"tags": ["hot-lead"],
"optInEmail": true,
"optInWhatsapp": true,
"optInPush": false,
"optInSms": false,
"optInRcs": false
}
Company
A company is a separate entity — the relationship is 1:N: a contact belongs to at most one company (Contact.companyId), a company can have many contacts.
Endpoints
| Action | Endpoint |
|---|---|
| Create contact | POST /v1/contacts |
| List contacts | GET /v1/contacts |
| Quick search | GET /v1/contacts/search?q= |
| Update contact | PATCH /v1/contacts/:id |
| Bulk import | POST /v1/contacts/import |
Listing is offset-paginated:
{ "data": [...], "total": 4213, "page": 1, "pageSize": 50, "totalPages": 85 }
Bulk import
POST /v1/contacts/import accepts CSV via multipart/form-data (up to 256MB), with column mapping — the file is processed asynchronously in a queue and doesn't block the response.
