latestOpenAPI 3.0.02026-07-13393178.8 KB

669a30d937df

Messages

Detailed message

This endpoint allows a user to retrieve information about a singular message relating to property links, check cases and challenges.

The message can be returned using one of the following projections:

  • <b>legacy</b> - (default in v 2.0) a legacy JSON structure of the message, potentially to be retired from future versions of the API
  • <b>data</b> - the response includes an array of data items that make up the message
  • <b>html</b> - a basic HTML-rendered version of the whole message is included as a field in the JSON response

Note that:

<ul class="list-bullet"> <li class="font-xsmall"> Individuals or organisations can only access their own data, and must be enrolled for the <a href="https://www.gov.uk/correct-your-business-rates" target="_blank">Find and check your business rates valuation</a> online service. </li> </ul>
get/my-organisation/messages/{messageId}

Path parameters

messageIdinteger required

Query parameters

projection'data' | 'html' | 'legacy'

Currently only accepts 'data', 'html', and 'legacy' (default) projection.

Headers

Accept'application/vnd.hmrc.2.0+json' required

Specifies the response format and the version of the API to be used

Response

GetMessageDetailedResponseSchemaJson required— unresolved $ref
OR
GetMessageDetailedHtmlResponseSchemaJson required— unresolved $ref
OR
GetMessageDetailedDataResponseSchemaJson required— unresolved $ref