Deprecation and Sunset Policy

JobNimbus is committed to the long-term stability of the Platform API. When an endpoint needs to be retired, we follow a structured deprecation and sunset process that gives you advance notice and time to migrate.

Terminology

Term	Definition
Deprecation	The endpoint is still functional, but it is scheduled for removal. You should stop using it.
Sunset	The date on which the endpoint is permanently removed and will no longer accept requests.

Timeline

Sunset dates always fall on the last day of a calendar quarter (March 31, June 30, September 30, or December 31).
You will receive a minimum of six months notice between the deprecation announcement and the sunset date.

For example, an endpoint deprecated on February 1 would have a sunset date no earlier than September 30 of the same year.

How You Will Be Notified

Response Headers

Once an endpoint is deprecated, every response from that endpoint will include the following headers:

Header	Format	Description
`Deprecation`	`@{unix_seconds}`	The Unix timestamp (in seconds) when the endpoint was deprecated.
`Sunset`	HTTP-date	The date and time when the endpoint will be removed.
`Link`	`<https://api.jobnimbus.com/deprecation>; rel="deprecation"; type="text/html"`	A link to additional deprecation details.

Example response headers:

Deprecation: @1738367999
Sunset: Mon, 30 Jun 2025 23:59:59 UTC
Link: <https://api.jobnimbus.com/deprecation>; rel="deprecation"; type="text/html"

These headers follow the RFC 9745 standard.

Direct Communication

In addition to response headers, JobNimbus will notify affected customers through direct communication channels to ensure you are aware of upcoming changes.

What to Do When an Endpoint Is Deprecated

Check for deprecation headers in your API responses. Automated monitoring for the Deprecation and Sunset headers is recommended.
Review the migration path. The Link header in the response will point to documentation describing the replacement endpoint or alternative approach.
Update your integration to use the new endpoint before the sunset date.
Test thoroughly in your development environment after migrating.

After the Sunset Date

Once the sunset date passes, the deprecated endpoint will be removed. Requests to the endpoint will return an error and will no longer be processed.

Plan your migration well ahead of the sunset date to avoid disruption to your integration.