ProposalContracts
Update ProposalContract
Update an existing ProposalContract record.
PUT
Update ProposalContract
Updates an existing ProposalContract record. You must include the
Id of the record to update along with all required fields.
Authentication
This endpoint requires OAuth2 authentication. Include a valid bearer token in the
Authorization header.
The authenticated user must be a full unrestricted administrator or have the ProposalContract-Edit role.Request Body
Required Fields
The Id of the ProposalContract record to update.
ID of the proposal linked to this record.
ID of the tariff linked to this record.
Billing day of month.
Number of units.
Optional Fields
List of desks linked to this record.
The added desks value for this proposal contract.
The removed desks value for this proposal contract.
List of variants linked to this record.
The added variants value for this proposal contract.
The removed variants value for this proposal contract.
Price override.
Contract start date.
Cancellation limit in days.
Contract term end date.
Cancellation date.
ID of the discount code linked to this record.
Code Examples
Response
200
HTTP status code.
200 on success.A human-readable message confirming the update.
Contains the
Id of the updated record.true if the proposalcontract was updated successfully.null on success.Example Response
400
A summary of the validation error(s), in the format
PropertyName: error message.null on validation failure.Array of validation errors.
false when the request fails validation.Example Response
Update ProposalContract