Set Charging Profile

POST /v3/chargers/{charger}/actions/charging-profile

Set Charging Profile

cURL

curl --request POST \
  --url https://app.plugchoice.com/api/v3/chargers/{charger}/actions/charging-profile \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "connector_id": 123,
  "charging_profile": {
    "charging_profile_id": 123,
    "transaction_id": 123,
    "stack_level": 123,
    "charging_profile_purpose": "<string>",
    "charging_profile_kind": "<string>",
    "recurrency_kind": "<string>",
    "valid_from": "<string>",
    "valid_to": "<string>",
    "charging_schedule": {
      "duration": 123,
      "start_schedule": "<string>",
      "charging_rate_unit": "<string>",
      "charging_schedule_period": [
        {
          "start_period": 123,
          "limit": 123,
          "number_phases": 123
        }
      ],
      "min_charging_rate": 123
    }
  }
}
'

200

{
  "status": "<string>"
}

Sends a SetChargingProfile command to the charger. Supports the full OCPP 1.6 SetChargingProfile structure including ChargePointMaxProfile, TxDefaultProfile, and TxProfile purposes.

charger · string · required

The UUID of the charger.

connector_id · integer · required

The connector ID. Use 0 for the charge point level, or a positive integer for a specific connector.

charging_profile · object · required

The charging profile to set.

Show charging_profile

charging_profile_id · integer · required

Unique identifier for the charging profile.

transaction_id · integer

Transaction ID. Only applicable for TxProfile purpose.

stack_level · integer · required

Priority level of the profile in the stack. Must be 0 or greater.

charging_profile_purpose · string · required

Purpose of the profile. One of ChargePointMaxProfile, TxDefaultProfile, or TxProfile.

charging_profile_kind · string · required

Kind of schedule. One of Absolute, Recurring, or Relative.

recurrency_kind · string

Recurrency period. One of Daily or Weekly. Only applicable for Recurring kind.

valid_from · string

Start of profile validity as an ISO 8601 date-time.

valid_to · string

End of profile validity as an ISO 8601 date-time.

charging_schedule · object · required

The charging schedule.

Show charging_schedule

duration · integer

Duration of the schedule in seconds.

start_schedule · string

Start of the schedule as an ISO 8601 date-time.

charging_rate_unit · string · required

Unit of rate. Either A (Amperes) or W (Watts).

charging_schedule_period · object[] · required

List of schedule periods. At least one period is required.

Show period

start_period · integer · required

Start of the period in seconds from the schedule start. Must be 0 or greater.

limit · number · required

The charging rate limit for this period. Must be 0 or greater.

number_phases · integer

The number of phases to use. Between 1 and 3.

min_charging_rate · number

Minimum charging rate supported.

Response

status · string

The response status from the charger (e.g., Accepted, Rejected).