# MarsX Lead Intake API

> Public documentation for partners that send customer enquiries (leads) to MarsX Dashboard. There are three routes. Upload by staff: named people fill in an Excel template and upload it in a MarsX account. Automatic file upload: a system makes the same file and uploads it with a signature. Automatic sending: a system sends each lead as it happens. All three carry the same fields and follow the same rules. The sandbox (api-sandbox.marsx.media) opens when MarsX sends your connection details. The live address (api.marsx.media) opens at go-live. Technical questions: fjrgumilang@gmail.com.

Every page below is also served as Markdown at its own address. The pages are generic: they name no brand, client or vendor, and every example value is made up.

## Start here

- [Start here](https://docs.marsx.media/index.md): How to send customer enquiries to MarsX Dashboard. Pick one of three routes: upload by staff, automatic file upload or automatic sending.

## Choose your route

- [Upload by staff](https://docs.marsx.media/upload-by-staff.md): For the people who upload the daily file. Get an account, fill in the Excel template, upload it, read the result and handle a withdrawal or deletion. No code needed.
- [Automatic file upload](https://docs.marsx.media/automatic-file-upload.md): For engineers whose system makes the daily Excel file. Make the file, name it, sign the upload, read the answers, and handle gaps and resupply.
- [Automatic sending](https://docs.marsx.media/automatic-sending.md): For engineers. Send each lead event to MarsX as it happens: the endpoint, signing with worked examples, answers and retries, withdrawals and deletions, the status check, the three read-only pages for missed leads, and changing your key.

## Testing and going live

- [Testing and going live](https://docs.marsx.media/testing-and-going-live.md): Use the sandbox to send a first test lead, run the test cases MarsX expects, and follow the go-live steps to the live connection.

## Reference

- [Lead fields](https://docs.marsx.media/reference/lead-fields.md): The body of a lead event: the envelope, the four event types and the 36 fields, with the format of each and whether it is required for new, update, withdraw and delete.
- [Excel template columns](https://docs.marsx.media/reference/template-columns.md): The sheets and the 36 columns of the MarsX lead intake Excel template, version 1.2: plain titles, system names, colour key, dropdown labels and a filled example row.
- [Errors](https://docs.marsx.media/reference/errors.md): Every answer the MarsX Lead Intake API gives: status codes and what to do, the problem details format, the order of checks, why the 401 is generic and the problem types.
- [Limits](https://docs.marsx.media/reference/limits.md): Every size, rate, time and retention limit of the MarsX Lead Intake API in one place: body sizes by route, request rates, the clock window, retries, tokens and notice periods.
- [Glossary](https://docs.marsx.media/reference/glossary.md): Every technical term used in the MarsX Lead Intake API documentation, explained in everyday words.
- [Changelog](https://docs.marsx.media/changelog.md): Released changes to the MarsX Lead Intake API contract, the Excel template and this documentation site, and how versions change.
- [Contact and support](https://docs.marsx.media/reference/contact-and-support.md): Who to write to about the MarsX Lead Intake API, what to include, how MarsX announces incidents and maintenance, and how to report a security concern.
- [API reference](https://docs.marsx.media/api-reference/): The full API contract, rendered from the OpenAPI file. Interactive. For the plain contract, use openapi.yaml.

## Optional

- [openapi.yaml](https://docs.marsx.media/openapi.yaml): The API contract, OpenAPI 3.1.
- [Excel template, version 1.2](https://docs.marsx.media/downloads/marsx-lead-intake-template-v1.2.xlsx): The workbook for the two file routes.
- [Template label map, version 1.2](https://docs.marsx.media/downloads/marsx-lead-intake-template-v1.2-labels.json): Maps each dropdown label of the template to its code.
- [agent-prompt.txt](https://docs.marsx.media/agent-prompt.txt): A ready-made prompt for an AI coding agent that does the whole integration.
- [llms-full.txt](https://docs.marsx.media/llms-full.txt): Every page above, joined into one Markdown file.
- [security.txt](https://docs.marsx.media/.well-known/security.txt): Contact for security reports.