# GreenTick

- [Introduction](https://docs.greentick.ai/index.md): Connect WhatsApp, message customers, and automate the same work from the GreenTick API.
- [Quickstart](https://docs.greentick.ai/quickstart.md): Create a GreenTick account, connect WhatsApp, and reach the first message.
- [Connect WhatsApp](https://docs.greentick.ai/connect-whatsapp.md): Link a WhatsApp Business account to GreenTick and manage its phone numbers.
- [Contacts](https://docs.greentick.ai/contacts/overview.md): Add, import, export, and update the customers you message on WhatsApp.
- [Labels and attributes](https://docs.greentick.ai/contacts/labels-and-attributes.md): Organize contacts with labels and custom attributes on the connected phone number.
- [Templates](https://docs.greentick.ai/messaging/templates.md): Create WhatsApp templates in GreenTick and wait for Meta approval before you send them.
- [Broadcasts](https://docs.greentick.ai/messaging/broadcasts.md): Send an approved WhatsApp template to selected contacts now or at a scheduled time.
- [Live Chat](https://docs.greentick.ai/messaging/live-chat.md): Read customer conversations and reply from the connected WhatsApp number.
- [Automations](https://docs.greentick.ai/automation/automations.md): Build a workflow that starts on a message, a webhook, or a contact enrollment.
- [WhatsApp Flows](https://docs.greentick.ai/automation/flows.md): Collect a registration, booking, or other form inside the WhatsApp chat.
- [AI Bot](https://docs.greentick.ai/automation/ai-bot.md): Let an AI bot answer on a WhatsApp number using the knowledge you add.
- [Catalogs](https://docs.greentick.ai/automation/catalogs.md): Show products on WhatsApp and receive catalog orders in GreenTick.
- [WhatsApp ads](https://docs.greentick.ai/automation/whatsapp-ads.md): See click-to-WhatsApp ads and send conversion events from GreenTick.
- [Plans](https://docs.greentick.ai/account/plans.md): Trial, Starter, Standard, and Premium limits for messages, automations, and team seats.
- [Team](https://docs.greentick.ai/account/team.md): Invite teammates to a WhatsApp number and choose what they can manage.
- [Developer overview](https://docs.greentick.ai/developers/overview.md): Use the GreenTick API to send WhatsApp messages, sync contacts, and receive webhooks.
- [Authentication](https://docs.greentick.ai/developers/authentication.md): Send a GreenTick API key as a Bearer token and check that the key works.
- [Send messages](https://docs.greentick.ai/developers/send-messages.md): Send a WhatsApp text inside the 24-hour window or an approved template at any time.
- [Webhooks](https://docs.greentick.ai/developers/webhooks.md): Receive signed GreenTick events when a message or catalog order changes.
- [Integrations](https://docs.greentick.ai/developers/integrations.md): Send WhatsApp from Google Sheets today, and see which other tools are still marked coming soon.
- [MCP overview](https://docs.greentick.ai/mcp/overview.md): Connect Cursor, Claude, or another assistant to the GreenTick MCP server.
- [Rules](https://docs.greentick.ai/mcp/rules.md): Stop conditions, idempotency, rate limits, and the actions an assistant must not take on its own.
- [Messages](https://docs.greentick.ai/mcp/messages.md): Send session text and approved templates, schedule a template, and cancel a schedule.
- [Templates](https://docs.greentick.ai/mcp/templates.md): Validate a template, generate its header image on GreenTick, and submit it to Meta.
- [Media](https://docs.greentick.ai/mcp/media.md): File types and size limits for template headers, catalogs, knowledge, and chat attachments.
- [Automations](https://docs.greentick.ai/mcp/automations.md): Validate, save, publish, and enroll GreenTick workflows from an assistant.
- [Flows](https://docs.greentick.ai/mcp/flows.md): Create, publish, send, and read submissions for a WhatsApp Flow.
- [AI bots](https://docs.greentick.ai/mcp/ai-bots.md): Create a disabled bot, add knowledge, run a test, and enable it only when you ask.
- [Broadcasts](https://docs.greentick.ai/mcp/broadcasts.md): Create a broadcast draft, preview who will receive it, and schedule it.
- [Inbox](https://docs.greentick.ai/mcp/inbox.md): List conversations, assign a chat, suggest a reply, and send session media or products.
- [Contacts](https://docs.greentick.ai/mcp/contacts.md): Create and update contacts, labels, and attributes, and list phone numbers.
- [Catalogs and ads](https://docs.greentick.ai/mcp/catalogs.md): Manage catalog products and orders, and send click-to-WhatsApp conversion events.
- [Check API availability](https://docs.greentick.ai/api-reference/system/check-api-availability.md)
- [Download the OpenAPI document](https://docs.greentick.ai/api-reference/system/download-the-openapi-document.md)
- [Send a WhatsApp message](https://docs.greentick.ai/api-reference/messages/send-a-whatsapp-message.md): Send a session text message or an approved WhatsApp template. Text messages require an open customer-service window; templates can start a conversation. GreenTick templates use named variables only. The to field is cleaned to digits and validated with country code (same rules as dashboard contacts)…
- [Cancel a scheduled template message](https://docs.greentick.ai/api-reference/messages/cancel-a-scheduled-template-message.md): Cancels a template that has not been sent yet. Refused in the last minute before the send time.
- [Mark an inbound message as read](https://docs.greentick.ai/api-reference/messages/mark-an-inbound-message-as-read.md): Sends a WhatsApp read receipt for an inbound message and clears the conversation unread count. Use the GreenTick message id from GET /conversations/{id}/messages.
- [List conversations](https://docs.greentick.ai/api-reference/conversations/list-conversations.md): Lists WhatsApp inbox threads for a phone line, sorted by most recent activity. Uses cursor pagination.
- [List messages in a conversation](https://docs.greentick.ai/api-reference/conversations/list-messages-in-a-conversation.md): Fetches paginated message history for a conversation. Without before/after, returns the latest page. Use before to load older messages and after to load newer ones.
- [Assign a conversation](https://docs.greentick.ai/api-reference/conversations/assign-a-conversation.md)
- [Suggest a reply](https://docs.greentick.ai/api-reference/conversations/suggest-a-reply.md)
- [Mark a conversation as read](https://docs.greentick.ai/api-reference/conversations/mark-a-conversation-as-read.md)
- [Send a session media message](https://docs.greentick.ai/api-reference/conversations/send-a-session-media-message.md): Requires an open customer-service window. mediaType is image, video, or document. Send mediaBase64 or a public mediaUrl from POST /media. JPEG and PNG up to 5 MB, MP4 up to 16 MB, PDF up to 100 MB.
- [Send the connected catalog in a session](https://docs.greentick.ai/api-reference/conversations/send-the-connected-catalog-in-a-session.md)
- [Send one catalog product in a session](https://docs.greentick.ai/api-reference/conversations/send-one-catalog-product-in-a-session.md)
- [Send a multi-product list in a session](https://docs.greentick.ai/api-reference/conversations/send-a-multi-product-list-in-a-session.md)
- [Send a product carousel in a session](https://docs.greentick.ai/api-reference/conversations/send-a-product-carousel-in-a-session.md)
- [List message templates](https://docs.greentick.ai/api-reference/templates/list-message-templates.md): Lists templates for the connected phone number on Meta, with their named variables and header requirements. Returns APPROVED templates by default; pass status=all for every status. Filter with name and language query params (name + language uniquely identifies a template).
- [Validate a template without calling Meta](https://docs.greentick.ai/api-reference/templates/validate-a-template-without-calling-meta.md)
- [Generate a template and header image without submitting it](https://docs.greentick.ai/api-reference/templates/generate-a-template-and-header-image-without-submitting-it.md): The first call sends only prompt. Follow-up calls send answers. confirmed true creates the header image and does not submit the template.
- [Get one template by Meta id](https://docs.greentick.ai/api-reference/templates/get-one-template-by-meta-id.md)
- [Delete a template by name](https://docs.greentick.ai/api-reference/templates/delete-a-template-by-name.md): The path value is the template name, not the Meta id. Optional language query narrows the match.
- [Create a message template and submit it to Meta](https://docs.greentick.ai/api-reference/mcp-platform/create-a-message-template-and-submit-it-to-meta.md): Compiles a plain template payload, enforces dashboard character limits, probes URL buttons, and submits the template. A PENDING result blocks send until Meta approves it. Call POST /templates/validate first.
- [Dashboard limits every connector must enforce](https://docs.greentick.ai/api-reference/mcp-platform/dashboard-limits-every-connector-must-enforce.md): Character and count limits for templates, workflows, Flows, bots, catalogs, and messages.
- [Plan usage for this API key](https://docs.greentick.ai/api-reference/mcp-platform/plan-usage-for-this-api-key.md): Messages, AI tokens, automations, Flows, and bots used on the current plan.
- [Check the API key](https://docs.greentick.ai/api-reference/api-key/check-the-api-key.md): Returns valid: true when the Bearer API key is active. Invalid, revoked, and expired keys receive 401. An expired GreenTick plan receives 403.
- [List WhatsApp phone numbers](https://docs.greentick.ai/api-reference/phone-numbers/list-whatsapp-phone-numbers.md): Lists the connected WhatsApp phone number with Meta profile fields stored by GreenTick. Filter with ref or id query params to narrow to one line.
- [List contacts](https://docs.greentick.ai/api-reference/contacts/list-contacts.md)
- [Create one or more contacts](https://docs.greentick.ai/api-reference/contacts/create-one-or-more-contacts.md)
- [Update one or more contacts](https://docs.greentick.ai/api-reference/contacts/update-one-or-more-contacts.md): Updates active contacts only. Soft-deleted contacts are treated as permanently removed (404). The deleted flag cannot be set via the API. If labels or attributes are included, every id must exist for the connected phone number (from GET /labels and GET /attributes) or the request fails with 400.
- [Retrieve a contact](https://docs.greentick.ai/api-reference/contacts/retrieve-a-contact.md): Fetches one active contact by GreenTick id. Soft-deleted contacts are treated as permanently removed (404).
- [List contact labels](https://docs.greentick.ai/api-reference/labels/list-contact-labels.md): Lists label definitions for the connected phone number. Use label ids when assigning labels on contacts.
- [Create one or more labels](https://docs.greentick.ai/api-reference/labels/create-one-or-more-labels.md)
- [Retrieve a label](https://docs.greentick.ai/api-reference/labels/retrieve-a-label.md): Fetches one label definition by GreenTick id.
- [Delete a label](https://docs.greentick.ai/api-reference/labels/delete-a-label.md)
- [Rename a label](https://docs.greentick.ai/api-reference/labels/rename-a-label.md)
- [List contact attributes](https://docs.greentick.ai/api-reference/attributes/list-contact-attributes.md): Lists custom attribute definitions for the connected phone number. Use attribute ids when setting contact.attributes values.
- [Create one or more attributes](https://docs.greentick.ai/api-reference/attributes/create-one-or-more-attributes.md)
- [Retrieve an attribute](https://docs.greentick.ai/api-reference/attributes/retrieve-an-attribute.md): Fetches one attribute definition by GreenTick id.
- [Delete an attribute](https://docs.greentick.ai/api-reference/attributes/delete-an-attribute.md)
- [Rename an attribute](https://docs.greentick.ai/api-reference/attributes/rename-an-attribute.md)
- [List enrollable automations](https://docs.greentick.ai/api-reference/automations/list-enrollable-automations.md): Lists published, active workflows whose trigger is Enroll contacts. These are the same automations a drip campaign can start.
- [Start an automation for one contact](https://docs.greentick.ai/api-reference/automations/start-an-automation-for-one-contact.md): Enrolls one phone number into a published automation whose trigger is Enroll contacts. Messages are the Send template steps in that workflow.
- [Trigger a webhook workflow](https://docs.greentick.ai/api-reference/workflow-hooks/trigger-a-webhook-workflow.md): The gthook_ secret in the URL authenticates this request. Do not also send a GreenTick API key. The workflow must be active and use the Webhook event trigger.
- [Subscribe to events](https://docs.greentick.ai/api-reference/webhooks/subscribe-to-events.md): Creates an outbound webhook for this API key's WhatsApp Business account. Zapier and Make.com call this when a Zap or scenario is turned on. The signing secret is returned once.
- [Unsubscribe from events](https://docs.greentick.ai/api-reference/webhooks/unsubscribe-from-events.md): Deletes a webhook subscription for this API key's WhatsApp Business account. Missing subscriptions return success so Zapier and Make can turn off cleanly.
- [Media rules for customer-supplied files](https://docs.greentick.ai/api-reference/media/media-rules-for-customer-supplied-files.md)
- [Host media from a public HTTPS URL or a complete base64 image](https://docs.greentick.ai/api-reference/media/host-media-from-a-public-https-url-or-a-complete-base64-image.md): purpose is template_header, catalog, or knowledge. A template header image for a new template is created with POST /templates/generate.
- [Host media from a multipart upload](https://docs.greentick.ai/api-reference/media/host-media-from-a-multipart-upload.md)
- [List workflows](https://docs.greentick.ai/api-reference/workflows/list-workflows.md)
- [Create a workflow draft](https://docs.greentick.ai/api-reference/workflows/create-a-workflow-draft.md)
- [Workflow starter catalog](https://docs.greentick.ai/api-reference/workflows/workflow-starter-catalog.md)
- [Validate workflow steps without saving](https://docs.greentick.ai/api-reference/workflows/validate-workflow-steps-without-saving.md)
- [Create a workflow draft from a starter](https://docs.greentick.ai/api-reference/workflows/create-a-workflow-draft-from-a-starter.md)
- [Export workflows on this WhatsApp account](https://docs.greentick.ai/api-reference/workflows/export-workflows-on-this-whatsapp-account.md)
- [Get a workflow](https://docs.greentick.ai/api-reference/workflows/get-a-workflow.md)
- [Update a workflow draft](https://docs.greentick.ai/api-reference/workflows/update-a-workflow-draft.md)
- [Delete a workflow](https://docs.greentick.ai/api-reference/workflows/delete-a-workflow.md)
- [Publish a valid workflow draft](https://docs.greentick.ai/api-reference/workflows/publish-a-valid-workflow-draft.md)
- [Discard a workflow draft](https://docs.greentick.ai/api-reference/workflows/discard-a-workflow-draft.md)
- [Workflow analytics](https://docs.greentick.ai/api-reference/workflows/workflow-analytics.md)
- [List flows](https://docs.greentick.ai/api-reference/flows/list-flows.md)
- [Create a static flow draft](https://docs.greentick.ai/api-reference/flows/create-a-static-flow-draft.md)
- [Validate flow screens without calling Meta](https://docs.greentick.ai/api-reference/flows/validate-flow-screens-without-calling-meta.md)
- [Phone number encryption key](https://docs.greentick.ai/api-reference/flows/phone-number-encryption-key.md)
- [Analytics for every Flow on this WhatsApp account](https://docs.greentick.ai/api-reference/flows/analytics-for-every-flow-on-this-whatsapp-account.md)
- [Get a flow](https://docs.greentick.ai/api-reference/flows/get-a-flow.md)
- [Update a flow draft](https://docs.greentick.ai/api-reference/flows/update-a-flow-draft.md)
- [Delete a draft flow](https://docs.greentick.ai/api-reference/flows/delete-a-draft-flow.md): Meta allows delete only while the Flow is a draft.
- [Publish a flow draft](https://docs.greentick.ai/api-reference/flows/publish-a-flow-draft.md)
- [Deprecate a published flow](https://docs.greentick.ai/api-reference/flows/deprecate-a-published-flow.md)
- [List flow submissions](https://docs.greentick.ai/api-reference/flows/list-flow-submissions.md)
- [Analytics for one Flow](https://docs.greentick.ai/api-reference/flows/analytics-for-one-flow.md)
- [Send a published flow](https://docs.greentick.ai/api-reference/flows/send-a-published-flow.md): Session-window send. The Flow must already be published.
- [List AI bots](https://docs.greentick.ai/api-reference/ai-bots/list-ai-bots.md)
- [Create a disabled AI bot](https://docs.greentick.ai/api-reference/ai-bots/create-a-disabled-ai-bot.md)
- [Available AI models](https://docs.greentick.ai/api-reference/ai-bots/available-ai-models.md)
- [Update an AI bot](https://docs.greentick.ai/api-reference/ai-bots/update-an-ai-bot.md)
- [Delete an AI bot](https://docs.greentick.ai/api-reference/ai-bots/delete-an-ai-bot.md)
- [List knowledge sources](https://docs.greentick.ai/api-reference/ai-bots/list-knowledge-sources.md)
- [Add FAQ, URL, or file knowledge](https://docs.greentick.ai/api-reference/ai-bots/add-faq-url-or-file-knowledge.md)
- [Test an AI bot](https://docs.greentick.ai/api-reference/ai-bots/test-an-ai-bot.md)
- [Enable a tested AI bot](https://docs.greentick.ai/api-reference/ai-bots/enable-a-tested-ai-bot.md)
- [List broadcasts](https://docs.greentick.ai/api-reference/broadcasts/list-broadcasts.md)
- [Create a broadcast draft](https://docs.greentick.ai/api-reference/broadcasts/create-a-broadcast-draft.md)
- [Preview a broadcast recipient count](https://docs.greentick.ai/api-reference/broadcasts/preview-a-broadcast-recipient-count.md)
- [List broadcast deliveries](https://docs.greentick.ai/api-reference/broadcasts/list-broadcast-deliveries.md)
- [Schedule a broadcast](https://docs.greentick.ai/api-reference/broadcasts/schedule-a-broadcast.md): scheduledDateTime must be at least 5 minutes from now and within 30 days.
- [Get a broadcast](https://docs.greentick.ai/api-reference/broadcasts/get-a-broadcast.md): Returns 404 when the broadcast belongs to another phone line.
- [Delete a pending or queued broadcast](https://docs.greentick.ai/api-reference/broadcasts/delete-a-pending-or-queued-broadcast.md): Only PENDING and QUEUED broadcasts can be deleted. A broadcast inside the last minute before it starts is locked.
- [List commerce catalogs](https://docs.greentick.ai/api-reference/catalogs/list-commerce-catalogs.md)
- [List catalog orders received in chat](https://docs.greentick.ai/api-reference/catalogs/list-catalog-orders-received-in-chat.md)
- [List products](https://docs.greentick.ai/api-reference/catalogs/list-products.md)
- [Create a catalog product](https://docs.greentick.ai/api-reference/catalogs/create-a-catalog-product.md)
- [Update a catalog product](https://docs.greentick.ai/api-reference/catalogs/update-a-catalog-product.md)
- [Delete a catalog product](https://docs.greentick.ai/api-reference/catalogs/delete-a-catalog-product.md)
- [List Click-to-WhatsApp ads and analysis](https://docs.greentick.ai/api-reference/ads/list-click-to-whatsapp-ads-and-analysis.md)
- [Send a Click-to-WhatsApp conversion](https://docs.greentick.ai/api-reference/ads/send-a-click-to-whatsapp-conversion.md): eventName is QualifiedLead or Purchase. Purchase may include currency and value. At most 50 conversation ids. Requires the Meta Conversions API plan feature.

## OpenAPI Specs

- [openapi](/openapi.json)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.