Set Case Status to Completed

Sets a support case to Mpt.Helpdesk.Models.Cases.SupportCaseStatus.Completed status.

post

The support case ID is provided in the route.

Path parameters

idstringRequired

The support case ID.

Responses

200

OK

application/json

idstringOptional

revisioninteger · int32Optional

statusstring · enumOptionalPossible values:

queryPromptstring · nullableOptional

The prompt that is set along with setting the Mpt.Helpdesk.Models.Cases.SupportCase.Status to Mpt.Helpdesk.Models.Cases.SupportCaseStatus.Querying

awaitingbooleanOptional

Can be set by users of the account that manages the case

403

Forbidden

application/json

404

Not Found

application/json

500

Internal Server Error

post

/public/v1/helpdesk/cases/{id}/complete

HTTPcURLJavaScriptPython

POST /public/v1/helpdesk/cases/{id}/complete HTTP/1.1
Host: api.s1.show
Accept: */*

{
  "id": "text",
  "audit": {
    "created": {
      "at": "2026-03-30T20:53:05.651Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "updated": {
      "at": "2026-03-30T20:53:05.651Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "processed": {
      "at": "2026-03-30T20:53:05.651Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "queried": {
      "at": "2026-03-30T20:53:05.651Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "transferred": {
      "at": "2026-03-30T20:53:05.651Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "completed": {
      "at": "2026-03-30T20:53:05.651Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "revision": 1,
  "chat": {
    "id": "text",
    "audit": {
      "created": {
        "at": "2026-03-30T20:53:05.651Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      },
      "updated": {
        "at": "2026-03-30T20:53:05.651Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      }
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "name": "text",
    "icon": "text",
    "revision": 1,
    "description": "text",
    "type": "Direct",
    "participants": [
      {
        "id": "text",
        "revision": 1,
        "muted": true,
        "status": "Active"
      }
    ],
    "lastMessage": {
      "id": "text",
      "revision": 1,
      "content": "text",
      "visibility": "Public",
      "isDeleted": true
    },
    "attachments": [
      {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1,
        "file": {
          "id": "text",
          "audit": {
            "created": {
              "at": "2026-03-30T20:53:05.651Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            },
            "updated": {
              "at": "2026-03-30T20:53:05.651Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            }
          },
          "$meta": {
            "omitted": [
              "text"
            ]
          },
          "name": "text",
          "icon": "text",
          "revision": 1,
          "type": "Icon",
          "filename": "report.pdf",
          "size": 102400,
          "contentType": "application/pdf"
        }
      }
    ]
  },
  "reporter": {
    "id": "text",
    "audit": {
      "created": {
        "at": "2026-03-30T20:53:05.651Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      },
      "updated": {
        "at": "2026-03-30T20:53:05.651Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      }
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "revision": 1,
    "name": "text",
    "blockedReason": "text",
    "email": "text",
    "status": "text",
    "identity": {
      "id": "text",
      "audit": {
        "created": {
          "at": "2026-03-30T20:53:05.651Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "updated": {
          "at": "2026-03-30T20:53:05.651Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        }
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "name": "text",
      "icon": "text",
      "revision": 1
    },
    "directories": [
      {
        "id": "text",
        "audit": {
          "created": {
            "at": "2026-03-30T20:53:05.651Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          },
          "updated": {
            "at": "2026-03-30T20:53:05.651Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          }
        },
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "revision": 1,
        "account": {
          "id": "text",
          "audit": {
            "created": {
              "at": "2026-03-30T20:53:05.651Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            },
            "updated": {
              "at": "2026-03-30T20:53:05.651Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            }
          },
          "$meta": {
            "omitted": [
              "text"
            ]
          },
          "name": "text",
          "icon": "text",
          "revision": 1,
          "type": "Client",
          "status": "Active",
          "externalIds": {
            "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
          },
          "externalId": "text",
          "externalName": "text",
          "address": {
            "addressLine1": "text",
            "addressLine2": "text",
            "postCode": "text",
            "city": "text",
            "state": "text",
            "country": "text"
          },
          "technicalSupportEmail": "text",
          "website": "text",
          "description": "text",
          "groups": [
            {
              "id": "text",
              "name": "text",
              "revision": 1,
              "description": "text",
              "logo": "text",
              "isDefault": true
            }
          ],
          "eligibility": {
            "client": true,
            "partner": true
          },
          "defaultLanguageCode": "text"
        },
        "origin": {
          "id": "text",
          "audit": {
            "created": {
              "at": "2026-03-30T20:53:05.651Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            },
            "updated": {
              "at": "2026-03-30T20:53:05.651Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            }
          },
          "$meta": {
            "omitted": [
              "text"
            ]
          },
          "name": "text",
          "icon": "text",
          "revision": 1,
          "type": "Client",
          "status": "Active",
          "externalIds": {
            "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
          },
          "externalId": "text",
          "externalName": "text",
          "address": {
            "addressLine1": "text",
            "addressLine2": "text",
            "postCode": "text",
            "city": "text",
            "state": "text",
            "country": "text"
          },
          "technicalSupportEmail": "text",
          "website": "text",
          "description": "text",
          "groups": [
            {
              "id": "text",
              "name": "text",
              "revision": 1,
              "description": "text",
              "logo": "text",
              "isDefault": true
            }
          ],
          "eligibility": {
            "client": true,
            "partner": true
          },
          "defaultLanguageCode": "text"
        },
        "type": "text",
        "contacts": [
          "[Circular Reference]"
        ]
      }
    ],
    "chat": true
  },
  "assignee": {
    "id": "text",
    "audit": {
      "created": {
        "at": "2026-03-30T20:53:05.651Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      },
      "updated": {
        "at": "2026-03-30T20:53:05.651Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      }
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "revision": 1,
    "name": "text",
    "blockedReason": "text",
    "email": "text",
    "status": "text",
    "identity": {
      "id": "text",
      "audit": {
        "created": {
          "at": "2026-03-30T20:53:05.651Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "updated": {
          "at": "2026-03-30T20:53:05.651Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        }
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "name": "text",
      "icon": "text",
      "revision": 1
    },
    "directories": [
      {
        "id": "text",
        "audit": {
          "created": {
            "at": "2026-03-30T20:53:05.651Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          },
          "updated": {
            "at": "2026-03-30T20:53:05.651Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          }
        },
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "revision": 1,
        "account": {
          "id": "text",
          "audit": {
            "created": {
              "at": "2026-03-30T20:53:05.651Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            },
            "updated": {
              "at": "2026-03-30T20:53:05.651Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            }
          },
          "$meta": {
            "omitted": [
              "text"
            ]
          },
          "name": "text",
          "icon": "text",
          "revision": 1,
          "type": "Client",
          "status": "Active",
          "externalIds": {
            "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
          },
          "externalId": "text",
          "externalName": "text",
          "address": {
            "addressLine1": "text",
            "addressLine2": "text",
            "postCode": "text",
            "city": "text",
            "state": "text",
            "country": "text"
          },
          "technicalSupportEmail": "text",
          "website": "text",
          "description": "text",
          "groups": [
            {
              "id": "text",
              "name": "text",
              "revision": 1,
              "description": "text",
              "logo": "text",
              "isDefault": true
            }
          ],
          "eligibility": {
            "client": true,
            "partner": true
          },
          "defaultLanguageCode": "text"
        },
        "origin": {
          "id": "text",
          "audit": {
            "created": {
              "at": "2026-03-30T20:53:05.651Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            },
            "updated": {
              "at": "2026-03-30T20:53:05.651Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            }
          },
          "$meta": {
            "omitted": [
              "text"
            ]
          },
          "name": "text",
          "icon": "text",
          "revision": 1,
          "type": "Client",
          "status": "Active",
          "externalIds": {
            "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
          },
          "externalId": "text",
          "externalName": "text",
          "address": {
            "addressLine1": "text",
            "addressLine2": "text",
            "postCode": "text",
            "city": "text",
            "state": "text",
            "country": "text"
          },
          "technicalSupportEmail": "text",
          "website": "text",
          "description": "text",
          "groups": [
            {
              "id": "text",
              "name": "text",
              "revision": 1,
              "description": "text",
              "logo": "text",
              "isDefault": true
            }
          ],
          "eligibility": {
            "client": true,
            "partner": true
          },
          "defaultLanguageCode": "text"
        },
        "type": "text",
        "contacts": [
          "[Circular Reference]"
        ]
      }
    ],
    "chat": true
  },
  "account": {
    "id": "text",
    "audit": {
      "created": {
        "at": "2026-03-30T20:53:05.651Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      },
      "updated": {
        "at": "2026-03-30T20:53:05.651Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      }
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "name": "text",
    "icon": "text",
    "revision": 1,
    "type": "Client",
    "status": "Active",
    "externalIds": {
      "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
    },
    "externalId": "text",
    "externalName": "text",
    "address": {
      "addressLine1": "text",
      "addressLine2": "text",
      "postCode": "text",
      "city": "text",
      "state": "text",
      "country": "text"
    },
    "technicalSupportEmail": "text",
    "website": "text",
    "description": "text",
    "groups": [
      {
        "id": "text",
        "name": "text",
        "revision": 1,
        "description": "text",
        "logo": "text",
        "isDefault": true
      }
    ],
    "eligibility": {
      "client": true,
      "partner": true
    },
    "defaultLanguageCode": "text"
  },
  "queue": {
    "id": "text",
    "audit": {
      "created": {
        "at": "2026-03-30T20:53:05.651Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      },
      "updated": {
        "at": "2026-03-30T20:53:05.651Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      },
      "deleted": {
        "at": "2026-03-30T20:53:05.651Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      },
      "activated": {
        "at": "2026-03-30T20:53:05.651Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      },
      "disabled": {
        "at": "2026-03-30T20:53:05.651Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      }
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "name": "text",
    "icon": "text",
    "revision": 1,
    "description": "text",
    "externalId": "text",
    "status": "Disabled",
    "default": true,
    "internal": true,
    "account": {
      "id": "text",
      "audit": {
        "created": {
          "at": "2026-03-30T20:53:05.651Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "updated": {
          "at": "2026-03-30T20:53:05.651Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        }
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "name": "text",
      "icon": "text",
      "revision": 1,
      "type": "Client",
      "status": "Active",
      "externalIds": {
        "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
      },
      "externalId": "text",
      "externalName": "text",
      "address": {
        "addressLine1": "text",
        "addressLine2": "text",
        "postCode": "text",
        "city": "text",
        "state": "text",
        "country": "text"
      },
      "technicalSupportEmail": "text",
      "website": "text",
      "description": "text",
      "groups": [
        {
          "id": "text",
          "name": "text",
          "revision": 1,
          "description": "text",
          "logo": "text",
          "isDefault": true
        }
      ],
      "eligibility": {
        "client": true,
        "partner": true
      },
      "defaultLanguageCode": "text"
    },
    "statistics": {
      "totalCases": 1,
      "openCases": 1,
      "awaitingCases": 1
    },
    "isDeleted": true
  },
  "status": "Processing",
  "queryPrompt": "text",
  "awaiting": true,
  "parameters": [
    {
      "id": "text",
      "name": "text",
      "externalId": "text",
      "type": "SingleLineText",
      "multiple": true,
      "constraints": {
        "hidden": true,
        "readonly": true,
        "required": true,
        "capacity": {
          "min": 1,
          "max": 1
        },
        "visibility": "All"
      },
      "displayOrder": 1,
      "value": {
        "options": {
          "propertyNameCaseInsensitive": true
        },
        "parent": "[Circular Reference]",
        "root": "[Circular Reference]"
      },
      "displayValue": "text"
    }
  ]
}