Update Tip Action

post

/apis/tips-v1/{utilityCode}/energy_guide/customers/{id}/tips/{tipId}/action

Updates the customer's currently recorded action for the tip. Default value for all of a customer's tips is NOT_YET.

Request

Path Parameters
Body ()
The tip action to record, for example {"status": "DONE"}.
Root Schema : TipActionUpdateRequest
Type: object
Update Tip Status
Show Source
  • Allowed Values: [ "DONE", "WILL_DO", "NO_THANKS", "NOT_YET" ]
    The status of a tip for a particular customer.
Example:
{
    "status":"WILL_DO"
}
Back to Top

Response

Supported Media Types

200 Response

Successful response
Body ()
Root Schema : TipActionUpdateResponse
Type: object
Show Source
Example:
{
    "response":true
}

400 Response

Invalid request
Body ()
Root Schema : ErrorResponse
Type: object
Show Source

401 Response

Authorization failure
Body ()
Root Schema : ErrorResponse
Type: object
Show Source

404 Response

Customer not found
Body ()
Root Schema : ErrorResponse
Type: object
Show Source

500 Response

Internal error
Body ()
Root Schema : ErrorResponse
Type: object
Show Source
Back to Top