API

Collaboration APIs

POST collaboration/emails

Creates a new email. Note that you can not add more than 40 recipients when creating the email. To add more you have to use the seperate API resources for recipients.

HTTP method POST
URI https://api.rambase.net/collaboration/emails
Supported formats Xml, Html, Json (ex. $format=json)
Successful HTTP status code 201
API resource identifier 1898, version 10

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
<Email>
2
     <OccuredAt
OccuredAt

Date and time of the relationship activity

This field is optional.

>{Datetime}</OccuredAt>
3
     <Subject
Subject

Required/mandatory field

Subject of the relationship email

>{String}</Subject>
4
     <Body
Body

Body/message of the relationship email

This field is optional.

>{String}</Body>
5
     <Direction
Direction

Required/mandatory field

Indicates whether the relationship activity is inbound (INBOUND) or outbound (OUTBOUND).

Input must match the following regular expression pattern: ^(INBOUND|OUTBOUND)*$

>{String}</Direction>
6
     <Regarding
Regarding

The customer/supplier of the relationship

This field is optional.

>
7
          <ObjectId
ObjectId

Identifier of the object

This field is optional.

>{Integer}</ObjectId>
8
          <ObjectType
ObjectType

Type of object

This field is optional.

>{String}</ObjectType>
9
     </Regarding>
10
     <Sender
Sender

Reference to the contact/supplier/employee/customer who sent the email

This field is optional.

>
11
          <EmailAddress
EmailAddress

Email address of the sender

