Updates a WebCAPture account.
A partial update: send only the fields you want to change, as anything omitted (or null) keeps its
current value. Because null means “leave unchanged” it cannot also mean “clear”, so
billCaptureClientCode cannot be emptied through this endpoint. Neither the account’s WebCAPture
partner nor its identifier can be changed; supplying either with a different value is rejected,
though echoing back the current value is permitted.
Request Headers
| Header | Value | Required | Description |
|---|---|---|---|
| ECI-ApiKey | string | Yes | Your API key. See Authentication. |
| Content-Type | application/json | Yes | All requests must specify JSON content type, including the request body. |
Path Parameters
| Name | Description | Type | Required |
|---|---|---|---|
| webCaptureAccountId | The EnergyCAP identifier of the account to update. | integer (int32) | Required |
Request Body
WebCaptureAccountUpdateRequestV202606
| Property | Description | Type |
|---|---|---|
| accountNumber | The utility account number, as it appears on the bill. Omit to leave unchanged. Max length of 64 Required (defined) | string |
| billCaptureClientCode | The Bill CAPture client code this account belongs to. Omit to leave unchanged. Max length of 32 Required (defined) | string |
| externalAccountId | The partner’s own identifier for this account (Deck’s account_id, Arcadia’s account id).
Omit to leave unchanged. Max length of 128 Required (defined) |
string |
| externalProviderId | The partner’s identifier for the utility provider this account belongs to. Omit to leave unchanged. Max length of 128 Required (defined) | string |
| externalStatus | The account status as reported by the partner. Omit to leave unchanged. Max length of 32 Required (defined) | string |
| externalStatusDetail | Additional detail for the partner-reported status. May be empty. Omit to leave unchanged. Max length of 128 Required (defined) | string |
| isExternalAccountEnabled | Whether bills are being retrieved for this account. Omit to leave unchanged. Required (defined) | boolean |
| providerName | The name of the utility provider this account belongs to. Omit to leave unchanged. Max length of 128 Required (defined) | string |
| webCaptureAccountId | Not updatable. The account to update is identified by the route, and its identifier cannot be changed. Omit this property, or send the same value as the route. Required (defined) | integer (int32) |
| webCapturePartnerId | Not updatable. Omit this property; supplying it is rejected. An account cannot be moved to a different WebCAPture partner. Required (defined) | integer (int32) |
Example Request Body
{ "accountNumber": "string", "billCaptureClientCode": "string", "externalAccountId": "string", "externalProviderId": "string", "externalStatus": "string", "externalStatusDetail": "string", "isExternalAccountEnabled": false, "providerName": "string", "webCaptureAccountId": 1, "webCapturePartnerId": 1
}Responses
200
OK
The request succeeded and the response body contains the requested data.
Response Body Parameters
WebCaptureAccountResponseV202606
| Property | Description | Type |
|---|---|---|
| accountNumber | The utility account number, as it appears on the bill. | string |
| billCaptureClientCode | The Bill CAPture client code this account belongs to. Null when not set. | string |
| externalAccountId | The partner’s own identifier for this account. | string |
| externalProviderId | The partner’s identifier for the utility provider this account belongs to. | string |
| externalStatus | The account status as reported by the partner. | string |
| externalStatusDetail | Additional detail for the partner-reported status. | string |
| isExternalAccountEnabled | Whether bills are being retrieved for this account. | boolean |
| providerName | The name of the utility provider this account belongs to. | string |
| webCaptureAccountId | EnergyCAP’s identifier for this account. Use it in PUT /api/v202606/webCaptureAccount/{webCaptureAccountId}. Distinct from ExternalAccountID, which is the partner’s identifier. | integer (int32) |
| webCapturePartnerId | The WebCAPture partner this account came from. | integer (int32) |
Example Response
{ "accountNumber": "string", "billCaptureClientCode": "string", "externalAccountId": "string", "externalProviderId": "string", "externalStatus": "string", "externalStatusDetail": "string", "isExternalAccountEnabled": false, "providerName": "string", "webCaptureAccountId": 1, "webCapturePartnerId": 1
}
400
webCapturePartnerId or webCaptureAccountId was supplied with a value that would change it; neither can be changed.
The request was malformed or contains invalid parameters. Check the request body and query parameters.
404
The account does not exist or is not accessible.
The requested resource was not found. Verify the ID or path is correct.
409
The supplied values would collide with another account for this partner.
The request conflicts with the current state of the resource.