GET/v2/announcement

Get the latest announcement

Retrieves the latest announcement for the authenticated user. Use this operation to check which announcement is currently available to that user.

5 status codes
200Returns the latest announcement object, including its announcement `type`.
typestringrequired
Allowed:FEATURE_BATCH_OPERATIONSFEATURE_MT_FORMALITYFEATURE_CONTENT_DELIVERY_AND_WEBHOOKSNEW_PRICINGFEATURE_AI_CUSTOMIZATIONFEATURE_VISUAL_EDITORFEATURE_CLI_2FEATURE_TASKSFEATURE_LLM_PROVIDERS_AND_PLAYGROUNDFEATURE_GLOSSARIES_AND_PLAYGROUNDFEATURE_LABELSFEATURE_SUGGESTIONS_AND_LABELS
400Returned when the request is invalid.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
401Returned when the request is unauthenticated.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
403Returned when the authenticated user is not permitted to access announcements.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
404Returned when no announcement is available for the authenticated user.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional

Error handling

A 400 is returned when the request is invalid, a 401 when the request is unauthenticated, a 403 when the authenticated user is not permitted to access announcements, and a 404 when no announcement is available. Send the request as the authenticated user whose latest announcement you want to retrieve.