RamBase REST APIs
Update information for specified contact
| HTTP method | PUT |
| URI | https://api.rambase.net/collaboration/contacts/{contactId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {contactId} |
Contact identifier
Integer, minimum 10000 |
| Custom fields | Custom fields supported |
| Successful HTTP status code | 200 |
| API resource identifier | 1835, version 15 |
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.
Contact
This field is optional.
>FirstName
Firstname/givenname of the contact
This field is optional.
>{String}</FirstName>LastName
Surname/familyname/lastname of the contact
This field is optional.
>{String}</LastName>JobTitle
Professional title
This field is optional.
>{String}</JobTitle>Category
Category of the contact
Applicable domain values can be found here
This field is optional.
>{String}</Category>ExternalPrivileges
Privileges to external applications for contact
Applicable domain values can be found here
This field is optional.
>{String}</ExternalPrivileges>PreferredLanguage
Three character code following the ISO 639-2 standard.
Applicable domain values can be found here
This field is optional.
>{String}</PreferredLanguage>Source
Source of which the personal information was obtained
Applicable domain values can be found here
This field is optional.
>{Integer}</Source>Privacy
This field is optional.
>LegalBasisForDataProcessing
The legal basis for processing contact's data
Applicable domain values can be found here
This field is optional.
>{Integer}</LegalBasisForDataProcessing>HasAcceptedPrivacyPolicy
Privacy policy accepted. Yes or no value.
This field is optional.
>{Boolean}</HasAcceptedPrivacyPolicy>HasMarketingConsent
Consent to marketing. Yes or no value.
This field is optional.
>{Boolean}</HasMarketingConsent>Contact
This field is optional.
": {FirstName
Firstname/givenname of the contact
This field is optional.
": "{String}",LastName
Surname/familyname/lastname of the contact
This field is optional.
": "{String}",JobTitle
Professional title
This field is optional.
": "{String}",Category
Category of the contact
Applicable domain values can be found here
This field is optional.
": "{String}",ExternalPrivileges
Privileges to external applications for contact
Applicable domain values can be found here
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}",Source
Source of which the personal information was obtained
Applicable domain values can be found here
This field is optional.
": "{Integer}",Privacy
This field is optional.
": {LegalBasisForDataProcessing
The legal basis for processing contact's data
Applicable domain values can be found here
This field is optional.
": "{Integer}",HasAcceptedPrivacyPolicy
Privacy policy accepted. Yes or no value.
This field is optional.
": "{Boolean}",HasMarketingConsent
Consent to marketing. Yes or no value.
This field is optional.
": "{Boolean}"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. |
| $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. Fields colored in grey is expandable fields.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
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 100053 HTTP 403 | You have only admittance to your own suppliers |
| Error 101420 HTTP 404 | Setting definition not found |