Docs
Update Rate Card
PUT /rate-cards/{rateCardId}
PUT
/rate-cards/{rateCardId}Required Tokens
| Field | Type | Required | Description |
|---|---|---|---|
| Bearer | Authorization: Bearer <api-key> | Optional | Your API key. Pass it as the Bearer token on every request. |
| Organization token | x-Organization-Token | Optional | Run **Authorize Organization** in the Authorization folder. |
Updates a card's name, minimums and clock references. A clock must be one of this card's own reset definitions.
Requires
ResourceTypeDatabase.Edit permission.Path Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| rateCardId | Guid | Required | The rate card. |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| name | string | Required | Name. |
| costMinimumAmount | decimal? | Optional | Cost money floor per span. |
| chargeMinimumAmount | decimal? | Optional | Charge money floor per span. |
| costMinimumUnits | decimal? | Optional | Cost time floor. |
| chargeMinimumUnits | decimal? | Optional | Charge time floor. |
| minimumUnitsPeriod | string | Optional | `Hour`, `Day`, `Week` or `Month`. `Flat` is not a period. |
| periodResetDefinitionId | Guid? | Optional | Clock the card's periods reset on. |
| minimumAmountResetDefinitionId | Guid? | Optional | Clock the money floor resets on. |
| minimumUnitsResetDefinitionId | Guid? | Optional | Clock the time floor resets on. |
On a composite type's card the cost side is rolled up from the components (route 18), so only charge fields apply.
Response
200 OK. No response body.
Error Codes
| HTTP Status | Description |
|---|---|
| 400 | Invalid arguments, or a clock from another card. |
| 404 | Rate card not found. |