API

System APIs

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

Creates a new email media for the given output object definition

HTTP method PUT
URI https://api.rambase.net/system/output-object-definitions/{outputObjectDefinitionId}/email-settings
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 1983, version 15

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

This could be either User, Company OR Custom (DOV).

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

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

This field is optional.

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

If FromEmailSource is set to Custom then the email from address will be gathered from this field.

This field is optional.

>{String}</FromEmailAddress>
4
     <FromEmailName
FromEmailName

If FromEmailSource is set to Custom then the email from name will be gathered from this field.

This field is optional.

>{String}</FromEmailName>
5
     <IsDefaultForOutputControl
IsDefaultForOutputControl

Combined with the fields IsOutputForCustomers and IsOutputForSuppliers from OOD you can set what default output control values that should be set when a new customer or supplier is created.

This field is optional.

>{Boolean}</IsDefaultForOutputControl>
6
     <OutputDesign
OutputDesign

This field is optional.

>
7
          <OutputDesignId
OutputDesignId

Output design identifier

Minimum value: 100000

This field is optional.

>{Integer}</OutputDesignId>
8
     </OutputDesign>
9
     <TestOutputDesign
TestOutputDesign

This field is optional.

>
10
          <OutputDesignId
OutputDesignId

Test output design identifier

Minimum value: 100000

This field is optional.

>{Integer}</OutputDesignId>
11
     </TestOutputDesign>
12
     <TestEmployees
TestEmployees

Employee id testing the test output design selected

This field is optional.

>
13
          <Employee
Employee

This field is optional.

>
14
               <EmployeeId
EmployeeId

Employee identifier

Minimum value: 100

This field is optional.

>{Integer}</EmployeeId>
15
          </Employee>
16
     </TestEmployees>
17
</EmailSettings>
1
{
2
     "emailSettings
EmailSettings

This field is optional.

": {
3
          "fromEmailSource
FromEmailSource

This could be either User, Company OR Custom (DOV).

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

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

This field is optional.

": "{String}",
4
          "fromEmailAddress
FromEmailAddress

If FromEmailSource is set to Custom then the email from address will be gathered from this field.

This field is optional.

": "{String}",
5
          "fromEmailName
FromEmailName

If FromEmailSource is set to Custom then the email from name will be gathered from this field.

This field is optional.

": "{String}",
6
          "isDefaultForOutputControl
IsDefaultForOutputControl

Combined with the fields IsOutputForCustomers and IsOutputForSuppliers from OOD you can set what default output control values that should be set when a new customer or supplier is created.

This field is optional.

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

This field is optional.

": {
8
               "outputDesignId
OutputDesignId

Output design identifier

Minimum value: 100000

This field is optional.

": "{Integer}"
9
          },
10
          "testOutputDesign
TestOutputDesign

This field is optional.

": {
11
               "outputDesignId
OutputDesignId

Test output design identifier

Minimum value: 100000

This field is optional.

": "{Integer}"
12
          },
13
          "testEmployees
TestEmployees

Employee id testing the test output design selected

This field is optional.

": [
14
               {
15
                    "employeeId
EmployeeId

Employee identifier

Minimum value: 100

This field is optional.

": "{Integer}"
16
               }
17
          ]
18
     }
19
}

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 101015 HTTP 404 Permission not found
Error 101420 HTTP 404 Setting definition not found
Error 105807 HTTP 400 The selected object definition is not used for the output control
Error 101814 HTTP 404 Employee not found