> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ycloud.com/llms.txt
> Use this file to discover all available pages before exploring further.

# YCloud API

> Build messaging, verification, contact, and event workflows with YCloud APIs.

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:

```text theme={"theme":{"light":"github-light","dark":"github-dark"}}
https://api.ycloud.com/v2
```

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.

```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
curl https://api.ycloud.com/v2/balance \
  --header "X-API-Key: $YCLOUD_API_KEY" \
  --header "Accept: application/json"
```

<CardGroup cols={2}>
  <Card title="Quick start" icon="rocket" href="/en/api-reference/getting-started/quickstart">
    Configure your API key and make your first authenticated request.
  </Card>

  <Card title="Authentication" icon="key" href="/en/api-reference/guides/api-fundamentals/authentication">
    Store and use your YCloud API key securely.
  </Card>

  <Card title="Webhooks" icon="webhook" href="/en/api-reference/guides/api-fundamentals/configure-webhooks">
    Receive message status updates and inbound messages.
  </Card>

  <Card title="Guides" icon="book-open" href="/en/api-reference/guides/overview">
    Follow practical guides for common integration workflows.
  </Card>
</CardGroup>

## What you can build

<CardGroup cols={2}>
  <Card title="WhatsApp experiences" icon="whatsapp" href="/en/api-reference/guides/whatsapp-platform/send-whatsapp-message">
    Send templates, text, media, interactive messages, and more.
  </Card>

  <Card title="SMS and voice" icon="comment-sms" href="/en/api-reference/guides/messaging/send-sms">
    Send global SMS messages and automated voice codes.
  </Card>

  <Card title="Email" icon="envelope" href="/en/api-reference/guides/messaging/send-email">
    Send HTML or plain-text email from an activated domain.
  </Card>

  <Card title="WhatsApp platform" icon="building" href="/en/api-reference/guides/whatsapp-platform/manage-whatsapp-business-accounts">
    Manage WABAs, phone numbers, templates, Flows, media, and calling.
  </Card>

  <Card title="Customer data" icon="address-card" href="/en/api-reference/guides/customer-data-and-operations/manage-contacts">
    Manage contacts, custom events, and channel opt-outs.
  </Card>
</CardGroup>

## Request

Send JSON request bodies with `Content-Type: application/json`. Path and query
parameters are documented on each endpoint page.

```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
curl --request POST https://api.ycloud.com/v2/sms \
  --header "X-API-Key: $YCLOUD_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "to": "+16315551234",
    "text": "Your order has shipped."
  }'
```

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.

<Note>
  Some products require account activation, an approved sender, or a connected WhatsApp Business Account before you can send messages.
</Note>

## From guide to API reference

<CardGroup cols={2}>
  <Card title="WhatsApp guide" icon="whatsapp" href="/en/api-reference/guides/whatsapp-platform/send-whatsapp-message">
    Understand message windows, sending modes, request fields, and delivery states.
  </Card>

  <Card title="WhatsApp endpoint" icon="code" href="/api-reference/whatsapp-messages/send-a-message-directly">
    Inspect the complete direct-send request and response schema.
  </Card>

  <Card title="SMS guide" icon="comment-sms" href="/en/api-reference/guides/messaging/send-sms">
    Learn how SMS requests and delivery updates work.
  </Card>

  <Card title="SMS endpoint" icon="code" href="/api-reference/sms/send-an-sms">
    Inspect the complete SMS request and response schema.
  </Card>
</CardGroup>


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