Skip to main content
PATCH
/
v1
/
contracts
/
{contractId}
curl --request PATCH \ --url https://api.monk.com/v1/contracts/{contractId} \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "metadata": { "salesforceOpportunityId": "006xx000001234", "team": "growth", "priority": 1, "isEnterprise": true } } '
{
  "data": {
    "id": "<string>",
    "customerId": "<string>",
    "planId": "<string>",
    "name": "<string>",
    "startDate": "2023-12-25",
    "endDate": "2023-12-25",
    "isActive": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "metadata": {}
  }
}
Set arbitrary string key-value metadata on a contract. Useful for correlating contracts with records in your own system (e.g., Salesforce opportunity IDs, internal tags). Pass metadata: null to clear all custom metadata. Limits: Max 10 keys, 40-char keys, 500-char values. Scope: contracts:write

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
contractId
string
required

The unique identifier of the contract (UUID)

Body

application/json
​
metadata
object
required

User-defined key-value metadata. Values can be strings, numbers, or booleans. Pass null to clear.

Response

Contract updated

​
data
object