API

Collaboration APIs

PUT collaboration/emails/{emailId}

Save details for provided email

HTTP method PUT
URI https://api.rambase.net/collaboration/emails/{emailId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {emailId} Email identifier
Integer, minimum 100000
Successful HTTP status code 200
API resource identifier 1900, version 7

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
Email

This field is optional.

>
2
     <OccuredAt
OccuredAt

Date and time of the relationship activity

This field is optional.

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

Subject of the relationship email

This field is optional.

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

Body/message of the relationship email

This field is optional.

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

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

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

This field is optional.

>{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
</Email>
1
{
2
     "email
Email

This field is optional.

": {
3
          "occuredAt
OccuredAt

Date and time of the relationship activity

This field is optional.

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

Subject of the relationship email

This field is optional.

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

Body/message of the relationship email

This field is optional.

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

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

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

This field is optional.

": "{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
     }
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 101019 HTTP 400 Subject is required
Error 100382 HTTP 400 A relationship activity can only be regarding a customer or a supplier
Error 101020 HTTP 400 Owner not found
Error 101021 HTTP 400 Sender not found
Error 101022 HTTP 400 Customer/supplier this email is regarding was not found