POST Questionnaire Requests

post

https://api.conveyor.com/api/v2/questionnaire_requests

POST a questionnaire request to Conveyor

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

submitter_email

string

The email of the person submitting the request.

submitter_external_id

string

The ID of the submitter in your external system. This can be used for tagging / @-mentioning, but is not required.

submitter_external_name

string

The name of the submitter. This can be used for tagging / @-mentioning, but is not required.

external_id

string

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

string

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

raw_data

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. This is required unless you are passing in case_ids (as we will pull the raw_data from your Salesforce Case).

file

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.

source

string

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

Headers

X-API-KEY

string

Your Conveyor API key

Response

Language

Credentials

Header

Loading…

Response

Choose an example:

application/json

200200