---
updatedAt: 2025-11-11T21:56:18.000Z
agentTools:
  projectIndex: https://docs.conveyor.com/llms.txt
---

# PATCH Questionnaire Request

PATCH a questionnaire request in Conveyor

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "portal-api",
    "version": "2.0"
  },
  "servers": [
    {
      "url": "https://api.conveyor.com/api"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "apiKey",
        "in": "header",
        "name": "X-API-KEY"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/v2/questionnaire_requests": {
      "patch": {
        "summary": "PATCH Questionnaire Request",
        "description": "PATCH a questionnaire request in Conveyor",
        "operationId": "patch-questionnaire-request",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "Any string will work if you are also passing in case_ids",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "X-API-KEY",
            "in": "header",
            "description": "Your Conveyor API key",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "external_id": {
                    "type": "string",
                    "description": "The unique ID of the ticket from your external system. This is required unless you are passing in case_ids (as that will be used as the external_id)."
                  },
                  "case_ids": {
                    "type": "string",
                    "description": "Our Salesforce managed package has a trigger that will pass in all Case IDs that have been updated"
                  },
                  "raw_data": {
                    "type": "string",
                    "description": "This is the data from your ticket that you want our agent to have as context. Ideally it is in JSON, but a string will work too.",
                    "format": "json"
                  },
                  "file": {
                    "type": "string",
                    "description": "File you want our agent to analyze. This should be a questionnaire. Portal-based questionnaires should have the links / details sent via the raw_data parameter.",
                    "format": "binary"
                  },
                  "source": {
                    "type": "string",
                    "description": "The name of the system you are using to integrate. E.g. \"salesforce\" or \"workato\". It is for reference only."
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"_embedded\": {\n        \"questionnaire_requests\": [\n            {\n                \"id\": \"716c6e1f-32b2-4006-ae5a-8c95e6cbe74a\",\n                \"status\": null,\n                \"source\": \"salesforce\",\n                \"submitter_email\": \"example@conveyor.com\",\n                \"submitter_external_id\": null,\n                \"submitter_external_name\": null,\n                \"external_id\": \"123\"\n            }\n        ]\n    }\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "_embedded": {
                      "type": "object",
                      "properties": {
                        "questionnaire_requests": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "string",
                                "example": "716c6e1f-32b2-4006-ae5a-8c95e6cbe74a"
                              },
                              "status": {},
                              "source": {
                                "type": "string",
                                "example": "salesforce"
                              },
                              "submitter_email": {
                                "type": "string",
                                "example": "example@conveyor.com"
                              },
                              "submitter_external_id": {},
                              "submitter_external_name": {},
                              "external_id": {
                                "type": "string",
                                "example": "123"
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": false,
    "proxy-enabled": false
  },
  "x-readme-fauxas": true
}
```