Update a customer contract

patch/customer-contracts/{customer_contract_id}

Note that once billing starts, only roll-over profile, renewal alert days, and notice period days can be edited. End date can be set to terminate and renew with a new contract prior to roll-over

SecuritybearerAuth
Request
path Parameters
customer_contract_id
required
integer <int64> (IdParam) >= 1

Customer contract identifier

Example: 1
Request Body schema: application/json-patch+json

A set of JSONPatch operations to be performed

Array
op
required
string

The JSON Patch operation to be performed

Enum: "add" "remove" "replace" "move" "copy" "test"
path
required
string

A JSON-Pointer

value
object

The value to be used within the operations

from
string

A string containing a JSON Pointer value

Responses
200

Success

400

Invalid Request

401

Unauthorized

403

Forbidden

404

Not Found

Request samples
application/json-patch+json
[
  • {
    • "op": "replace",
    • "path": "/name",
    • "value": "MyFavContractProfile"
    }
]
Response samples
application/json
{
  • "id": 1,
  • "name": "string",
  • "customerId": 0,
  • "siteId": 0,
  • "contractProfileId": 0,
  • "startDate": "2019-08-24",
  • "endDate": "2019-08-24",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "rolloverContractProfileId": 0,
  • "renewalAlertDays": 28,
  • "noticePeriodDays": 2147483647,
  • "previousCustomerContractId": 0,
  • "renewedCustomerContractId": 0
}