Skip to content
/
Accept a participation ag...

Accept a participation agreement version

Request

Record that the authenticated user has accepted the given Participation Agreement Version, identified by its UID (e.g. the id returned by the current sub-resource).

The request body must be an empty JSON object ({}). Sending any additional fields returns 400 Bad Request. The success response is 201 Created with no body. The acceptance is idempotent — repeating the call for the same (user, version) pair returns 201 without creating a duplicate acceptance record.

Requires a user-grant access token (Authorization Code or Password). The endpoint is not exposed to Client Credentials clients because acceptance is intrinsically a per-user action.

Security
oauth2(Required scopes: programs:write)
Path
program_idstringrequired

The ID of the specific Program to retrieve.

participation_agreement_version_idstringpagv[A-Z\d]{26}required

The ID of the specific Participation Agreement Version.

Example:pagv01JCDYP6Z8MX9XWVAV0A7G3KPN
Headers
EvEnergy-Versionnumber

Specify the version of this endpoint to use.

Value:2
Bodyapplication/jsonrequired
curl -i -X POST \
  'https://developers.ev.energy/_mock/ev.energy-api-v2/programs/{program_id}/participation_agreement_versions/pagv01JCDYP6Z8MX9XWVAV0A7G3KPN/accept' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'EvEnergy-Version: 2' \
  -d '{}'

Responses

The acceptance has been recorded.

Headers
EvEnergy-Versionnumber

Indicates the version of the API that generated this response. If EvEnergy-Version was not specified in the request, this will be your OAuth application's default version.

Value:2
X-RateLimit-Limitnumber

The maximum number of requests that can be made to this endpoint per hour. Defaults to 1000 but may vary per client.

Default:1000
X-RateLimit-Remainingnumber

The number of requests remaining until this client's rate limit is reached.

Default:999
RetryAfternumber

The number of seconds until this client's requests will not be rate limited.

Default:3600
Response
No content