Input must match the following regular expression pattern: ^\w+([-+.']\w+)*@\w+([-.]\w+)*\.\w+([-.]\w+)*$

This field is optional.

>{String}</EmailAddress>
12
          <ObjectReference
ObjectReference

Reference to the contact/supplier/employee/customer who sent the email

This field is optional.

>
13
               <ObjectId
ObjectId

Identifier of the object

This field is optional.

>{Integer}</ObjectId>
14
               <ObjectType
ObjectType

Type of object

This field is optional.

>{String}</ObjectType>
15
          </ObjectReference>
16
     </Sender>
17
     <Recipients>
18
          <Recipient>
19
               <EmailAddress
EmailAddress

Required/mandatory field

Email address of the recipient

Input must match the following regular expression pattern: ^\w+([-+.']\w+)*@\w+([-.]\w+)*\.\w+([-.]\w+)*$

>{String}</EmailAddress>
20
               <Note
Note

Used for specifing whether recipient was main receiver, recipients importance, level of involvment etc.

This field is optional.

>{String}</Note>
21
               <ObjectReference
ObjectReference

Reference to the recipient supplier/customer/contact/employee

This field is optional.

>
22
                    <ObjectId
ObjectId

Identifier of the object

This field is optional.

>{Integer}</ObjectId>
23
                    <ObjectType
ObjectType

Type of object

This field is optional.

>{String}</ObjectType>
24
               </ObjectReference>
25
          </Recipient>
26
     </Recipients>
27
     <Attachments
Attachments

This field is optional.

>
28
          <FileVersion
FileVersion

This field is optional.

>
29
               <FileVersionId
FileVersionId

File identifier

This field is optional.

>{String}</FileVersionId>
30
          </FileVersion>
31
     </Attachments>
32
</Email>
1
{
2
     "email": {
3
          "occuredAt
OccuredAt

Date and time of the relationship activity

This field is optional.

": "{Datetime}",
4
          "subject
Subject

Required/mandatory field

Subject of the relationship email

": "{String}",
5
          "body
Body

Body/message of the relationship email

This field is optional.

": "{String}",
6
          "direction
Direction

Required/mandatory field

Indicates whether the relationship activity is inbound (INBOUND) or outbound (OUTBOUND).

Input must match the following regular expression pattern: ^(INBOUND|OUTBOUND)*$

": "{String}",
7
          "regarding
Regarding

The customer/supplier of the relationship

This field is optional.

": {
8
               "objectId
ObjectId

Identifier of the object

This field is optional.

": "{Integer}",
9
               "objectType
ObjectType

Type of object

This field is optional.

": "{String}"
10
          },
11
          "sender
Sender

Reference to the contact/supplier/employee/customer who sent the email

This field is optional.

": {
12
               "emailAddress
EmailAddress

Email address of the sender

Input must match the following regular expression pattern: ^\w+([-+.']\w+)*@\w+([-.]\w+)*\.\w+([-.]\w+)*$

This field is optional.

": "{String}",
13
               "objectReference
ObjectReference

Reference to the contact/supplier/employee/customer who sent the email

This field is optional.

": {
14
                    "objectId
ObjectId

Identifier of the object

This field is optional.

": "{Integer}",
15
                    "objectType
ObjectType

Type of object

This field is optional.

": "{String}"
16
               }
17
          },
18
          "recipients": [
19
               {
20
                    "emailAddress
EmailAddress

Required/mandatory field

Email address of the recipient

Input must match the following regular expression pattern: ^\w+([-+.']\w+)*@\w+([-.]\w+)*\.\w+([-.]\w+)*$

": "{String}",
21
                    "note
Note

Used for specifing whether recipient was main receiver, recipients importance, level of involvment etc.

This field is optional.

": "{String}",
22
                    "objectReference
ObjectReference

Reference to the recipient supplier/customer/contact/employee

This field is optional.

": {
23
                         "objectId
ObjectId

Identifier of the object

This field is optional.

": "{Integer}",
24
                         "objectType
ObjectType

Type of object

This field is optional.

": "{String}"
25
                    }
26
               }
27
          ],
28
          "attachments
Attachments

This field is optional.

": [
29
               {
30
                    "fileVersionId
FileVersionId

File identifier

This field is optional.

": "{String}"
31
               }
32
          ]
33
     }
34
}

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.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]

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.

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

Format:
1
<Email>
2
     <EmailId
EmailId

Email identifier

>{Integer}</EmailId>
3
     <Status
Status

Status of the relationship email

>{Integer}</Status>
4
     <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
5
     <OccuredAt
OccuredAt

Date and time of the relationship activity

>{Datetime}</OccuredAt>
6
     <Subject
Subject

Subject of the relationship email

>{String}</Subject>
7
     <Body
Body

Body/message of the relationship email

>{String}</Body>
8
     <Direction
Direction

Indicates whether the relationship activity is inbound (INBOUND) or outbound (OUTBOUND).

>{String}</Direction>
9
     <Regarding
Regarding

The customer/supplier of the relationship

>
10
          <ObjectId
ObjectId

Identifier of the object

>{Integer}</ObjectId>
11
          <ObjectType
ObjectType

Type of object

>{String}</ObjectType>
12
          <ObjectLink
ObjectLink

API reference to the object

>{String}</ObjectLink>
13
     </Regarding>
14
     <CreatedBy
CreatedBy

All activities are assigned an owner who is responsible for completing/follow up the activity

>
15
          <UserId
UserId

User identifier

>{Integer}</UserId>
16
          <UserLink
UserLink

User reference

>{String}</UserLink>
17
     </CreatedBy>
18
     <Sender
Sender

Reference to the contact/supplier/employee/customer who sent the email

>
19
          <EmailAddress
EmailAddress

Email address of the sender

>{String}</EmailAddress>
20
          <Description
Description

Description of sender

>{String}</Description>
21
          <ObjectReference
ObjectReference

Reference to the contact/supplier/employee/customer who sent the email

>
22
               <ObjectId
ObjectId

Identifier of the object

>{Integer}</ObjectId>
23
               <ObjectType
ObjectType

Type of object

>{String}</ObjectType>
24
               <ObjectLink
ObjectLink

API reference to the object

>{String}</ObjectLink>
25
          </ObjectReference>
26
     </Sender>
27
</Email>
1
{
2
     "email": {
3
          "emailId
EmailId

Email identifier

": "{Integer}",
4
          "status
Status

Status of the relationship email

": "{Integer}",
5
          "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
6
          "occuredAt
OccuredAt

Date and time of the relationship activity

": "{Datetime}",
7
          "subject
Subject

Subject of the relationship email

": "{String}",
8
          "body
Body

Body/message of the relationship email

": "{String}",
9
          "direction
Direction

Indicates whether the relationship activity is inbound (INBOUND) or outbound (OUTBOUND).

": "{String}",
10
          "regarding
Regarding

The customer/supplier of the relationship

": {
11
               "objectId
ObjectId

Identifier of the object

": "{Integer}",
12
               "objectType
ObjectType

Type of object

": "{String}",
13
               "objectLink
ObjectLink

API reference to the object

": "{String}"
14
          },
15
          "createdBy
CreatedBy

All activities are assigned an owner who is responsible for completing/follow up the activity

": {
16
               "userId
UserId

User identifier

": "{Integer}",
17
               "userLink
UserLink

User reference

": "{String}"
18
          },
19
          "sender
Sender

Reference to the contact/supplier/employee/customer who sent the email

": {
20
               "emailAddress
EmailAddress

Email address of the sender

": "{String}",
21
               "description
Description

Description of sender

": "{String}",
22
               "objectReference
ObjectReference

Reference to the contact/supplier/employee/customer who sent the email

": {
23
                    "objectId
ObjectId

Identifier of the object

": "{Integer}",
24
                    "objectType
ObjectType

Type of object

": "{String}",
25
                    "objectLink
ObjectLink

API reference to the object

": "{String}"
26
               }
27
          }
