Skip to content

Ramp: Blank canvas schemas

5 Ramp schemas with complete fields and constraints.

← Blank canvas operations · All schemas

Approve or reject a blank canvas workflow step — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
actionstringRequired within parentAction to perform on the blank canvas workflow step: approve or reject
One of: approve, reject

Approve or reject a blank canvas workflow step — response body

FieldTypePresenceDescription and constraints
$objectRoot
messagestringRequired within parentDescriptive message about the operation result

Update metadata for a blank canvas external approval request — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
recipientsJSONOptional
recipients (anyOf 1)arrayAlternativeRecipients of the approval request
recipients (anyOf 1)[]ModelEach itemExpand Update metadata for a blank canvas external approval request — response body — recipients Recipients of the approval request item
recipients (anyOf 2)nullAlternative
statusJSONOptional
status (anyOf 1)stringAlternativeDisplay name of the status of the approval request, usually in sentence case
Default: null
status (anyOf 2)nullAlternative
urlJSONOptional
url (anyOf 1)stringAlternativeURL of the approval request
Default: null
url (anyOf 2)nullAlternative

Referenced models: Update metadata for a blank canvas external approval request — response body — recipients Recipients of the approval request item

Update metadata for a blank canvas external approval request — response body

FieldTypePresenceDescription and constraints
$objectRoot
approval_trigger_instance_idstringRequired within parentID of the approval trigger instance
Format: uuid
recipientsJSONOptional
recipients (anyOf 1)arrayAlternativeRecipients of the approval request
recipients (anyOf 1)[]ModelEach itemExpand Update metadata for a blank canvas external approval request — response body — recipients Recipients of the approval request item
recipients (anyOf 2)nullAlternative
statusJSONOptional
status (anyOf 1)stringAlternativeDisplay name of the status of the approval request, usually in sentence case
Default: null
status (anyOf 2)nullAlternative
urlJSONOptional
url (anyOf 1)stringAlternativeURL of the approval request
Default: null
url (anyOf 2)nullAlternative

Referenced models: Update metadata for a blank canvas external approval request — response body — recipients Recipients of the approval request item

Update metadata for a blank canvas external approval request — response body — recipients Recipients of the approval request item

FieldTypePresenceDescription and constraints
$objectRoot
emailstringRequired within parentEmail of the recipient
namestringRequired within parentName of the recipient

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.