Create service trade-in reminder

POST

/api/v1/dealerships/{dealership_id}/service_trade_in_reminders

const url = 'https://dashboard.dealerstudio.com.au/api/v1/dealerships/1/service_trade_in_reminders';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"service_date":"2026-09-26","registration_number":"ABC123","vin":"JTDBR32E720123456","customer_email":"jane@example.com","customer_first_name":"Jane","customer_phone_number":"+61412345678","vehicle_model":"Camry","make":"Toyota","kms":45000,"year":2019,"sms_template_id":12}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://dashboard.dealerstudio.com.au/api/v1/dealerships/1/service_trade_in_reminders \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "service_date": "2026-09-26", "registration_number": "ABC123", "vin": "JTDBR32E720123456", "customer_email": "jane@example.com", "customer_first_name": "Jane", "customer_phone_number": "+61412345678", "vehicle_model": "Camry", "make": "Toyota", "kms": 45000, "year": 2019, "sms_template_id": 12 }'

Upserts a dealership contact and customer vehicle from a day-before-service payload, then sends the dealership’s Service Trade-In Reminder SMS template (or the platform default). Requires service_trade_in_reminder:dealership. Customise the SMS under Settings → SMS Templates (title: Service Trade-In Reminder) using [shortcodes].

Authorizations

Bearer

Parameters

Path Parameters

dealership_id

required

integer

Dealership ID

Request Body

application/json

object

service_date

required

YYYY-MM-DD or DD/MM/YYYY

string

Example

2026-09-26

registration_number

string

Example

ABC123

vin

string

Example

JTDBR32E720123456

customer_email

string

Example

jane@example.com

customer_first_name

required

string

Example

Jane

customer_phone_number

required

string

Example

+61412345678

vehicle_model

string

Example

Camry

make

required

string

Example

Toyota

kms

integer

Example

year

integer

Example

sms_template_id

Optional dealership SMS template override

integer

Example

Responses

201

Reminder created and SMS queued

application/json

object

contact_id

required

integer

contact_created

required

boolean

vehicle_id

required

integer

vehicle_created

required

boolean

text_id

required

integer

sms_body

required

string

service_date

string format: date

kms

integer

nullable

Example

{
  "contact_id": 123,
  "contact_created": true,
  "vehicle_id": 456,
  "vehicle_created": true,
  "text_id": 789,
  "sms_body": "Hi Jane, it's Coffs Harbour Toyota...",
  "service_date": "2026-09-26",
  "kms": 45000
}

403

Forbidden

application/json

object

error

required

Machine-readable code (validation_error, forbidden, not_found, not_authorized_for_dealership)

string

message

string

Example

{
  "error": "validation_error",
  "message": "customer_phone_number is required"
}

422

Validation error

application/json

object

error

required

Machine-readable code (validation_error, forbidden, not_found, not_authorized_for_dealership)

string

message

string

Example

{
  "error": "validation_error",
  "message": "customer_phone_number is required"
}