API

System APIs

PUT system/automated-flow-templates/{automatedFlowTemplateId}/parameters/{automatedFlowTemplateParameterId}

Update value of an automated flow template parameter

HTTP method PUT
URI https://api.rambase.net/system/automated-flow-templates/{automatedFlowTemplateId}/parameters/{automatedFlowTemplateParameterId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {automatedFlowTemplateId} Automated flow template identifier
Integer, minimum 100000
- URI parameter {automatedFlowTemplateParameterId} Automated flow template parameter identifier
Integer, minimum 1
Successful HTTP status code 200
API resource identifier 4970, version 1

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
<AutomatedFlowTemplateParameter
AutomatedFlowTemplateParameter

This field is optional.

>
2
     <Value
Value

Value of the parameter

This field is optional.

>{String}</Value>
3
</AutomatedFlowTemplateParameter>
1
{
2
     "automatedFlowTemplateParameter
AutomatedFlowTemplateParameter

This field is optional.

": {
3
          "value
Value

Value of the parameter

This field is optional.

": "{String}"
4
     }
5
}

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.

Read more about filters and sorting on how to use filter parameters and named filters.

Read more about filters and sorting on how to use sortable parameters

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
1

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 105763 HTTP 404 Automated flow action not found
Error 105789 HTTP 404 Parameter not found
Error 106605 HTTP 400 Value has to be a valid e-mail address
Error 106603 HTTP 400 Value has to be a number
Error 106602 HTTP 400 Value must be between the minimum and maximum value.
Error 106604 HTTP 400 Value has to be an integer
Error 106600 HTTP 400 Default value does not exists in DOV