API Policy

Type of change Notice What you should do
Remove an endpoint Endpoint will be marked DEPRECATED at least 90 days before endpoint is removed Watch release notes
Remove a documented field in a result set Field will be marked DEPRECATED at least 90 days before field is removed Watch release notes
Remove an undocumented field in a result set Undocumented fields can be removed or changed without notice Avoid using these fields or be aware that they could be experimental and could change at any time
Add a field to a result set Field can be added without prior notice Write your code to be resilient to these types of changes
Add to the attribute set of a field in the result set New values can be added to a field without prior notice Write your code to be resilient to these types of changes
Change the attribute set of a field in the result set Field value will be marked DEPRECATED at least 90 days before attribute is changed Watch release notes
Remove the attribute set of a field in the result set Field value will be marked DEPRECATED at least 90 days before attribute is removed Watch release notes
Change to BETA endpoints, fields, or attributes Can be removed or changed without prior notice Watch release notes
Changes related to fixing a security vulnerability Any change related to repairing a security vulnerability could be made without prior notice Watch security bulletins