28
     }
29
}

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 101069 HTTP 404 Stock assignment link - document not found
Error 101420 HTTP 404 Setting definition not found
Error 100199 HTTP 404 Location not found
Error 107763 HTTP 400 Only product structures can be set up for line production
Error 107764 HTTP 400 Only product structures can be externally manufactured
Error 103018 HTTP 400 Name of product is required
Error 105833 HTTP 400 CompanySetting require product name to be unique
Error 102975 HTTP 400 Unit can only be changed on product structures ( Type = K ) for batch productions
Error 103548 HTTP 400 DaysToExpediteScheduledStartDate can only be changed on product structures
Error 103550 HTTP 400 IsManufacturedExternally can only be changed on product structures
Error 103551 HTTP 400 IsManufacturedInBatches can only be changed on product structures
Error 103554 HTTP 400 AutomaticallyCreateWorkOrdersForSubstructures can only be changed on product structures
Error 104253 HTTP 400 ProduceInMultipleOf can only be changed on product structures.
Error 107694 HTTP 400 Use line production can only be changed on product structeres
Error 106999 HTTP 400 Sub module 'Projectorder' is not activated in this company
Error 106436 HTTP 400 Unit can only be changed when status is equal to draft (status 1)
Error 100167 HTTP 404 Measurement unit not found
Error 104486 HTTP 400 Unit production is only allowed for measurment units (UNI) of type QTY
Error 100200 HTTP 404 Special handling code not found
Error 100092 HTTP 404 Service template not found
Error 103020 HTTP 404 Qcdoc not found
Error 101091 HTTP 404 Contry of origin is not valid: {0}
Error 101124 HTTP 400 Hardware code already exists
Error 106437 HTTP 400 Type can not be changed when status is not equal to draft (status 1)
Error 101009 HTTP 400 The product has a structure. You can only change the product type to a type that can contain a structure.
Error 101010 HTTP 400 The product structure contains operations and can not be changed to become a phantom structure
Error 101008 HTTP 400 Cannot change product type from a physical type to a virtual type
Error 101007 HTTP 400 Cannot change product type from a virtual type to a physical type
Error 103021 HTTP 400 Linkid must be a rental product
Error 104760 HTTP 400 Costing method can't be changed after product has been received
Error 104652 HTTP 400 Both minimum sales price and minimum sales price currency must be given
Error 100563 HTTP 400 Currency {0} is not supported by the system
Error 104653 HTTP 400 Minimum sales price can not be negative
Error 106506 HTTP 404 Image not found