Skip to content

Start here

MarsX Dashboard is where a brand’s dealers follow up customer enquiries. Your company collects those enquiries first. It may use a website chat, a web form, a marketplace or an advert. Each enquiry is a lead.

This site shows how to pass your leads to MarsX. You choose one of three routes. All three carry the same details and follow the same rules.

Not sure which route fits? Write to fjrgumilang@gmail.com. Say what your system can and cannot do. MarsX will advise.

Using an AI coding agent?

Paste this prompt into your agent. It points the agent at this documentation and sets the rules for the whole job. You can also read it as plain text at /agent-prompt.txt.

The sandbox (api-sandbox.marsx.media) opens when MarsX sends your connection details. The live address (api.marsx.media) opens at go-live.

Read the prompt
You are helping us connect our system to the MarsX Lead Intake API, so that our customer enquiries reach MarsX Dashboard. Treat these two documents as the only source of truth, and do not guess beyond them: https://docs.marsx.media/llms-full.txt and https://docs.marsx.media/openapi.yaml. If we have not yet received sandbox details from MarsX, stop after reading the documents and planning the work.

1. First ask me which route we use: automatic sending (each lead as it happens), automatic file upload (one Excel file each working day), or upload by staff (a person uploads the file, so no code is needed).
2. When MarsX has sent our sandbox connection details, build and test against the sandbox first, https://api-sandbox.marsx.media, with invented data only. Keep the base URL, connection reference and keys in configuration, so going live is a configuration change, not new code.
3. Sign every request exactly as the "Sign the request" section of the Automatic sending page describes, and prove your code against its worked examples before sending anything.
4. Only a 202 answer means MarsX accepted an event. Only a 201 answer means MarsX stored a file. Retry exactly as documented, with the same webhook-id.
5. Send withdrawals and deletions as soon as the customer asks. With automatic sending, send each as its own event straight away. With a file route, send a file within 24 hours of the request.
6. For automatic sending, also build the three read-only endpoints that MarsX calls to catch missed leads.
7. Keys come from MarsX through a one-time secure link. Ask me for them. Never hard-code them, never log them, and never log customer data.
8. Run every sandbox test case on the Testing and going live page, show me the results, and send them to MarsX as that page describes.
9. Go live only after MarsX confirms in writing that the sandbox tests passed and sends the production connection reference and keys through a new one-time secure link. Then switch the configuration to https://api.marsx.media, send the first real lead, and confirm with me and MarsX that it arrived. With automatic sending, use the status check. With a file route, MarsX emails the outcome. Sandbox keys never work in production, and production keys never go into the sandbox.

Ask me before making any assumption that the documentation does not settle.
A lead's journey, from enquiry to dealer.
  1. You

    A customer asks about a vehicle

    Your system or your team records the enquiry and gives it a lead ID.

  2. You

    You send it to MarsX

    Automatically, or in the daily file. Either way, MarsX can check that it came from you.

  3. MarsX

    MarsX checks it

    It checks who sent it and that the details are complete.

  4. MarsX

    MarsX stores it safely

    MarsX confirms that it holds the lead. Dealers cannot see it yet.

  5. MarsX

    MarsX applies it

    It keeps the newest version of the lead. Withdrawals and deletions go first.

  6. MarsX

    The brand's dealers follow up

    The lead appears in MarsX Dashboard. Dealers record the result there. MarsX never writes anything back to you.

  7. You

    You can read the result

    Automatic senders can ask for the outcome. File senders get an email.

Three things to remember:

  • You never send sales results. Dealers record them in MarsX Dashboard.
  • A customer who withdraws consent or asks for deletion is urgent on every route.
  • MarsX keeps the newest version of each lead. A number called the revision decides which version is newest.

This site is public. It holds no secrets. MarsX sends the private items to your company’s technical contact. That is the person who deals with MarsX for your company. The items are:

  • the connection reference: the label for your company’s link with MarsX, one for testing and one for live use
  • the signing key, for the two automatic routes
  • the sign-in details of the upload account, for upload by staff

Keys never travel in an email or a WhatsApp message. MarsX sends them through a one-time secure link.

Write to the MarsX technical contact: fjrgumilang@gmail.com. If an error came back, quote the instance reference in it. See contact and support.