# Schema Reference

173 schemas generated from Flownally API 1.0.0.

## Schemas

- [Response](/api/reference/schemas/inboxes-response.md) - object - Connected inboxes for the workspace.
- [Inbox](/api/reference/schemas/inbox.md) - object - A connected customer communication channel in Flownally.
- [InboxStatus](/api/reference/schemas/inbox-status.md) - object - Channel-agnostic operational health for an inbox.
- [InboxStatusState](/api/reference/schemas/inbox-status-state.md) - enum - Overall operational health of an inbox.
- [InboxStatusReason](/api/reference/schemas/inbox-status-reason.md) - enum - Reason an inbox is not fully active.
- [ProblemDetails](/api/reference/schemas/problem-details.md) - object - RFC 9457 Problem Details response with a stable Flownally error code.
- [FieldViolation](/api/reference/schemas/field-violation.md) - object
- [Window](/api/reference/schemas/messaging-window.md) - object - Tells a client whether the current actor can send in this conversation right now.
- [CreateInboxRequest](/api/reference/schemas/create-inbox-request.md) - object - Connect exactly one channel type per request.
- [CreateWhatsAppInboxRequest](/api/reference/schemas/create-whats-app-inbox-request.md) - object - Create a WhatsApp inbox
- [WhatsAppInboxRequest](/api/reference/schemas/whats-app-inbox-request.md) - object - WhatsApp Business resources to connect.
- [CreateMessengerInboxRequest](/api/reference/schemas/create-messenger-inbox-request.md) - object - Create a Messenger inbox
- [MessengerInboxRequest](/api/reference/schemas/messenger-inbox-request.md) - object - Facebook Pages to connect for Messenger conversations.
- [CreateInstagramInboxRequest](/api/reference/schemas/create-instagram-inbox-request.md) - object - Create an Instagram inbox
- [InstagramInboxRequest](/api/reference/schemas/instagram-inbox-request.md) - object - Instagram Business accounts to connect.
- [CreateTextIncInboxRequest](/api/reference/schemas/create-text-inc-inbox-request.md) - object - Create a Text Inc agent inbox
- [TextIncInboxRequest](/api/reference/schemas/text-inc-inbox-request.md) - object - Text Inc organization to connect.
- [CreateTwilioInboxRequest](/api/reference/schemas/create-twilio-inbox-request.md) - object - Create Twilio inboxes from selected sender phone numbers.
- [TwilioInboxRequest](/api/reference/schemas/twilio-inbox-request.md) - object - Twilio pending credential and sender phone numbers to connect.
- [CreateInboxResponse](/api/reference/schemas/create-inbox-response.md) - object - Inboxes created from the connected channel resources.
- [SetInboxTeamRequest](/api/reference/schemas/set-inbox-team-request.md) - object - Team that should own new conversations arriving in this inbox.
- [WhatsAppTemplatesResponse](/api/reference/schemas/whats-app-templates-response.md) - object - WhatsApp templates available for outbound template messages.
- [WhatsAppTemplate](/api/reference/schemas/whats-app-template.md) - object - WhatsApp message template synced from Meta.
- [WhatsAppTemplateComponent](/api/reference/schemas/whats-app-template-component.md) - object
- [WhatsAppTemplateButton](/api/reference/schemas/whats-app-template-button.md) - object
- [WABAPhoneNumbersResponse](/api/reference/schemas/waba-phone-numbers-response.md) - object - Phone numbers available on a WhatsApp Business Account.
- [WABAPhoneNumber](/api/reference/schemas/waba-phone-number.md) - object - WhatsApp phone number that can be connected to an inbox.
- [ListTwilioPhoneNumbersRequest](/api/reference/schemas/list-twilio-phone-numbers-request.md) - object - Twilio credential used to list sender phone numbers.
- [TwilioPhoneNumbersResponse](/api/reference/schemas/twilio-phone-numbers-response.md) - object - Twilio phone numbers available for installation.
- [TwilioPhoneNumber](/api/reference/schemas/twilio-phone-number.md) - object - Twilio sender phone number that can be connected to an inbox.
- [TwilioPhoneNumberCapabilities](/api/reference/schemas/twilio-phone-number-capabilities.md) - object - Messaging capabilities reported by Twilio for this phone number.
- [Response](/api/reference/schemas/users-response.md) - object - Workspace members.
- [User](/api/reference/schemas/user.md) - object - Person who can work in the Flownally workspace.
- [UpdateProfileRequest](/api/reference/schemas/update-profile-request.md) - object - Profile fields to update for the authenticated user.
- [UnreadCountResponse](/api/reference/schemas/unread-count-response.md) - object
- [UnreadSummaryResponse](/api/reference/schemas/unread-summary-response.md) - object
- [UpdateUserRoleRequest](/api/reference/schemas/update-user-role-request.md) - object - Role assignment for a workspace member.
- [ListTeamsResponse](/api/reference/schemas/list-teams-response.md) - object - Paginated teams in the workspace.
- [Team](/api/reference/schemas/team.md) - object - Group of teammates used for inbox routing and conversation access.
- [CreateTeamRequest](/api/reference/schemas/create-team-request.md) - object - Team to create.
- [UpdateTeamRequest](/api/reference/schemas/update-team-request.md) - object
- [ListTeamAgentsResponse](/api/reference/schemas/list-team-agents-response.md) - object
- [TeamMembership](/api/reference/schemas/team-membership.md) - object - Membership link between a user and a team.
- [AddAgentToTeamRequest](/api/reference/schemas/add-agent-to-team-request.md) - object - User to add to the team.
- [CreateMessageRequest](/api/reference/schemas/create-message-request.md) - object - Body for sending the first message to a phone recipient or continuing an existing conversation.
- [MessageRecipient](/api/reference/schemas/message-recipient.md) - object - Choose how Flownally should find the customer thread: an existing conversation
a known contact, or a phone recipient for first-message sends.
- [ConversationRecipient](/api/reference/schemas/conversation-recipient.md) - object - Continue a known conversation.
- [ContactRecipient](/api/reference/schemas/contact-recipient.md) - object - Send to a contact through the request inbox. Flownally uses an existing contact conversation for that inbox when available, otherwise the contact `cf_phone` custom field.
- [PhoneRecipient](/api/reference/schemas/phone-recipient.md) - object - Start a conversation with a phone number through the request inbox.
- [MessageContent](/api/reference/schemas/message-content.md) - object - Message body to send or display. Use `text` for plain replies, `media` for uploaded
or hosted files, `template` for WhatsApp-approved templates, and `richMessage` for
interactive channel content.
- [TextMessageContent](/api/reference/schemas/text-message-content.md) - object - Plain text message content.
- [TextContent](/api/reference/schemas/text-content.md) - object - Plain text body.
- [MessageContent](/api/reference/schemas/media-message-content.md) - object - Media message content. Upload with `/media/uploads` first, then pass the returned `mediaId`.
- [Content](/api/reference/schemas/media-content.md) - object - Media reference and optional presentation details. Use `mediaId` for Flownally-hosted
upload and inbound media. Use `GET /media/{mediaId}` to retrieve inbound
media bytes through an authorized download URL.
- [TemplateMessageContent](/api/reference/schemas/template-message-content.md) - object - WhatsApp template message content. The gateway maps this to the channel-specific send internally.
- [WhatsAppTemplateContent](/api/reference/schemas/whats-app-template-content.md) - object
- [TemplateComponent](/api/reference/schemas/template-component.md) - object
- [TemplateParameter](/api/reference/schemas/template-parameter.md) - object
- [Parameter](/api/reference/schemas/media-parameter.md) - object
- [CurrencyParameter](/api/reference/schemas/currency-parameter.md) - object
- [DateTimeParameter](/api/reference/schemas/date-time-parameter.md) - object
- [RichMessageContent](/api/reference/schemas/rich-message-content.md) - object - Structured rich message content for channels that support cards or actions.
- [RichMessage](/api/reference/schemas/rich-message.md) - object
- [Card](/api/reference/schemas/card.md) - object
- [CardHeader](/api/reference/schemas/card-header.md) - object
- [CardBody](/api/reference/schemas/card-body.md) - object
- [CardFooter](/api/reference/schemas/card-footer.md) - object
- [CardAction](/api/reference/schemas/card-action.md) - object
- [WhatsAppMessageContent](/api/reference/schemas/whats-app-message-content.md) - object - WhatsApp-specific message content.
- [WhatsAppContent](/api/reference/schemas/whats-app-content.md) - object - WhatsApp-only message features.
- [WhatsAppRequestContactInfoContent](/api/reference/schemas/whats-app-request-contact-info-content.md) - object - WhatsApp interactive request for the user to share their phone number.
- [SendMessageResponse](/api/reference/schemas/send-message-response.md) - object - Returned after Flownally accepts a message for delivery.
- [Message](/api/reference/schemas/message.md) - object - Message record with content, delivery state, and channel delivery context.
- [Reaction](/api/reference/schemas/reaction.md) - object
- [Conversation](/api/reference/schemas/conversation.md) - object - A customer conversation as it appears in the shared Flownally inbox.
- [ConversationOwner](/api/reference/schemas/conversation-owner.md) - object
- [GetMessageResponse](/api/reference/schemas/get-message-response.md) - object - Message status and conversation context for polling integrations.
- [DownloadURLResponse](/api/reference/schemas/media-download-url-response.md) - object - Authorized media download state.
- [CreateMediaUploadRequest](/api/reference/schemas/create-media-upload-request.md) - object - Multipart upload body containing the media file to send later.
- [UploadResponse](/api/reference/schemas/media-upload-response.md) - object - Uploaded media reference for message content.
- [ListConversationsResponse](/api/reference/schemas/list-conversations-response.md) - object
- [ConversationDetail](/api/reference/schemas/conversation-detail.md) - object
- [ListMessagesResponse](/api/reference/schemas/list-messages-response.md) - object
- [SendMessageRequest](/api/reference/schemas/send-message-request.md) - object - Body for replying inside an existing conversation.
- [SendReactionRequest](/api/reference/schemas/send-reaction-request.md) - object
- [SendReactionResponse](/api/reference/schemas/send-reaction-response.md) - object
- [ReassignConversationRequest](/api/reference/schemas/reassign-conversation-request.md) - object
- [MarkConversationReadRequest](/api/reference/schemas/mark-conversation-read-request.md) - object
- [Response](/api/reference/schemas/contacts-response.md) - object - Paginated contact list.
- [Contact](/api/reference/schemas/contact.md) - object - Customer profile used across messaging, events, and journeys.
- [ContactConversation](/api/reference/schemas/contact-conversation.md) - object - Conversation grouped under a contact.
- [CreateContactRequest](/api/reference/schemas/create-contact-request.md) - object - Contact fields to create. Add custom fields after defining them in Flownally.
- [CountResponse](/api/reference/schemas/contacts-count-response.md) - object
- [UpdateContactRequest](/api/reference/schemas/update-contact-request.md) - object
- [ImportContactsResponse](/api/reference/schemas/import-contacts-response.md) - object - Accepted contact import job.
- [ImportStatus](/api/reference/schemas/import-status.md) - object - Progress and results for a contact import.
- [ImportError](/api/reference/schemas/import-error.md) - object
- [SetContactCustomFieldValueRequest](/api/reference/schemas/set-contact-custom-field-value-request.md) - object - Value to store on a contact. Send an empty string to clear the value.
- [TagsResponse](/api/reference/schemas/tags-response.md) - object
- [Tag](/api/reference/schemas/tag.md) - object - Label used to segment and organize contacts.
- [CreateTagRequest](/api/reference/schemas/create-tag-request.md) - object - Tag to create.
- [CustomFieldDefinitionsResponse](/api/reference/schemas/custom-field-definitions-response.md) - object - Reusable custom field definitions for one resource type.
- [CustomFieldDefinition](/api/reference/schemas/custom-field-definition.md) - object - Defines a reusable custom field for either contacts or property records. Values are stored
separately on each resource.
- [CreateCustomFieldDefinitionRequest](/api/reference/schemas/create-custom-field-definition-request.md) - object - Field definition to create for the resource collection in the URL.
- [UpdateCustomFieldDefinitionRequest](/api/reference/schemas/update-custom-field-definition-request.md) - object - New name and value type for an existing field definition.
- [Response](/api/reference/schemas/journeys-response.md) - object
- [Journey](/api/reference/schemas/journey.md) - object - Event-driven workflow that moves contacts through follow-up steps.
- [JourneyStatus](/api/reference/schemas/journey-status.md) - enum
- [WorkflowDefinition](/api/reference/schemas/workflow-definition.md) - object
- [WorkflowNode](/api/reference/schemas/workflow-node.md) - object
- [StartWorkflowNode](/api/reference/schemas/start-workflow-node.md) - object
- [StartNodeData](/api/reference/schemas/start-node-data.md) - object - Journey start block settings. The backend persists these as journey triggerConfig and entryMode.
- [TriggerConfig](/api/reference/schemas/trigger-config.md) - object
- [EntryMode](/api/reference/schemas/entry-mode.md) - enum - Controls how contacts can re-enter the journey
- [HTTPRequestWorkflowNode](/api/reference/schemas/http-request-workflow-node.md) - object
- [HTTPRequestNodeData](/api/reference/schemas/http-request-node-data.md) - object
- [GenericWorkflowNode](/api/reference/schemas/generic-workflow-node.md) - object
- [GenericNodeData](/api/reference/schemas/generic-node-data.md) - object - Node-specific data for journey nodes without a dedicated public schema yet.
- [WorkflowEdge](/api/reference/schemas/workflow-edge.md) - WorkflowEdge
- [WorkflowEdge](/api/reference/schemas/workflow-edge2.md) - object
- [JourneyVersion](/api/reference/schemas/journey-version.md) - object
- [CreateJourneyRequest](/api/reference/schemas/create-journey-request.md) - object - Journey draft to create.
- [UpdateJourneyRequest](/api/reference/schemas/update-journey-request.md) - object - Journey draft fields to update.
- [JourneyVersionsResponse](/api/reference/schemas/journey-versions-response.md) - object
- [Response](/api/reference/schemas/chatbots-response.md) - object
- [Chatbot](/api/reference/schemas/chatbot.md) - object - Automated chat flow that can serve selected teams or the whole workspace.
- [ChatbotStatus](/api/reference/schemas/chatbot-status.md) - enum
- [ChatbotWorkflowDefinition](/api/reference/schemas/chatbots-workflow-definition.md) - object
- [ChatbotWorkflowNode](/api/reference/schemas/chatbots-workflow-node.md) - object
- [ChatbotVersion](/api/reference/schemas/chatbot-version.md) - object
- [CreateChatbotRequest](/api/reference/schemas/create-chatbot-request.md) - object - Chatbot draft to create.
- [UpdateChatbotRequest](/api/reference/schemas/update-chatbot-request.md) - object - Chatbot draft fields to update.
- [ChatbotVersionsResponse](/api/reference/schemas/chatbot-versions-response.md) - object
- [EventTypesResponse](/api/reference/schemas/event-types-response.md) - object - Event type catalog.
- [EventType](/api/reference/schemas/event-type.md) - object - Event definition used to validate and classify recorded customer moments.
- [CreateEventTypeRequest](/api/reference/schemas/create-event-type-request.md) - object - Event type to add to the workspace catalog.
- [UpdateEventTypeRequest](/api/reference/schemas/update-event-type-request.md) - object
- [Response](/api/reference/schemas/events-response.md) - object - Paginated recorded events.
- [Event](/api/reference/schemas/event.md) - object - Customer event stored on a contact timeline.
- [CreateEventRequest](/api/reference/schemas/create-event-request.md) - object - Deprecated event creation body that includes contact ID in the payload.
- [CreateContactEventRequest](/api/reference/schemas/create-contact-event-request.md) - object - Event to record for the contact in the path.
- [StatusResponse](/api/reference/schemas/billing-status-response.md) - object - Current subscription state for the workspace.
- [ListServiceAccountsResponse](/api/reference/schemas/list-service-accounts-response.md) - object
- [ServiceAccount](/api/reference/schemas/service-account.md) - object - Server-to-server integration identity.
- [CreateServiceAccountRequest](/api/reference/schemas/create-service-account-request.md) - object - Integration identity to create.
- [ListAPIKeysResponse](/api/reference/schemas/list-api-keys-response.md) - object - API keys for a service account.
- [APIKeyInfo](/api/reference/schemas/api-key-info.md) - object - API key metadata. The plaintext key is only returned when the key is created.
- [CreateAPIKeyRequest](/api/reference/schemas/create-api-key-request.md) - object - API key to create for the service account.
- [CreateAPIKeyResponse](/api/reference/schemas/create-api-key-response.md) - object - API key creation response. The `key` value is shown once.
- [WebhookSettings](/api/reference/schemas/webhook-settings.md) - object - Single tenant-level webhook configuration.
- [WebhookEventType](/api/reference/schemas/webhook-event-type.md) - enum
- [UpdateWebhookSettingsRequest](/api/reference/schemas/update-webhook-settings-request.md) - object
- [VerifyWebhookRequest](/api/reference/schemas/verify-webhook-request.md) - object
- [VerifyWebhookResponse](/api/reference/schemas/verify-webhook-response.md) - object
- [WebhookEventName](/api/reference/schemas/webhook-event-name.md) - string - Webhook event name. Resource webhooks use documented event types.
- [WebhookAttemptStatus](/api/reference/schemas/webhook-attempt-status.md) - enum
- [ListWebhookAttemptsResponse](/api/reference/schemas/list-webhook-attempts-response.md) - object
- [WebhookAttempt](/api/reference/schemas/webhook-attempt.md) - object
- [ListWebhookSigningKeysResponse](/api/reference/schemas/list-webhook-signing-keys-response.md) - object
- [WebhookSigningKey](/api/reference/schemas/webhook-signing-key.md) - object
- [RotateWebhookSigningKeyResponse](/api/reference/schemas/rotate-webhook-signing-key-response.md) - object
- [WebhookPayload](/api/reference/schemas/webhook-payload.md) - object - Signed webhook event body. Deduplicate deliveries by id, which matches the webhook-id header.
- [ContactCreatedWebhookEvent](/api/reference/schemas/contact-created-webhook-event.md) - object
- [ContactWebhookEventData](/api/reference/schemas/contact-webhook-event-data.md) - object - Contact resource snapshot associated with a contact webhook event.
- [ContactUpdatedWebhookEvent](/api/reference/schemas/contact-updated-webhook-event.md) - object
- [ContactArchivedWebhookEvent](/api/reference/schemas/contact-archived-webhook-event.md) - object
- [ConversationStartedWebhookEvent](/api/reference/schemas/conversation-started-webhook-event.md) - object
- [ConversationWebhookEventData](/api/reference/schemas/conversation-webhook-event-data.md) - object - Conversation facade snapshot and related public resources.
- [ConversationUpdatedWebhookEvent](/api/reference/schemas/conversation-updated-webhook-event.md) - object
- [ConversationClosedWebhookEvent](/api/reference/schemas/conversation-closed-webhook-event.md) - object
- [MessageCreatedWebhookEvent](/api/reference/schemas/message-created-webhook-event.md) - object
- [MessageWebhookEventData](/api/reference/schemas/message-webhook-event-data.md) - object - Message snapshot and related public resources.
- [MessageUpdatedWebhookEvent](/api/reference/schemas/message-updated-webhook-event.md) - object