API

Collaboration APIs

POST collaboration/emails/{emailId}/recipients

Adds a recipient to provided email

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

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
<Recipient>
2
     <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>
3
     <Note
Note

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

This field is optional.

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

Reference to the recipient supplier/customer/contact/employee

This field is optional.

>
5
          <ObjectId
ObjectId

Identifier of the object

This field is optional.

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

Type of object

This field is optional.

>{String}</ObjectType>
7
     </ObjectReference>
8
</Recipient>
1
{
2
     "recipient": {
3
          "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}",
4
          "note
Note

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

This field is optional.

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

Reference to the recipient supplier/customer/contact/employee

This field is optional.

": {
6
               "objectId
ObjectId

Identifier of the object

This field is optional.

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

Type of object

This field is optional.

": "{String}"
8
          }
9
     }
10
}

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
<Recipient>
2
     <RecipientId
RecipientId

Recipient identifier

>{Integer}</RecipientId>
3
</Recipient>
1
{
2
     "recipient": {
3
          "recipientId
RecipientId

Recipient identifier

": "{Integer}"
4
     }
5
}

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 100051 HTTP 400 When logged in as supplier {0} you do not have access to this API resource
Error 100055 HTTP 403 You have only admittance to your own objects
Error 100411 HTTP 400 Recipient object reference not found