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.
Event tokenx-Event-TokenOptionalRun **Get Tokens** in the Authorization folder, or call `GET /Events/{eventId}/authorize` manually.

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.

Event scoping: This endpoint does not include {eventId} in the URL. The event is determined automatically from your x-Event-Token.

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.