API ReferenceData Extraction

Add a new data extraction field to a phone script.

View as Markdown
Add a new data extraction field to a phone script.

Authentication

X-API-Keystring

API Key authentication. Generate your API key in the Gail Portal under General > Integrations > API Keys.

Path parameters

scriptIdstringRequiredformat: "uuid"
The unique identifier of the phone script.

Request

The data extraction field configuration.
idstring or nullOptionalformat: "uuid"
isActivebooleanOptional
namestring or nullOptional
descriptionstring or nullOptional
typeenumOptional
isRequiredbooleanOptional
formatenumOptional
patternstring or nullOptional
enumlist of strings or nullOptional
minimuminteger or nullOptional
maximuminteger or nullOptional

Response

OK
idstring or nullOptionalformat: "uuid"
isActivebooleanOptional
namestring or nullOptional
descriptionstring or nullOptional
typeenumOptional
isRequiredbooleanOptional
formatenumOptional
patternstring or nullOptional
enumlist of strings or nullOptional
minimuminteger or nullOptional
maximuminteger or nullOptional

Errors

400
Bad Request Error
404
Not Found Error