Collaboration APIs
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.
FirstName
Firstname/givenname of the contact
This field is optional.
>{String}</FirstName>LastName
Required/mandatory field
Surname/familyname/lastname of the contact
>{String}</LastName>JobTitle
Professional title
This field is optional.
>{String}</JobTitle>PreferredLanguage
Three character code following the ISO 639-2 standard.
Applicable domain values can be found here
This field is optional.
>{String}</PreferredLanguage>FirstName
Firstname/givenname of the contact
This field is optional.
": "{String}",LastName
Required/mandatory field
Surname/familyname/lastname of the contact
": "{String}",JobTitle
Professional title
This field is optional.
": "{String}",PreferredLanguage
Three character code following the ISO 639-2 standard.
Applicable domain values can be found here
This field is optional.
": "{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] |
| $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.
ContactId
Contact identifier
>{Integer}</ContactId>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>UpdatedAt
Date and time of update
>{Datetime}</UpdatedAt>Status
Status of the contact. 1:New, 4:Active, 9:Inactive
Possible domain values can be found here
>{Integer}</Status>FirstName
Firstname/givenname of the contact
>{String}</FirstName>LastName
Surname/familyname/lastname of the contact
>{String}</LastName>JobTitle
Professional title
>{String}</JobTitle>ExternalPrivileges
Privileges to external applications for contact
Possible domain values can be found here
>{String}</ExternalPrivileges>PreferredLanguage
Three character code following the ISO 639-2 standard.
Possible domain values can be found here
>{String}</PreferredLanguage>Category
Category of the contact
Possible domain values can be found here
>{String}</Category>Source
Source of which the personal information was obtained
Possible domain values can be found here
>EmailId
Email identifier
>{Integer}</EmailId>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>Address
The email address
>{String}</Address>EmailLink
Email reference
>{String}</EmailLink>PhoneId
Phone identifier
>{Integer}</PhoneId>PhoneNumber
The phone number
>{String}</PhoneNumber>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>PhoneLink
Phone reference
>{String}</PhoneLink>HasAcceptedPrivacyPolicy
Privacy policy accepted. Yes or no value.
>{Boolean}</HasAcceptedPrivacyPolicy>HasMarketingConsent
Consent to marketing. Yes or no value.
>{Boolean}</HasMarketingConsent>LegalBasisForDataProcessing
The legal basis for processing contact's data
Possible domain values can be found here
>{Integer}</LegalBasisForDataProcessing>ContactId
Contact identifier
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",UpdatedAt
Date and time of update
": "{Datetime}",Status
Status of the contact. 1:New, 4:Active, 9:Inactive
Possible domain values can be found here
": "{Integer}",FirstName
Firstname/givenname of the contact
": "{String}",LastName
Surname/familyname/lastname of the contact
": "{String}",JobTitle
Professional title
": "{String}",ExternalPrivileges
Privileges to external applications for contact
Possible domain values can be found here
": "{String}",PreferredLanguage
Three character code following the ISO 639-2 standard.
Possible domain values can be found here
": "{String}",Category
Category of the contact
Possible domain values can be found here
": "{String}",Source
Source of which the personal information was obtained
Possible domain values can be found here
": {EmailId
Email identifier
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",Type
Type of email
Possible domain values can be found here
": "{String}",Address
The email address
": "{String}",EmailLink
Email reference
": "{String}",PhoneId
Phone identifier
": "{Integer}",PhoneNumber
The phone number
": "{String}",Type
Type of phone
Possible domain values can be found here
": "{String}",CreatedAt
Date and time of creation
": "{Datetime}",PhoneLink
Phone reference
": "{String}"HasAcceptedPrivacyPolicy
Privacy policy accepted. Yes or no value.
": "{Boolean}",HasMarketingConsent
Consent to marketing. Yes or no value.
": "{Boolean}",LegalBasisForDataProcessing
The legal basis for processing contact's data
Possible domain values can be found here
": "{Integer}"
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 |