Skip to main content
mutation EngagementCancel($id: EngagementGID!) {
  engagementCancel(id: $id) {
    engagement {
      cancellable
      createdAt
      id
      owner
      shortId
      type
      clients {
        email
        firstName
        lastName
        middleName
        phoneNumber
      }
      ... on PurchaseEngagement {
        closingDate
        property {
          address {
            city
            country
            latitude
            longitude
            postalCode
            province
            shortTitle
            street
            title
            unitNumber
          }
        }
        status {
          state
        }
      }
      ... on RefinanceEngagement {
        closingDate
        property {
          address {
            city
            country
            latitude
            longitude
            postalCode
            province
            shortTitle
            street
            title
            unitNumber
          }
        }
        status {
          state
        }
      }
    }
    userErrors {
      code
      field
      message
    }
  }
}

{
  "data": {
    "engagementCancel": {
      "engagement": {
        "cancellable": true,
        "createdAt": "2025-01-15T10:30:00Z",
        "id": "gid://ownright/Engagement/1",
        "owner": "Jane Doe",
        "shortId": "ABC-123",
        "type": "PURCHASE",
        "clients": [
          {
            "email": "[email protected]",
            "firstName": "Jane",
            "lastName": "Doe",
            "middleName": "M",
            "phoneNumber": "+14165551234"
          }
        ],
        "closingDate": "2025-06-15",
        "property": {
          "address": {
            "city": "Toronto",
            "country": "CANADA",
            "latitude": 1,
            "longitude": 1,
            "postalCode": "M5V 1A1",
            "province": "ALBERTA",
            "shortTitle": "123 Main St, Toronto",
            "street": "123 Main St",
            "title": "123 Main St, Toronto",
            "unitNumber": "Suite 100"
          }
        },
        "status": {
          "state": "CANCELLED"
        }
      },
      "userErrors": []
    }
  }
}

​
Mutation field

engagementCancel

​
Arguments

​
id
EngagementGID!
required
The GID of the engagement to cancel.

​
Return fields

​
engagement
Engagement
The cancelled engagement.
​
userErrors
[EngagementCancelUserError!]!
required
List of errors that occurred while executing the mutation.

​
Types

enum EngagementCancelUserErrorCode {
  ENGAGEMENT_NOT_CANCELLABLE # The specified engagement cannot be cancelled.
  ENGAGEMENT_NOT_FOUND # The specified engagement could not be found.
}

enum EngagementType {
  PURCHASE # A purchase engagement.
  REFINANCE # A refinance engagement.
}

scalar EngagementGID # A global identifier for a Engagement object in format of 'gid://ownright/Engagement/ID'.

scalar ISO8601DateTime # An ISO 8601-encoded datetime