Skip to main content
Released 15th October 2026 This patch release clarifies the behaviour of the effective_date field on the share agreement PATCH endpoints. No functional API behaviour has changed.
Patch Release: Documentation-only changes that clarify existing effective date behaviour. No breaking changes or functional modifications.

​
Documentation Updates

Updated endpoints:
  • PATCH /v2/orgs/share-agreements/{share_agreement_id}
  • PATCH /v2/orgs/tms-share-agreements/{tms_share_agreement_id}
What changed:The description of the effective_date field has been updated to clarify that it cannot be set to null. Omitting the field from the request body leaves the current value unchanged.Before:
After:
The field type has also been formally documented as string with date-time format, consistent with how it is stored and returned.Impact:
  • No changes to API behaviour
  • Existing integrations are unaffected
  • If you previously sent "effective_date": null to clear the field, that request will be rejected — omit the field instead to leave it unchanged

​
Integration Notes

1

Omit effective_date to preserve the current value

To update a share agreement without changing its effective date, simply omit the field from the request body:
2

No action required for most integrations

This is a documentation-only update. If your integration is currently working and does not send "effective_date": null, no changes are needed.

​
Need Help?

API Reference

View complete endpoint documentation for the Organizations API

Contact Support

Questions about your integration? Our team is here to help