Update a redemption configuration

patch

https://example.com/servicing/v2/distribution/servicing/redemptions/{redemptionId}

Update a redemption configuration with PATCH semantics (partial updates). Account must be token OWNER of the tokenId linked to that redemptionId.

Calendar handling:
- Send UUID to replace/add current calendar with that calendar
- Send parameters to create/update calendar with those parameters
- Send empty object {} to unlink calendar

For arrays like paymentCurrency, the full array is replaced. For objects like orderFormSettings and calendar, the full object is replaced.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

redemptionId

string

required

Body Params

alias

string

Alias for the redemption configuration

paymentCurrency

array of strings

Allowed payment currencies (ISO 4217 codes)

paymentCurrency

startDate

date-time

Start date of the interval in UTC time

endDate

date-time

End date of the interval in UTC time. Acceptable only for close-ended intervals

autoBurning

boolean

Enable auto burning on redemption.

orderFormSettings

object

Investor app order form settings.

calendar

object

Calendar configuration for redemption timing.

Behaviour based on the payload:

- Field omitted → keep the currently linked calendar as-is (no change).

- calendar: {} (empty object) → unlink the current calendar (if any) and delete it in the calendar service.

- { id: "<existingId>" } → link this redemption to an existing calendar with that id.
    • If a different calendar was previously linked, the old calendar is deleted after a successful update.

- { id: null, ...fields } → create a new calendar with the provided fields and link it to the redemption.
    • If a calendar was previously linked, the old one is deleted after linking the new calendar.

- { ...fields } (no id property at all) → create a new calendar and link it to the redemption.
    • If a calendar was previously linked, the old one is deleted after linking the new calendar.

When the backend creates a new calendar (no id or id: null):

- All working-day flags (workMonday…workSunday) must be present in the payload.

- At least one of the working-day flags must be true.

- If cutOffTime is provided, delay is required.

- If delay is provided, cutOffTime is required.

Responses

204

Redemption configuration updated successfully.

400

Bad request - validation errors:
• Invalid redemptionId format
• Invalid date formats or date logic
• Invalid payment currency codes
• At least one payment currency must be provided
• Start date must be before end date
• Redemption dates cannot overlap with existing redemptions for the same token
• Calendar not found (when calendar ID provided)
• Calendar not supported for close-ended redemptions
• Missing required calendar fields when creating new calendar

401

Unauthorized - invalid or missing authentication token.

403

Forbidden - account is not the token owner of the tokenId linked to the redemptionId.

404

Not found:
• Redemption not found for the provided redemptionId
• Token not found for the redemption

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here!