Chargeprice API Documentation

POST /v1/user_feedback

Send different kinds of user feedback to the Chargeprice Team.

This API follows the https://jsonapi.org specification.

Headers

Authorization Group

WriteUserFeedback

Request

The following types of feedback can be sent:

All of these types have the following generic and required attributes. In brackets the max. length of the string.

Attributes per type

All of them are of type string and are mandatory (but can have an empty value). In brackets the max. length of the string.

Example

Request

POST http://example-base-url.com/v1/user_feedback
Content-Type: application/json
Api-Key: my-secret-key

{
  "data": {
    "type": "other_feedback",
    "attributes": {
      "email": "test@test.at",
      "context": "FR, Tesla Model 3, 20-80%",
      "notes": "Hello Chargeprice!",
      "language": "en"
    }
  }
}

Response

204 No Content

Empty response.

400 Bad Request

Client provided invalid request body.

{
  "errors": [
    {
      "status": "400",
      "title": "..."
    }
  ]
}
403 Forbidden
{
  "errors": [
    {
      "status": "403",
      "title": "api_key missing"
    }
  ]
}
500 Internal Server Error

An unexpected error happened.

{
  "errors": [
    {
      "status": "500",
      "title": "some error"
    }
  ]
}