API

Collaboration APIs

POST collaboration/contacts

Creates a new contact

HTTP method POST
URI https://api.rambase.net/collaboration/contacts
Supported formats Xml, Html, Json (ex. $format=json)
Custom fields Custom fields supported
Successful HTTP status code 201
API resource identifier 1833, 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
<Contact>
2
     <FirstName
FirstName

Firstname/givenname of the contact

This field is optional.

>
{String}</FirstName>
3
     <LastName
LastName

Required/mandatory field

Surname/familyname/lastname of the contact

>
{String}</LastName>
4
     <JobTitle
JobTitle

Professional title

This field is optional.

>
{String}</JobTitle>
5
     <PreferredLanguage
PreferredLanguage

Three character code following the ISO 639-2 standard.

Applicable domain values can be found here

This field is optional.

>
{String}</PreferredLanguage>
6
</Contact>
1
{
2
     "contact": {
3
          "firstName
FirstName

Firstname/givenname of the contact

This field is optional.

":
"{String}",
4
          "lastName
LastName

Required/mandatory field

Surname/familyname/lastname of the contact

":
"{String}",
5
          "jobTitle
JobTitle

Professional title

This field is optional.

":
"{String}",
6
          "preferredLanguage
PreferredLanguage

Three character code following the ISO 639-2 standard.

Applicable domain values can be found here

This field is optional.

":
"{String}"
7
     }
8
}

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]
$showCustomFields Boolean, optional Set to "true" to include custom fields. Default value is false.

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
<Contact>
2
     <ContactId
ContactId

Contact identifier

>
{Integer}</ContactId>
3
     <CreatedAt
CreatedAt

Date and time of creation

>
{Datetime}</CreatedAt>
4
     <UpdatedAt
UpdatedAt

Date and time of update

>
{Datetime}</UpdatedAt>
5
     <Status
Status

Status of the contact. 1:New, 4:Active, 9:Inactive

Possible domain values can be found here

>
{Integer}</Status>
6
     <FirstName
FirstName

Firstname/givenname of the contact

>
{String}</FirstName>
7
     <LastName
LastName

Surname/familyname/lastname of the contact

>
{String}</LastName>
8
     <JobTitle
JobTitle

Professional title

>
{String}</JobTitle>
9
     <ExternalPrivileges
ExternalPrivileges

Privileges to external applications for contact

Possible domain values can be found here

>
{String}</ExternalPrivileges>
10
     <PreferredLanguage
PreferredLanguage

Three character code following the ISO 639-2 standard.

Possible domain values can be found here

>
{String}</PreferredLanguage>
11
     <Category
Category

Category of the contact

Possible domain values can be found here

>
{String}</Category>
12
     <Source
Source

Source of which the personal information was obtained

Possible domain values can be found here

>
13
          <EmailId
EmailId

Email identifier

>
{Integer}</EmailId>
14
          <CreatedAt
CreatedAt

Date and time of creation

>
{Datetime}</CreatedAt>
15
          <Type
Type

Type of email

Possible domain values can be found here

>
{String}</Type>
16
          <Address
Address

The email address

>
{String}</Address>
17
          <EmailLink
EmailLink

Email reference

>
{String}</EmailLink>
18
          <PhoneId
PhoneId

Phone identifier

>
{Integer}</PhoneId>
19
          <PhoneNumber
PhoneNumber

The phone number

>
{String}</PhoneNumber>
20
          <Type
Type

Type of phone

Possible domain values can be found here

>
{String}</Type>
21
          <CreatedAt
CreatedAt

Date and time of creation

>
{Datetime}</CreatedAt>
22
          <PhoneLink
PhoneLink

Phone reference

>
{String}</PhoneLink>
23
     </Source>
24
     <Privacy>
25
          <HasAcceptedPrivacyPolicy
HasAcceptedPrivacyPolicy

Privacy policy accepted. Yes or no value.

>
{Boolean}</HasAcceptedPrivacyPolicy>
26
          <HasMarketingConsent
HasMarketingConsent

Consent to marketing. Yes or no value.

>
{Boolean}</HasMarketingConsent>
27
          <LegalBasisForDataProcessing
LegalBasisForDataProcessing

The legal basis for processing contact's data

Possible domain values can be found here

>
{Integer}</LegalBasisForDataProcessing>
28
     </Privacy>
29
</Contact>
1
{
2
     "contact": {
3
          "contactId
ContactId

Contact identifier

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

Date and time of creation

":
"{Datetime}",
5
          "updatedAt
UpdatedAt

Date and time of update

":
"{Datetime}",
6
          "status
Status

Status of the contact. 1:New, 4:Active, 9:Inactive

Possible domain values can be found here

":
"{Integer}",
7
          "firstName
FirstName

Firstname/givenname of the contact

":
"{String}",
8
          "lastName
LastName

Surname/familyname/lastname of the contact

":
"{String}",
9
          "jobTitle
JobTitle

Professional title

":
"{String}",
10
          "externalPrivileges
ExternalPrivileges

Privileges to external applications for contact

Possible domain values can be found here

":
"{String}",
11
          "preferredLanguage
PreferredLanguage

Three character code following the ISO 639-2 standard.

Possible domain values can be found here

":
"{String}",
12
          "category
Category

Category of the contact

Possible domain values can be found here

":
"{String}",
13
          "source
Source

Source of which the personal information was obtained

Possible domain values can be found here

":
{
14
               "emailId
EmailId

Email identifier

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

Date and time of creation

":
"{Datetime}",
16
               "type
Type

Type of email

Possible domain values can be found here

":
"{String}",
17
               "address
Address

The email address

":
"{String}",
18
               "emailLink
EmailLink

Email reference

":
"{String}",
19
               "phoneId
PhoneId

Phone identifier

":
"{Integer}",
20
               "phoneNumber
PhoneNumber

The phone number

":
"{String}",
21
               "type
Type

Type of phone

Possible domain values can be found here

":
"{String}",
22
               "createdAt
CreatedAt

Date and time of creation

":
"{Datetime}",
23
               "phoneLink
PhoneLink

Phone reference

":
"{String}"
24
          },
25
          "privacy": {
26
               "hasAcceptedPrivacyPolicy
HasAcceptedPrivacyPolicy

Privacy policy accepted. Yes or no value.

":
"{Boolean}",
27
               "hasMarketingConsent
HasMarketingConsent

Consent to marketing. Yes or no value.

":
"{Boolean}",
28
               "legalBasisForDataProcessing
LegalBasisForDataProcessing

The legal basis for processing contact's data

Possible domain values can be found here

":
"{Integer}"
29
          }
30
     }
31
}

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 100027 HTTP 400 Missing mandatory parameter {0}
Error 100053 HTTP 403 You have only admittance to your own suppliers
Error 101420 HTTP 404 Setting definition not found