Creating and Managing Customers for Your Site

This document explains how white-label partners can create and manage their own customers

Viewing Customers

Please go to the YCloud Console Partners to view.

Here, we divide a customer into companies and users:

• Company generally refers to a customer or brand, representing a workspace in YCloud, where multiple users can be invited for collaborative management.

• User refers to a specific person who can log in with their email and password to manage the aforementioned workspace.

Explanation of related information:

• Time Created: The time the company was created

• Company info: The company name and company ID

• Owner: The person in charge of the company, and also the first user within the company

• Credit Limit: Displays consumption limit/credit limit. The credit limit is the total amount available to the company per month, calculated by the natural month in the GMT+8 time zone. When consumption = credit limit, the company's account cannot use their WhatsApp channel. We recommend opening higher credit limits only to trusted customers.

• Status: The status of the account.

  • Active: The company is in normal use;

  • Pending: An activation email has been sent to the Owner, but the user has not yet activated the account;

  • Disabled: The company's account has been proactively disabled.

• Note: You can fill in remarks about the company here.

• Action: Modify the credit limit or disable/enable the company.

Creating Customers

Click the “Create Company” button, and fill in the user's email address, company information, credit limit (in dollars), etc.

For unverified email addresses, the system will send an email to them, and clicking the link in the email will activate the user and company.

For verified email addresses, no further verification is needed, and the user automatically becomes the new company's Owner.

Providing Usage Documentation to Customers

Although we strive to make the YCloud platform intuitive, due to the complexity of WhatsApp, we still recommend you organize relevant usage documentation and API documentation to help customers get started.

Help Documentation/Guide

You can refer to the documentation provided by YCloud to build for your customers, reference:

Welcome to YCloudDocs | Help Center

API Documentation

When you complete White-Label Partner Getting Started, we will generate the corresponding interface address based on the domain address you provide.

Your customers may want you to further provide API documentation to integrate the WhatsApp API with their own application systems.

You can refer to YCloud API Documentation, and follow the guidelines below to organize your API documentation:

1. Remove references to "YCloud," and remove or replace internal YCloud hyperlinks.

2. Requests from your custom site will not receive the response header YCloud-Request-ID (see https://docs.ycloud.com/reference/request-ids), replaced instead by X-Request-ID; erroneous responses will not include error.docUrl, i.e., https://docs.ycloud.com/reference/errors#docurl.

3. Webhook pushes from your custom site will not include the request header YCloud-Signature (see https://docs.ycloud.com/reference/configure-webhooks#step-4-secure-your-webhooks-recommended), replaced instead by X-Signature.

4. "YCLOUD API" and "Webhook Payload Object" in the API documentation are derived from OpenAPI files.

   1. The "YCLOUD API" file can be obtained from https://docs.ycloud.com/reference/openapi for the latest version. Please remember to remove references to "YCloud" and irrelevant services (including Emails, SMS, Verify, Voices, etc.).

   2. Contact YCloud to get the initial version of "Webhook Payload Object", remove irrelevant services, and ensure subsequent updates are synchronized with "YCLOUD API".