Skip to main content
POST
/
v1
/
contracts
/
updateNamedSchedule
Update a contract's named schedule
curl --request POST \
  --url https://api.metronome.com/v1/contracts/updateNamedSchedule \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "customer_id": "9b85c1c1-5238-4f2a-a409-61412905e1e1",
  "contract_id": "d7abd0cd-4ae9-4db7-8676-e986a4ebd8dc",
  "schedule_name": "my-schedule",
  "starting_at": "2022-02-01T00:00:00Z",
  "ending_before": "2022-02-15T00:00:00Z",
  "value": {
    "my_key": "my_value"
  }
}'

Authorizations

​
Authorization
string
header
required

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

Body

application/json

The customer, contract, schedule name, date range, and value to set.

​
customer_id
string<uuid>
required

ID of the customer whose named schedule is to be updated

​
contract_id
string<uuid>
required

ID of the contract whose named schedule is to be updated

​
schedule_name
string
required

The identifier for the schedule to be updated

​
starting_at
string<date-time>
required
​
value
any
required

The value to set for the named schedule. The structure of this object is specific to the named schedule.

​
ending_before
string<date-time>

Response

200

Success

⌘I