- Raiz
- Channels
- Contacts
- List contacts
- Create a contact
- Get a contact
- Update a contact
- Block a contact
- Unblock a contact
- Create or update a contact by external ID
- List custom field definitions
- Create a custom field definition
- Update a custom field definition
- Read conversation panel configuration
- Update conversation panel configuration
- Read unanswered conversation mode
- Set unanswered conversation mode
- Read ownerless conversation fallback
- Configure ownerless conversation fallback
- Preview or apply fallback to current ownerless stock
- Flows
- Templates
- Messages
- Operations
- Conversations
- Webhooks
- Store
- Get the store summary
- List store products
- Create a store product
- Create or update store products in batch
- Get a store product
- Update a store product
- Delete a store product
- List store categories
- Create a store category
- Update a store category
- Delete a store category
- List store orders
- Create a store order
- Get a store order
- Transition an order status
- List coupons
- Create coupon
- Replace coupon using current version
- Read agent discount policy
- Replace agent discount policy
- List shipping options
- CRM
- Groups
- Entries
- Automation settings
- Settings
- Knowledge
- AI summaries
- AI agents
- Read AI usage and estimated cost by agent and day
- List live company queries without credentials
- Create a fixed HTTPS company query
- Update a live company query
- Delete query and remove it from company agents
- Test GET without AI; also accepts inactive queries
- Read agent configuration including allowed queries
- Set agent query allowlist; empty list removes permissions
- List reply guard rules
- Create an ensaio reply guard rule
- Patch reply guard rule
- List reply guard hits
- AI duty
- Esquemas
- PaginationMeta
- KnowledgeUrlCreate
- KnowledgeUrlPatch
- Contact
- KnowledgeSource
- KnowledgeSourceResult
- KnowledgeSourceList
- Conversation
- Channel
- Flow
- Template
- Recipient
- Message
- ContactWrite
- Operation
- WebhookEventType
- Error
- WebhookEvent
- WebhookTracking
- MessageReceivedData
- MessageStatusUpdatedData
- MessageRequest
- message.transcribed
- MessageTranscribedData
- message.updated
- MessageUpdatedData
- message.deleted
- MessageDeletedData
- MessageDeliveryError
- ConversationCreatedData
- ConversationUpdatedData
- FlowExecutionUpdatedData
- WebhookTestData
- message.received
- message.status.updated
- conversation.created
- conversation.updated
- flow.execution.updated
- webhook.test
- ConversationDetail
- StoreProductVariant
- StoreOrderItem
- StoreSummary
- StoreProduct
- StoreProductBatchResult
- StoreProductWrite
- order.created
- StoreOrder
- StoreCategory
- StoreOrderPayment
- StoreCategoryWrite
- StoreOrderAgent
- StoreCategoryPatch
- OrderCreatedData
- DiscountRules
- StoreCouponInput
- StoreProductPatch
- StoreCoupon
- AgentDiscountPolicyInput
- OrderStatusUpdatedData
- TemplateSendComponents
- order.status.updated
- StoreShippingOption
- StoreOrderCreate
- ContactTracking
- CrmStage
- CrmStageWrite
- CrmStagePatch
- CrmOpportunity
- CrmOpportunityWrite
- CrmOpportunityPatch
- CrmOpportunityEventData
- crm.opportunity.created
- crm.opportunity.updated
- crm.opportunity.stage_changed
- crm.opportunity.archived
- ConversationWebhookSnapshot
- ConversationAssignedData
- ConversationStatusChangedData
- conversation.assigned
- conversation.status_changed
- ConversationWebhookActor
- ConversationPanel
- FieldOption
- SupportGroup
- FieldOptions
- SupportGroupWaitPatch
- FieldOptionsPatch
- CustomFieldDefinition
- CustomFieldCreate
- CustomFieldPatch
- ConversationFieldSnapshot
- ConversationSelectSnapshot
- ConversationFieldChange
- conversation.fields_changed
- ConversationFieldOptions
- ConversationPanelPatch
- ConversationFieldActor
- EntryKind
- EntrySettings
- ConversationFieldsChangedData
- CrmOpportunityUpsert
- GroupDistributionReport
- CrmOpportunityUpsertItem
- CrmOpportunityUpsertResult
- CrmOpportunityUpsertBatchResult
- FlowEntries
- StaleSessionSettings
- StaleSessionSettingsPatch
- MessageQuoteContext
- TeamReplyRecalculation
- InboxResponseSettings
- OwnerlessFallbackPatch
- OwnerlessFallbackSettings
- OwnerlessFallbackApplication
- AiSummarySettings
- AiSummarySettingsPatch
- AiSummaryUsage
- AiSummaryCostReport
- conversation.status_changed
- AiAgentUsageDay
- AiAgentUsage
- ChannelActor
- ChannelEvent
- ChannelEventPage
- ChannelAccountRejection
- channel.status_changed
- channel.account_status_changed
- FlowMonitoringRule
- EffectiveFlowMonitoringRule
- MessageReactionResult
- CompanyQueryParameter
- CompanyQueryCreate
- CompanyQueryPatch
- CompanyQueryResult
- CompanyQuery
- CompanyQueryList
- CompanyQueryTestResult
- CompanyQueryTestInput
- AiAgentQueryPatch
- AiAgentQueryResult
- CompanyQueryDeleteResult
- ReplyGuardRuleCreate
- ReplyGuardRulePatch
- ReplyGuardRule
- ReplyGuardRules
- ReplyGuardSaved
- ReplyGuardHit
- ReplyGuardHits
- ChannelRetirement
- ChannelRetirementResult
- AiDutySettingsResponse
- AiDutySettings
- WebhookEndpointWrite
- WebhookEndpoint
- WebhookEndpointWithSecret
- MessageSendFailedData
- message.send.failed
- AiDutyPlantao
- conversation.fields.updated
- FieldMirror
- ConversationFieldsUpdatedData
- AiDutyDailyTriggerCounters
- RateLimitError
- AiDutySettingsRead
- TemplateCreateRequest
- QueuePolicy
- QueuePolicyPatch
- DismissAiSuggestionsInput
- DismissAiSuggestionsResult
Contact
required lists the fields always present in a response, not what a request must send: to create or update a contact send ContactWrite with phone (POST /contacts or PUT /contacts/external/{external_id}).{
"uuid": "9c2e4f31-7a55-4d0b-8f6a-2c9d1e5b7a03",
"external_id": "customer-1847",
"phone": "+5511999998888",
"name": "Maria Silva",
"email": "maria@exemplo.com.br",
"tags": [
"cliente",
"vip"
],
"custom_fields": {
"tier": "gold",
"utm_source": "google",
"utm_campaign": "black-friday"
},
"tracking": {
"utm_source": "google",
"utm_campaign": "black-friday"
},
"last_interaction_at": "2026-08-25T14:31:09.412-03:00",
"created_at": "2026-07-02T09:12:44.001-03:00",
"updated_at": "2026-08-25T14:31:09.412-03:00"
}