Post API

Post API is the handoff. It’s where you get the address your partner sends leads to, the page that explains it to their developer, and the controls over what they’re allowed to send. Every vendor has this tab, inbound and outbound alike.

Leads that arrive land in this vendor’s own list, under Contacts → Vendor Lists. That list is a record of what the vendor sent you, not a dial queue — no campaign can draw from it. To actually dial those leads you link a GoHighLevel smart list built on the vendor’s Codename; Vendor Lists walks through it.

Posting endpoint

The read-only field is the address to give your lead vendor. Copy URL puts it on your clipboard.

You’ll usually send the page instead of the bare address: Open printable instructions ↗ shows it, and Copy instructions link gets you a link to email over. It’s a self-contained handoff — the address, the fields you accept, the answers they’ll get back, and a worked example — written for their developer, so you don’t have to explain any of it.

What’s on the page you send

• Post URL — where to send leads.
• Required — every lead needs a valid phone number. It must be a 10-digit US or toll-free number; extensions and international numbers are turned away.
• Accepted fields — exactly the fields you’ve left on below, and nothing else.
• Duplicate & do-not-call handling — written to match your On duplicate choice on General, and stating that do-not-call numbers are always rejected.
• Response — the answer codes their system gets back, including the ones you’ll see on Activity.
• Example and a link to their own Results log.

The page carries the key, so the link is a credential. Send it to the partner and nowhere else.

Post key

The secret in the address. Regenerate replaces it, after a confirmation that names the vendor and spells out the cost:

{vendor} stops being able to send you leads the moment you do this — every lead they send is turned away until they start using the new link. The posting link, the printable instructions and the results log you have already given them all stop working, as does any live-transfer availability check they run.

The old key can’t be brought back, so copy the new links from this page and send them straight away.

While they keep using the old link, the vendor looks silent, not broken

A post that arrives with a key you no longer recognise is turned away before it’s recorded, so it never reaches Activity. You don’t get a run of errors to spot — you get an empty log, which reads exactly like a partner who stopped sending.

Regenerate when a link has gone somewhere it shouldn’t, or when you’ve ended a relationship and want the address dead. Note that duplicating a vendor already gives the copy a key of its own, so there’s no need to rotate for that.

Results log

A read-only page your partner can open themselves to check their recent posts — the last 100, newest first. Each line shows when the post arrived, the answer code and what it means, and the phone’s last 4 digits. Opening a line shows what was read from that post: the state, city and ZIP they sent, their own reference, source and tracking id, and the address their system posted from. The full phone number is never stored, and the contact’s name and email are never on the page.

It exists so their developer can debug their own integration without going through you, and anyone with the link sees all of that — so hand it to the partner who sent you those leads, and no one else. Open results log ↗ to see what they see; Copy results link to send it. Like the others, it contains the key.

Accepted fields

Which fields this vendor may send. Turned-off fields are ignored on every post — never saved to the contact — and don’t appear in the vendor’s instructions at all. The counter in the corner shows how many are on.

phone is always required and can’t be turned off. The rest are yours to choose:

Field	What it is
email	Email address
first_name · last_name · name	The contact’s name — name is only used when first and last aren’t sent
address · city · state · zipcode · country	Where they are — state and zipcode also drive routing
company · gender · website · timezone · date_of_birth	Everything else

Turn one off when a partner sends you data you’d rather not store, or shouldn’t be trusted to set. Ticks stage; Save changes in the header commits them, and the partner’s instructions page updates with them.

Archiving a vendor kills every link on this tab

An archived vendor’s posting instructions and results log both go dead, and anyone opening a link you handed out earlier just sees that it’s invalid or expired — there’s no explanation, and no way for them to tell it apart from a mistyped address. Tell the partner before you archive, or deactivate the vendor instead: a deactivated vendor keeps its pages working while it turns the leads away.