API

System APIs

PUT system/output-object-definitions/{outputObjectDefinitionId}/email-settings/defaults

Update email settings for provided output object definition

HTTP method PUT
URI https://api.rambase.net/system/output-object-definitions/{outputObjectDefinitionId}/email-settings/defaults
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {outputObjectDefinitionId} Output object definition identifier
Integer, minimum 100000
Successful HTTP status code 200
API resource identifier 1984, version 6

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
<EmailSettings
EmailSettings

This field is optional.

>
2
     <FromEmailSource
FromEmailSource

Default from email type. This could be either User or Company (DOV).

User means get the email address from PER and Company from COM.

Input must match the following regular expression pattern: ^(USER|COMPANY)$

This field is optional.

>{String}</FromEmailSource>
3
     <IsActivatedManually
IsActivatedManually

If set to True this output setting can only be activated manually and not by the turn on all outputs option.

This field is optional.

>{Boolean}</IsActivatedManually>
4
     <OutputDesign
OutputDesign

This field is optional.

>
5
          <OutputDesignId
OutputDesignId

Reference to default design object

This field is optional.

>{Integer}</OutputDesignId>
6
     </OutputDesign>
7
</EmailSettings>
1
{
2
     "emailSettings
EmailSettings

This field is optional.

": {
3
          "fromEmailSource
FromEmailSource

Default from email type. This could be either User or Company (DOV).

User means get the email address from PER and Company from COM.

Input must match the following regular expression pattern: ^(USER|COMPANY)$

This field is optional.

": "{String}",
4
          "isActivatedManually
IsActivatedManually

If set to True this output setting can only be activated manually and not by the turn on all outputs option.

This field is optional.

": "{Boolean}",
5
          "outputDesign
OutputDesign

This field is optional.

": {
6
               "outputDesignId
OutputDesignId

Reference to default design object

This field is optional.

": "{Integer}"
7
          }
8
     }
9
}

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 101079 HTTP 400 Mismatch in size of revision parameters