Skip to main content
YCloud provides one API for customer communications and engagement workflows. You can send WhatsApp, SMS, email, and voice messages. You can also verify users, manage contacts, track custom events, and receive status updates through webhooks.

​
How requests work

All server-side requests use this base URL:
Authenticate requests with an API key in the X-API-Key header. Keep the key on your server and never expose it in browser or mobile application code.

Quick start

Configure your API key and make your first authenticated request.

Authentication

Store and use your YCloud API key securely.

Webhooks

Receive message status updates and inbound messages.

Guides

Follow practical guides for common integration workflows.

​
What you can build

WhatsApp experiences

Send templates, text, media, interactive messages, and more.

SMS and voice

Send global SMS messages and automated voice codes.

Email

Send HTML or plain-text email from an activated domain.

WhatsApp platform

Manage WABAs, phone numbers, templates, Flows, media, and calling.

Customer data

Manage contacts, custom events, and channel opt-outs.

​
Request

Send JSON request bodies with Content-Type: application/json. Path and query parameters are documented on each endpoint page.
Use the API Reference when you need the complete request schema, enum values, or an interactive request builder.

​
Response

Successful responses use JSON. A create or send response confirms that YCloud accepted the request. It does not always confirm final delivery or completion. Store the returned resource ID and correlate it with retrieval results or webhook events. Errors include a machine-readable code, a developer-facing message, and a requestId that you can provide to YCloud support.
Some products require account activation, an approved sender, or a connected WhatsApp Business Account before you can send messages.

​
From guide to API reference

WhatsApp guide

Understand message windows, sending modes, request fields, and delivery states.

WhatsApp endpoint

Inspect the complete direct-send request and response schema.

SMS guide

Learn how SMS requests and delivery updates work.

SMS endpoint

Inspect the complete SMS request and response schema.