Introduction

This detailed summary explores the process of creating workspaces through the Partner API, tailored specifically for UChat Partners.

The content provides a step-by-step breakdown of how to automate workspace creation, manage user accounts, and integrate templates seamlessly into your workflows.

Whether you're managing new users or existing ones, this guide offers practical insights, technical instructions, and strategic tips to optimize your partner operations.

Overview of Use Cases and Objectives

The primary goal of leveraging the Partner API is to streamline the onboarding and management of user workspaces. This automation benefits agencies, developers, and marketers by reducing manual effort, enhancing user experience, and enabling rapid deployment of chatbots and funnels.

Key Use Cases:

• Creating new workspaces for fresh users
  Automate onboarding for users who haven't registered yet, providing instant access to features and templates.

• Managing existing users
  Generate additional workspaces for current users, allowing them to operate multiple bots or channels under a single account.

• Automating account setup in various channels
  Support channels like Web Chat, Facebook, WhatsApp, Instagram, and more, with pre-installed templates for quick deployment.

• Integrating with website forms and funnel builders
  Use webhooks and integrations (e.g., Zapier, Make) to trigger workspace creation upon form submissions or funnel completions.

Step-by-Step Process

1. Accessing API Documentation

• Locate your Partner API URL:

  • Log into your YouChat Partner account.

  • Navigate to Weather Label Settings > Partner Settings.

  • Find the Webhook URL section, which contains the API endpoint.

• Visual Guide:

  Step	Action	Location
  1	Log into your partner account	Dashboard
  2	Go to Weather Label Settings	Settings Menu
  3	Select Partner Settings	Submenu
  4	Find Webhook URL	API Section

2. Obtaining API Keys

• Use your main workspace API key:

  • From your main workspace, navigate to API Keys.

  • Copy a sample API key.

  • Authorize the key in the Swagger interface:

    • Paste the key into the Authorize prompt.

    • Confirm authorization to enable API calls.

• Note: The API key grants access to all bots within the main workspace.

3. Testing API Calls

• Create workspace for existing users:

  • Use the "Create for Existing Users" endpoint.

  • Input user emails and optional team names.

  • Pre-install templates (e.g., "Rock Paper Scissors") for immediate usability.

  • Send the request and verify success via response code 200.

• Create workspace for new users:

  • Use the "Create for New Users" endpoint.

  • Provide user details, including email, password, and team name.

  • Optionally disable email verification for instant access.

  • Confirm creation and test login with provided credentials.

4. Managing Templates

• Accessing Templates:

  • Via Partner Account:

    • Navigate to Template Store or Weather Label Settings > Pattern Settings > Templates.

  • Template IDs:

    • Each template has a unique ID, e.g., abc123xyz.

    • Use these IDs to install templates during workspace creation.

• Installing Templates:

  • Send API requests with the template ID.

  • Templates are installed directly into the Web Chat Channel for immediate deployment.

  • Supports multiple channels, including Facebook, WhatsApp, and Instagram.

5. Automating Workspace Creation in Chatbots

• In YouChat:

  • Use external requests within chatbot flows.

  • Collect user email and name.

  • Generate a random password using built-in functions.

  • Send API requests with user data.

  • Display login credentials upon success.

• Sample Flow:

  • Ask for First Name.

  • Ask for Email Address.

  • Generate Password.

  • Call API to create workspace.

  • Show success message with login details.

Technical Details and Best Practices

API Endpoints Overview

Essential Headers

Sample Request Body for New User

{
  "email": "[email protected]",
  "password": "RandomGeneratedPassword!",
  "team_name": "User Team",
  "install_templates": ["template_id_1", "template_id_2"],
  "channel": "webchat",
  "auto_verify": false
}

Handling Responses

• Success (2xx):

  • Confirm workspace creation.

  • Retrieve login credentials if applicable.

• Failure (4xx/5xx):

  • Check API request parameters.

  • Verify API key permissions.

  • Review error messages for troubleshooting.

Strategic Tips for Effective Implementation

• Pre-install templates to reduce onboarding time.

• Automate via webhooks triggered by form submissions or funnel completions.

• Use dynamic variables in chatbot flows to personalize user experience.

• Control email verification based on your spam prevention needs.

• Manage multiple workspaces for different clients or projects under a single API key.

Benefits of Using the Partner API

Final Thoughts

Leveraging the Partner API empowers YouChat Partners to scale operations, enhance user onboarding, and deliver personalized chatbot experiences effortlessly. By following the outlined steps—accessing documentation, managing API keys, testing requests, and integrating templates—you can automate workspace creation and management at scale.

This approach not only saves time but also opens opportunities for monetization through template sales and value-added services. Whether onboarding new clients or managing existing users, the API provides a flexible, robust solution to meet diverse needs.