Collaboration APIs
Updates provided address
| HTTP method | PUT |
| URI | https://api.rambase.net/collaboration/contacts/{contactId}/addresses/{addressId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {contactId} |
Contact identifier
Integer, minimum 100000 |
| - URI parameter {addressId} |
Address identifier
Integer, minimum 1 |
| Successful HTTP status code | 200 |
| API resource identifier | 3501, version 1 |
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.
Address
This field is optional.
>Type
Type of address
Applicable domain values can be found here
This field is optional.
>{String}</Type>Name
Name of receiver (Name of company or last name of a person). Note that default invoice address must have the same name as the customer.
This field is optional.
>{String}</Name>Firstname
Firstname if the receiver is a person. Note that default invoice address must have the same firstname as the customer.
This field is optional.
>{String}</Firstname>IsDefault
True if this is the default communication type
This field is optional.
>{Boolean}</IsDefault>Attention
Attention note.
This field is optional.
>{String}</Attention>AddressLine1
First address line
This field is optional.
>{String}</AddressLine1>AddressLine2
Second address line
This field is optional.
>{String}</AddressLine2>PostalCode
Postalcode/Postcode/ZIP
This field is optional.
>{String}</PostalCode>City
City/town/village
This field is optional.
>{String}</City>Region
Region/province/state
This field is optional.
>{String}</Region>CountryCode
Two-character code (ISO 3166) identifying the country.
This field is optional.
>{String}</CountryCode>Address
This field is optional.
": {Type
Type of address
Applicable domain values can be found here
This field is optional.
": "{String}",Name
Name of receiver (Name of company or last name of a person). Note that default invoice address must have the same name as the customer.
This field is optional.
": "{String}",Firstname
Firstname if the receiver is a person. Note that default invoice address must have the same firstname as the customer.
This field is optional.
": "{String}",IsDefault
True if this is the default communication type
This field is optional.
": "{Boolean}",Attention
Attention note.
This field is optional.
": "{String}",AddressLine1
First address line
This field is optional.
": "{String}",AddressLine2
Second address line
This field is optional.
": "{String}",PostalCode
Postalcode/Postcode/ZIP
This field is optional.
": "{String}",City
City/town/village
This field is optional.
": "{String}",Region
Region/province/state
This field is optional.
": "{String}",CountryCode
Two-character code (ISO 3166) identifying the country.
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. |
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 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 |
| Error 100947 HTTP 400 | Region/State is required for provided country |
| Error 100952 HTTP 400 | Country does not have region/state |
| Error 100943 HTTP 400 | Postcode is not valid |
| Error 100944 HTTP 400 | Mismatch between post code and city |