Skip to content

Add addresses

POST
/api/connector/v1/addresses/add

Adds one or more new addresses to the system and assigns them to specified accounts. Note this operation supports Portfolio Access Tokens.

MultipleAddressAddParameters
object
ClientToken
required

Token identifying the client application.

string
>= 1 characters
AccessToken
required

Access token of the client application.

string
>= 1 characters
Client
required

Name and version of the client application.

string
>= 1 characters
ChainId

Unique identifier of the chain. Required when using Portfolio Access Tokens, ignored otherwise.

string format: uuid
nullable
Addresses
required

Collection of addresses to be created.

Array<object>
>= 1 items <= 1000 items
Account address parameters
object
AccountId
required

Unique identifier of a Company or a Customer within the enterprise.

string format: uuid
Line1

First line of the address.

string
nullable <= 255 characters
Line2

Second line of the address.

string
nullable <= 255 characters
City

The city.

string
nullable <= 255 characters
PostalCode

Postal code.

string format: postal-code
nullable <= 255 characters
CountryCode

ISO 3166-1 alpha-2 code of the Country.

string
nullable
CountrySubdivisionCode

ISO 3166-2 code of the administrative division, e.g. DE-BW.

string
nullable
Latitude

The latitude in range of -90 to 90.

number format: double
nullable >= -90 <= 90
Longitude

The longitude in range of -180 to 180.

number format: double
nullable >= -180 <= 180
Example
{
"ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
"AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
"Client": "Sample Client 1.0.0",
"ChainId": "1df21f06-0cfc-4960-9c58-a3bf1261663e",
"Addresses": [
{
"AccountId": "3db2c989-7d95-42b4-a502-a9f246db1634",
"Line1": "Rheinlanddamm 207-209",
"Line2": null,
"City": "Dortmund",
"PostalCode": "44137",
"CountryCode": "DE",
"CountrySubdivisionCode": null,
"Latitude": null,
"Longitude": null
}
]
}

OK

AddressResult
object
Addresses
required

The collection of added or modified Account addresses, containing address and account information.

Array<object>
Account address
object
Id

Unique identifier of the address.

string format: uuid
AccountId

Unique identifier of a Company or a Customer within the enterprise.

string format: uuid
ChainId

Unique identifier of the chain.

string format: uuid
nullable
AccountType
Any of:
Account type
string
Allowed values: Company Customer
Line1

First line of the address.

string
nullable <= 1023 characters
Line2

Second line of the address.

string
nullable <= 255 characters
City

The city.

string
nullable <= 255 characters
PostalCode

Postal code.

string
nullable <= 255 characters
CountryCode

ISO 3166-1 alpha-2 code of the Country.

string
nullable
CountrySubdivisionCode

ISO 3166-2 code of the administrative division, e.g. DE-BW.

string
nullable
Latitude

The latitude.

number format: double
nullable
Longitude

The longitude.

number format: double
nullable
UpdatedUtc

Last update date and time of the address in UTC timezone in ISO 8601 format.

string format: date-time
nullable
IsActive

Whether the address is still active.

boolean
Example
{
"Addresses": [
{
"Id": "fc7b2df3-de66-48a6-907d-af4600ecd892",
"AccountId": "3db2c989-7d95-42b4-a502-a9f246db1634",
"AccountType": "Customer",
"Line1": "I.P. Pavlova 5",
"Line2": null,
"City": "Prague",
"PostalCode": "12000",
"CountryCode": "CZ",
"CountrySubdivisionCode": null,
"Latitude": null,
"Longitude": null,
"UpdatedUtc": "2023-11-29T14:49:29.982Z",
"IsActive": true
}
]
}

Server has successfully fulfilled the request and there is no additional information to send back.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see Request timeouts

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by too many requests sent in a given amount of time. Response contains Retry-After header indicating how long the user agent should wait before making a follow-up request. For more information, see Request limits.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our documentation repository.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable