leads

Call leads.capture

Changed on

Send one lead from a form on the workspace's own website into Goosy — 'send this signup in as a lead', 'capture the demo request from our site', 'add the waitlist entry for jane@example.com'. The lead is stored, the submitter becomes the workspace's contact, the automations that start on a captured lead run, and the contact goes to the workspace's connected GoHighLevel; with no CRM connected the lead waits and is sent when one is connected. It answers with the lead's and the contact's ids, a submission_id, and any fields it ignored. To retry a call, send the same submission_id so nothing is stored twice. Not for a note on someone already a contact — that is contact.note. The contact's details reach the connected CRM and an automation may message them; this cannot be undone from here.

Every result names the workspace it ran in. Say which workspace the answer is about. When the account has more than one workspace and none is selected, this tool refuses with workspace_ambiguous and lists the choices — offer them, never pick one.

post/api/v1/tools/leads.capture

Request

  • Base URL: https://app.goosybear.ai
  • URL: https://app.goosybear.ai/api/v1/tools/leads.capture
  • Auth: HTTP bearer

Headers

x-request-idstring

Your own id for this request, echoed back and recorded on the audit trail. 1–128 characters from A–Z a–z 0–9 . _ : -, starting with a letter or digit; anything else is replaced by a generated id.

Idempotency-Keystring

Your key for this write: send the same key when you retry and the first result comes back instead of a second action. Keys are honoured for at least 24 hours. 1–200 visible ASCII characters. Replaces the idempotency_key body field, which still works until 2026-12-31.

Request body

emailstring required

The submitter's email address. Required; the contact is matched on it.

namestring

The submitter's name, as they typed it.

phonestring

The submitter's phone number; sent to the CRM in international form when it can be read as one.

formstring

Your name for the form on your site (lowercase letters, digits, - or _), e.g. newsletter or demo_request. An automation can start only on leads from one form.

fieldsobject

Every other field the form collected, by its own name, as strings. Stored with the lead as sent.

utmobject

The visit's first-touch campaign tags and click ids, when your site kept them, by their URL names: utm_source, utm_medium, utm_campaign, utm_term, utm_content, fbclid, gclid, li_fat_id. Any other key is dropped and listed in ignored_fields.

submission_idstring

Optional. An id naming this submission, also accepted as the Idempotency-Key header; with none, the answer's submission_id names it. Send the same value only when retrying the same submission: a retry returns the first answer and stores nothing again.

idempotency_keystring

Deprecated on REST: send the Idempotency-Key header instead. Still accepted until 2026-12-31; if both are sent they must match.

workspacestring

Which workspace to run in — its slug. Omit to use your default. With more than one reachable workspace and no default, the call is refused and the choices are listed.

Response

The call was admitted and dispatched. ok says whether the tool succeeded — a refusal the tool itself produced is still a 200, exactly as it is a successful JSON-RPC result over MCP.

OR

Changes