Tasks

Update a specified message.

post/sites/{site-identifier}/queries/{query-identifier}/messages/{message-guid}

Request

  • Base URL: https://api-dev.superconcepts.com.au/api/v1
  • URL: https://api-dev.superconcepts.com.au/api/v1/sites/{site-identifier}/queries/{query-identifier}/messages/{message-guid}
  • Auth: OAuth 2 (authorization code, authorization URL https://api.supermate.com.au/oauth/v1/authorize, token URL https://api.supermate.com.au/oauth/v1/token, scopes: default)

Path parameters

site-identifierstring required

The GUID that identifies a site

query-identifierstring required

The GUID that identifies a specific Task Query

message-guidstring required

The GUID that identifies a query message.

Query parameters

actionstring
Example:ATTACHMENTS-UPDATED

Message actions available

Request body

Messagestring
HasBeenReadboolean
Status'Draft' | 'Ready' | 'Sent' | 'With Client' | 'With Administrator' | 'Completed' | 'Match To Query'
SourceUserNamestring

Example request

{
  "Message": "Hello, please provide the latest trust deed",
  "SourceUserName": "Mary Smith <mary.smith@superconcepts.com.au>"
}

Response

Success

Changes

No recorded changes to this operation across all 1 revision of this API.