Getting started

Use the dealerMe API to keep shopper consent in sync between dealerMe and your own systems: whether each contact has agreed to be reached by email, text or phone call.

Base URL

All endpoints live under version 1 of the API:

https://api.dealerme.com/v1

Send and receive JSON. Include Accept: application/json on every request, and Content-Type: application/json when you send a body.

Making a request

Every request needs an API token, plus a header that tells dealerMe which organization the request is for. See Authentication for how to create a token and which header each endpoint expects.

DEALERME_TOKEN="your API token"
DEALERME_ORG_ID="your organization id"

curl "https://api.dealerme.com/v1/consent-management/email/consent?contact_value=jane@example.com" \
  -H "Authorization: Bearer $DEALERME_TOKEN" \
  -H "X-DealerMe-Organization-Id: $DEALERME_ORG_ID" \
  -H 'Accept: application/json'

Errors

dealerMe uses standard HTTP status codes.

A validation error looks like this:

{
  "message": "The email field is required.",
  "errors": {
    "email": ["The email field is required."]
  }
}

What's in the API