Collaboration APIs
Adds an email to provided contact
| HTTP method | POST |
| URI | https://api.rambase.net/collaboration/contacts/{contactId}/emails |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {contactId} |
Contact identifier
Integer, minimum 100000 |
| Successful HTTP status code | 201 |
| API resource identifier | 3115, 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.
Type
Type of email
Applicable domain values can be found here
Default value: BUSINESS
This field is optional.
>{String}</Type>IsDefault
True if this is the default communication type
Default value: False
This field is optional.
>{Boolean}</IsDefault>Address
Required/mandatory field
The email address
Input must match the following regular expression pattern: ^\w+([-+.']\w+)*@\w+([-.]\w+)*\.\w+([-.]\w+)*$
>{String}</Address>Type
Type of email
Applicable domain values can be found here
Default value: BUSINESS
This field is optional.
": "{String}",IsDefault
True if this is the default communication type
Default value: False
This field is optional.
": "{Boolean}",Address
Required/mandatory field
The email address
Input must match the following regular expression pattern: ^\w+([-+.']\w+)*@\w+([-.]\w+)*\.\w+([-.]\w+)*$
": "{String}"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. |
| $showDomainDescriptions Boolean, optional | Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false. |
| $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.
EmailId
Email identifier
>{Integer}</EmailId>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>IsDefault
True if this is the default communication type
>{Boolean}</IsDefault>Address
The email address
>{String}</Address>EmailId
Email identifier
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",IsDefault
True if this is the default communication type
": "{Boolean}",Type
Type of email
Possible domain values can be found here
": "{String}",Address
The email address
": "{String}"
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 105991 HTTP 400 | Event is not of the same type as event set on the automated flow |
| Error 101420 HTTP 404 | Setting definition not found |