POST
/
vehicles
/
{id}
/
charge
curl "https://api.smartcar.com/v2.0/vehicles/{id}/charge" \
    -H "Authorization: Bearer {token}" \
    -X "POST" \
    -H "Content-Type: application/json" \
    -d '{"action": "START"}'
    {

        "message": "Successfully sent request to vehicle",

        "status": "success"

    }   

Permission

control_charge

Request

Path

id
string
required

The vehicle ID of the vehicle you are making a request to.

Body

action
string
required

START or STOP the vehicle charging.

curl "https://api.smartcar.com/v2.0/vehicles/{id}/charge" \
    -H "Authorization: Bearer {token}" \
    -X "POST" \
    -H "Content-Type: application/json" \
    -d '{"action": "START"}'

Response

status
string

If the request is successful, Smartcar will return “success”.

message
string

If the request is successful, Smartcar will return a message.

    {

        "message": "Successfully sent request to vehicle",

        "status": "success"

    }   

Notes

BMW and MINI
Vehicle needs to be on OS Version 8+

Ford and Lincoln
Issuing a start command while the vehicle has a schedule in place for its current charging location will result in the vehicle charging to 100%.

Please see charge schedule by location for details on setting a charge limit with preferred charging times or clearing schedules.

Nissan
Currently only START charge commands are supported in the US. See Set Charge Schedule for details on setting a charge schedule for Nissan vehicles.

Chevrolet, GMC, Buick and Cadillac
These vehicles require a minimum charge of 50% in order to be able to start or stop charging via the API.

Was this page helpful?