> ## Documentation Index > Fetch the complete documentation index at: https://docs.goosybear.ai/llms.txt > Use this file to discover all available pages before exploring further. # Call leads.capture > 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. ## OpenAPI ````yaml /openapi.json post /api/v1/tools/leads.capture openapi: 3.1.0 info: title: Goosy Bear API version: 1.0.0-beta summary: Manage workspace content, projects, Data tables, Pages, library and credits. description: >- BETA. This API is in beta: paths, request shapes and response envelopes may change, and every response carries an `x-goosy-api: beta` header for as long as that is true. A change is additive, or it is deprecated first: a response to a call that uses a deprecated feature carries `Deprecation` and `Sunset` headers, and nothing is removed until at least 90 days after its deprecation. Pin the OpenAPI document you generated against and re-generate when it changes. servers: - url: https://app.goosybear.ai description: Production security: - tenantApiKey: [] paths: /api/v1/tools/leads.capture: post: tags: - leads summary: Call leads.capture description: >- 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. operationId: call_leads_capture parameters: - name: x-request-id in: header required: false description: >- 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. schema: type: string maxLength: 128 - name: Idempotency-Key in: header required: false description: >- 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. schema: type: string maxLength: 200 requestBody: required: true content: application/json: schema: type: object properties: email: type: string description: >- The submitter's email address. Required; the contact is matched on it. name: description: The submitter's name, as they typed it. type: string maxLength: 200 phone: description: >- The submitter's phone number; sent to the CRM in international form when it can be read as one. type: string maxLength: 64 form: description: >- 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. type: string maxLength: 64 fields: description: >- Every other field the form collected, by its own name, as strings. Stored with the lead as sent. type: object propertyNames: type: string maxLength: 100 additionalProperties: type: string maxLength: 4000 utm: description: >- 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. type: object propertyNames: type: string maxLength: 32 additionalProperties: type: string maxLength: 512 consent: description: >- What the submitter agreed to, recorded with the lead as sent. type: object properties: email: description: The submitter agreed to email. type: boolean sms: description: >- The submitter agreed to text messages at the phone given. type: boolean text: description: The consent wording the submitter saw. type: string maxLength: 4000 additionalProperties: false submission_id: description: >- 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. type: string minLength: 1 maxLength: 200 idempotency_key: type: string minLength: 1 maxLength: 200 description: >- Deprecated on REST: send the `Idempotency-Key` header instead. Still accepted until 2026-12-31; if both are sent they must match. workspace: description: >- 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. type: string minLength: 1 required: - email additionalProperties: {} responses: '200': description: >- 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. headers: x-goosy-api: description: Present while this API is in beta; the value is `beta`. schema: type: string const: beta x-request-id: description: >- This request's id: the `x-request-id` you sent when it was well formed, otherwise one generated for you. Quote it to support; it is recorded on every audit row the call wrote. schema: type: string RateLimit-Limit: description: Requests this key may make in a rolling minute. schema: type: integer minimum: 1 RateLimit-Remaining: description: Requests left in the current rolling minute. schema: type: integer minimum: 0 RateLimit-Reset: description: Whole seconds until the window frees more requests. schema: type: integer minimum: 1 x-goosy-tool-error: description: >- `true` when a boundary step refused the call — workspace resolution failed or could not be read. A tool that ran and returned its own typed `ok: false` reports `false` here. **Branch on `ok` in the body for the outcome; this header is the transport-level hint.** schema: type: string enum: - 'true' - 'false' content: application/json: schema: oneOf: - type: object description: The tool ran and answered. properties: ok: type: boolean const: true lead_id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ contact_id: anyOf: - type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ - type: 'null' submission_id: type: string replayed: type: boolean ignored_fields: type: array items: type: string workspace: type: string description: The slug of the workspace this call ran in. working_in: type: object properties: label: type: string description: 'The chip words — e.g. "working in: Acme Main".' note: type: string description: >- Why this workspace — e.g. "your default", "this call only". workspace: type: string description: The resolved workspace's slug. source: type: string enum: - call-override - key-pin - stored-default - sole-reachable description: >- Which rung of the R7 precedence resolved the workspace. required: - label - note - workspace - source description: >- Which workspace this call ran in, and how that was decided. Present on every workspace-scoped result. additionalProperties: false required: - ok - contact_id - ignored_fields - lead_id - replayed - submission_id - working_in - workspace - $ref: '#/components/schemas/ToolRefusal' '400': description: >- The request could not be used: the body is present but not a JSON object (`tenant_api.malformed_body`); it is a top-level array carrying more messages than this endpoint accepts (`tenant_mcp.batch_too_large`); or the `Idempotency-Key` header is malformed (`tenant_api.idempotency_key_invalid`), disagrees with the body's `idempotency_key` (`tenant_api.idempotency_key_conflict`), or was sent to an action that cannot replay a retry (`tenant_api.idempotency_unsupported`). Nothing ran. headers: x-goosy-api: description: Present while this API is in beta; the value is `beta`. schema: type: string const: beta x-request-id: description: >- This request's id: the `x-request-id` you sent when it was well formed, otherwise one generated for you. Quote it to support; it is recorded on every audit row the call wrote. schema: type: string Deprecation: description: >- RFC 9745: this refusal's nested `error` object is deprecated, since this instant (`@`). schema: type: string Sunset: description: >- RFC 8594: the nested `error` object may be removed after this date (2026-12-31). schema: type: string Link: description: The page that says what to read instead (`rel="deprecation"`). schema: type: string RateLimit-Limit: description: Requests this key may make in a rolling minute. schema: type: integer minimum: 1 RateLimit-Remaining: description: Requests left in the current rolling minute. schema: type: integer minimum: 0 RateLimit-Reset: description: Whole seconds until the window frees more requests. schema: type: integer minimum: 1 content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: >- No bearer credential, or one that did not resolve. Deliberately ONE undifferentiated answer for absent / unknown / revoked / expired, so the endpoint is never an oracle over the key space. headers: x-goosy-api: description: Present while this API is in beta; the value is `beta`. schema: type: string const: beta x-request-id: description: >- This request's id: the `x-request-id` you sent when it was well formed, otherwise one generated for you. Quote it to support; it is recorded on every audit row the call wrote. schema: type: string Deprecation: description: >- RFC 9745: this refusal's nested `error` object is deprecated, since this instant (`@`). schema: type: string Sunset: description: >- RFC 8594: the nested `error` object may be removed after this date (2026-12-31). schema: type: string Link: description: The page that says what to read instead (`rel="deprecation"`). schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: >- The credential is good but the surface is not open to it — the platform or account API switch is off, or the holder lacks the `api.access` capability. The `code` says which. headers: x-goosy-api: description: Present while this API is in beta; the value is `beta`. schema: type: string const: beta x-request-id: description: >- This request's id: the `x-request-id` you sent when it was well formed, otherwise one generated for you. Quote it to support; it is recorded on every audit row the call wrote. schema: type: string Deprecation: description: >- RFC 9745: this refusal's nested `error` object is deprecated, since this instant (`@`). schema: type: string Sunset: description: >- RFC 8594: the nested `error` object may be removed after this date (2026-12-31). schema: type: string Link: description: The page that says what to read instead (`rel="deprecation"`). schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: >- No such tool. The body names no tool and is identical for every unrecognised name. headers: x-goosy-api: description: Present while this API is in beta; the value is `beta`. schema: type: string const: beta x-request-id: description: >- This request's id: the `x-request-id` you sent when it was well formed, otherwise one generated for you. Quote it to support; it is recorded on every audit row the call wrote. schema: type: string Deprecation: description: >- RFC 9745: this refusal's nested `error` object is deprecated, since this instant (`@`). schema: type: string Sunset: description: >- RFC 8594: the nested `error` object may be removed after this date (2026-12-31). schema: type: string Link: description: The page that says what to read instead (`rel="deprecation"`). schema: type: string RateLimit-Limit: description: Requests this key may make in a rolling minute. schema: type: integer minimum: 1 RateLimit-Remaining: description: Requests left in the current rolling minute. schema: type: integer minimum: 0 RateLimit-Reset: description: Whole seconds until the window frees more requests. schema: type: integer minimum: 1 content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: >- Over this key's per-minute cap. Carries `Retry-After` and `error.retry_after_seconds`. headers: x-goosy-api: description: Present while this API is in beta; the value is `beta`. schema: type: string const: beta x-request-id: description: >- This request's id: the `x-request-id` you sent when it was well formed, otherwise one generated for you. Quote it to support; it is recorded on every audit row the call wrote. schema: type: string Deprecation: description: >- RFC 9745: this refusal's nested `error` object is deprecated, since this instant (`@`). schema: type: string Sunset: description: >- RFC 8594: the nested `error` object may be removed after this date (2026-12-31). schema: type: string Link: description: The page that says what to read instead (`rel="deprecation"`). schema: type: string RateLimit-Limit: description: Requests this key may make in a rolling minute. schema: type: integer minimum: 1 RateLimit-Remaining: description: Requests left in the current rolling minute. schema: type: integer minimum: 0 RateLimit-Reset: description: Whole seconds until the window frees more requests. schema: type: integer minimum: 1 Retry-After: description: Whole seconds to wait before retrying. schema: type: integer minimum: 1 content: application/json: schema: $ref: '#/components/schemas/Error' components: schemas: ToolRefusal: type: object properties: ok: type: boolean const: false code: type: string description: >- The typed reason — e.g. `workspace_ambiguous`, `invalid_arguments`, or the tool's own failure code. message: type: string description: A sentence a person can act on. workspaces: description: 'On a workspace refusal: the slugs this key may pass as `workspace`.' type: array items: type: string issues: description: 'On `invalid_arguments`: which fields failed, and why.' type: array items: type: object properties: path: type: string message: type: string required: - path - message additionalProperties: false path: description: >- On an authoring refusal: where in your call's input it points, e.g. `steps..params.`. type: string fix: description: 'On an authoring refusal: the change to your call that would pass.' type: string instruction: description: 'On an authoring refusal: what to do next with it.' type: string required: - ok - code - message description: A call that was admitted and dispatched, and did not succeed. additionalProperties: false Error: type: object properties: ok: type: boolean const: false code: type: string description: >- The typed refusal code — e.g. `tenant_mcp.surface_disabled`, `tenant_mcp.rate_limited`. message: type: string description: A sentence a person can act on. retry_after_seconds: description: 'On a 429: whole seconds to wait. Mirrors `Retry-After`.' type: number error: type: object properties: code: type: string message: type: string retry_after_seconds: type: number required: - code - message description: >- Deprecated: the same values as the top-level fields, kept until 2026-12-31. Read `code` and `message` at the top level. additionalProperties: false required: - ok - code - message - error description: >- A request the boundary refused before dispatching anything. The same shape the MCP endpoint answers its own refusals with, and the same top-level fields a dispatched call's refusal carries, so one client branch covers both. additionalProperties: false securitySchemes: tenantApiKey: type: http scheme: bearer description: >- An API key minted at Settings › API & MCP. Send it as `Authorization: Bearer `. A key carries its holder's own permissions, resolved on every call — revoking a membership closes the key's reach immediately. Keep it in an environment variable (`GOOSY_API_KEY`), never in a committed file. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.