Get started

Quickstart

Get an API key, pick a method, and watch your first lead appear in Zoye. The whole thing takes about five minutes.

Step 1: Get an API key

Open the Zoye app and go to the Sync Users & Subscribers connector (Integrations area). It is available on the Growth plan and above.
Click Create key. Choose a publishable key (zk_pub_...) if it will live in your website source, or a secret key (zk_live_...) if it will run on your server and needs to read or search.
Copy the key. You only see a secret key once.

Which key do I need?

Sending contacts from a browser or a public form: use a publishable key. Reading, searching, or sending from a trusted backend: use a secret key. You can create several keys and revoke any of them at any time.

Step 2: Send your first contact

Pick whichever path matches your setup.

Option A: No-code embed

Paste this where you want the form to appear on your site, swapping in your publishable key. Submissions sync to Leads instantly.

HTML

<div id="zoye-contact-form"></div>
<script src="https://api.zoye.io/embed/v1/contact-form.js"
        data-zoye-key="zk_pub_YOUR_KEY"
        data-target="#zoye-contact-form"
        data-fields="name,email,phone,company"
        data-source="website-form"
        data-success="Thanks! We'll be in touch."></script>

Full options are in the No-code embed guide.

Option B: REST API

Send a single contact with one request. Put your key in the Authorization header.

curl https://api.zoye.io/public/v1/contacts \
  -H "Authorization: Bearer zk_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Jordan Rivera",
    "email": "jordan@northwind.com",
    "source": "website-form"
  }'

See every endpoint in the REST API reference.

Option C: MCP server (AI tools)

Add Zoye to Claude Code, Cursor, Windsurf, or any other MCP-compatible AI tool, then ask your assistant to create a contact in plain language.

Claude Code

claude mcp add zoye -e ZOYE_API_KEY=zk_live_YOUR_KEY -- npx -y @zoye/mcp

Full setup for every editor is in the MCP server guide.

Step 3: See it in Zoye

Open the Leads page in Zoye. Your new contact is there as a card, tagged with the source you sent. Click it to view or edit, assign it to a teammate, or ask your AI assistant to follow up. That is the entire loop: submit on your side, act on it in Zoye.

Not seeing it? Confirm the key is active in the connector, that you used the correct base URL https://api.zoye.io, and that you included at least one of email, phone, or name.