Skip to content

BasicMutationResponse

Standard result envelope for an App Connect mutation.

Properties

Property Type Required Description
successful boolean Yes Whether the requested operation completed successfully.
returnMessage any of: ReturnMessage, string No Optional status message. Most routes return a structured notification; a few legacy routes return plain text.

Example

{
  "successful": false,
  "returnMessage": {
    "message": "string",
    "messageType": "string",
    "ttl": 0,
    "details": [
      {}
    ]
  }
}