Update Request Item

Request

Path Params

request_id

string

required

item_id

string

required

Body Params application/json

RequestItem attributes that can be set by end user

name

string

optional

Item name. For items with type: Question, the name is used as the question text.

>= 1 characters

description

string

optional

Item description

required

boolean

optional

Indicates whether the recipient is required to complete the request item

Example

{
    "name": "string",
    "description": "string",
    "required": true
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request PATCH '/requests//items/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "string",
    "description": "string",
    "required": true
}'

Responses

🟢200OK

application/json

Successful Response

Body

name

string

required

Item name. For items with type: Question, the name is used as the question text.

id

string

required

type

enum<string>

required

Type of the request item

Allowed values:

UPLOADE_SIGNATUREQUESTION

description

string

optional

Item description

required

boolean

optional

Indicates whether the recipient is required to complete the request item

answer

string

optional

Question answer. Only applies to items with type: QUESTION

Example

{
    "name": "string",
    "id": "string",
    "type": "UPLOAD",
    "description": "string",
    "required": true,
    "answer": "string"
}

🟠404Record Not Found

🟠422Parameter Error