Docs

Add Modifier

POST /resourceTypes/{resourceTypeId}/attributes/{resourceAttributeId}/modifiers

POST/resourceTypes/{resourceTypeId}/attributes/{resourceAttributeId}/modifiers

Required Tokens

FieldTypeRequiredDescription
BearerAuthorization: Bearer <api-key>OptionalYour API key. Pass it as the Bearer token on every request.
Organization tokenx-Organization-TokenOptionalRun **Authorize Organization** in the Authorization folder.

Adds a price modifier to a placed Modifier attribute. A need or resource whose value matches value has its price adjusted. Modifiers are deleted with their placement.

Requires ResourceTypeDatabase.Edit permission.

Path Parameters

FieldTypeRequiredDescription
resourceTypeIdGuidRequiredThe resource type.
resourceAttributeIdGuidRequiredAn attribute placed on the type with `pricingRole` `Modifier`.

Request Body

FieldTypeRequiredDescription
valuestringRequiredThe attribute value the modifier applies to (an option id for Select).
costTypestringRequired`Percent` or `Fixed`.
costAmountdecimalRequiredCost adjustment.
chargeTypestringRequired`Percent` or `Fixed`.
chargeAmountdecimalRequiredCharge adjustment.
applicationstringOptional`PerPeriod` or `OneTime`. Null means `PerPeriod`.

Response

201 Created. No response body.

Error Codes

HTTP StatusDescription
400Invalid arguments, or the attribute isn't placed as a Modifier.
404Type or attribute not found.