Update a contract
PATCH {{baseUrl}}/api/v1/contracts/:contract_id
This API updates the details of an existing contract.
OAuth Scope
Desk.settings.UPDATE
Attributes
| Attribute Name | Data Type | Description |
|---|---|---|
| associatedSLAId | <long> | ID of the SLA associated with the contract |
| accountId | <long> | ID of the account associated with the contract |
| departmentId | <long> | ID of the department to which the contract belongs |
| productId | <long> | ID of the product associated with the contract |
| contractNumber | <string> max chars : 50 | Serial number of the contract |
| notificationAgentIds | <list> | List of agents to be notified |
| notifyBefore | <int> | Number of days before endDate when notifications about contract expiry must be sent to the agents concerned |
| startDate | <date> | Date from which the contract is valid |
| endDate | <date> | Date until which the contract is valid |
| ownerId | <long> | ID of the contract owner |
| contractName | <string> max chars : 80 | Name of the contract |
| description | <string> max chars : 65535 | A short description of the contract |
| customFields | <list> | User-defined fields associated with the contract |
| cf | <list> | User-defined fields associated with the contract |
| sla | <list> | SLA fields associated with the contract |
| account | <list> | Account fields associated with the contract |
| product | <list> | Product fields associated with the contract |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string |
RESPONSES
status: OK
{"associatedSLAId":"10000000062047","modifiedTime":"2018-07-24T07:33:11.728Z","product":{"id":"500000001290","productName":"Desk"},"cf":{"cf_mycustomfield1":"Some Update Value"},"productId":null,"endDate":"2019-09-15","departmentId":"10000000013228","notifyBefore":"5","contractNumber":"9496","description":"My Description Updated","sla":{"name":"Gold SLAs","id":"5000000007671"},"ownerId":"10000000012816","notificationAgentIds":["10000000012816"],"accountId":"10000000012985","createdBy":"10000000012816","notifyOn":"2019-09-10","createdTime":"2018-07-24T07:31:57.000Z","contractName":"My Updated Contract Name","modifiedBy":"10000000012816","id":"10000000082016","startDate":"2018-08-14","account":{"website":"https://www.zoho.com","accountName":"Zoho","id":"500000008909"}}