v1

latestOpenAPI 3.1.02026-07-24300110.4 KB

PATCH Questionnaire Request

PATCH a questionnaire request in Conveyor

patch/v2/questionnaire_requests

Path parameters

idstring required

Any string will work if you are also passing in case_ids

Headers

X-API-KEYstring

Your Conveyor API key

Request body

external_idstring

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_idsstring

Our Salesforce managed package has a trigger that will pass in all Case IDs that have been updated

raw_datastring json

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.

filestring binary

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.

sourcestring

The name of the system you are using to integrate. E.g. "salesforce" or "workato". It is for reference only.

Response

200

Example response

{
  "_embedded": {
    "questionnaire_requests": [
      {
        "id": "716c6e1f-32b2-4006-ae5a-8c95e6cbe74a",
        "source": "salesforce",
        "submitter_email": "example@conveyor.com",
        "external_id": "123"
      }
    ]
  }
}