Docs
Add Reset Definition
POST /rate-cards/{rateCardId}/reset-definitions
POST
/rate-cards/{rateCardId}/reset-definitionsRequired Tokens
| Field | Type | Required | Description |
|---|---|---|---|
| Bearer | Authorization: Bearer <api-key> | Optional | Your API key. Pass it as the Bearer token on every request. |
| Event token | x-Event-Token | Optional | Run **Get Tokens** in the Authorization folder, or call `GET /Events/{eventId}/authorize` manually. |
Adds a clock to the card. Rates and the card's minimums can reset on it.
Requires
EventSettings permission on the event.Event scoping: This endpoint does not include
{eventId} in the URL. The event is determined automatically from your x-Event-Token.Path Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| rateCardId | Guid | Required | The rate card. |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| name | string | Required | Clock name. |
| resetType | string | Required | `ScheduleGap`, `BlockType` or `CalendarPeriod`. |
| blockTypeId | Guid? | Optional | For `BlockType`: an existing schedule block type. |
| minDuration | decimal? | Optional | Minimum gap or block length. |
| durationUnit | string | Optional | `Hours`, `Minutes` or `Days`. |
| period | string | Optional | `Day`, `Week` or `Month`, for `CalendarPeriod`. |
| periodStartDay | string | Optional | Day the period starts on. |
Response
201 Created with { "id": "<definitionId>" }.
Error Codes
| HTTP Status | Description |
|---|---|
| 400 | Invalid arguments. |
| 404 | Rate card or block type not found. |