Related Articles
Public API Lead Source
Quick Reference Keywords: Public API · API keys · Create lead via API · Journey rules · Submission history
Overview
The Public API lead source lets external systems create contacts and opportunities in brayv.ai using authenticated API requests, and keep those contacts up to date afterwards. Configure it at Settings → Lead Sources → Public API (or choose Public API from Add New Source on the Lead Sources hub).
Developer reference for each endpoint:
- Lead Submission API — create a lead (contact + journey routing)
- Contact Update API — update an existing contact without creating a lead
- Custom Fields API — list the account's custom field IDs for use in either
Tabs
API Keys
- Click Create Key
- Enter a name (e.g.
Angi,Partner CRM) - Copy the secret immediately — it is shown once
- Use Revoke when a key should no longer work
A key authorizes every public API endpoint for this account, not just lead submission: the same key can submit leads, update existing contacts, and look up custom fields. Revoking it stops all three at once, so use one named key per external system.
Organization admins can also create organization-level keys from the Organization Dashboard. Those work the same way for every account linked to the organization.
Store keys in your server or secret manager. Never put them in client-side website JavaScript.
Journey Rules
- Toggle Add to Customer Journey when API submissions should create opportunities
- Configure Journey Rules and a Default Journey (same pattern as other lead sources)
- Click Save Changes
Notifications
- Enable Notifications for new API submissions
- Choose In-App Notifications and/or Email Notifications
- Save Changes
Assignment
Optional contact-owner routing using the same assignment script builder as webhooks and forms:
- Set Up Assignment Rules / Edit Rules
- Test Script and View Flow Chart
- Save Changes
See Lead Assignment for how to write and test assignment rules.
Submission History
Browse recent API submissions and open the created contact with View contact.
Typical Setup Flow
- Create an API key and store it securely
- Configure journey rules (which journey new leads enter)
- Optionally enable notifications and assignment
- Point your integration at the brayv public lead API using the key
- Verify a test payload appears under Submission History
Testing with your own team members: if a submission matches a contact linked to one of your team members, their first name, last name, full name, email, and phone are left alone — everything else on the submission still saves. That's what lets your team run real end-to-end tests with throwaway details. See Internal Staff Contacts.