Create address data amendment

Deprecated

Required Scopes: `CUSTOMER_SELF_SERVICE_WRITE` Creates request for address data amendment for specified customerId

Endpoint

POST /v1/customers/{customerId}/self-service/address-data

Path Parameters

customerId required integer (int64)

Unique ID of the customer

Request Body application/json

required

Representing customer address data

street required

Street of the customer

Example:  "Am Bahnhof"
houseNumber

Number of the customer's house

Example:  "90"
zipCode required

Zip code of the customer

Example:  "12133"
city required

City of the customer

Example:  "Munich"
countryCode string(ISO 3166-1) required

Country of the customer

Example:  "DE"
province

Province for southern Europe/US countries

Example:  "Madrid/California"
provinceCode

Province code for southern Europe/US countries

Example:  "MD/CA"
secondStreet

Second street line of the customer's address

Example:  "Second Street"
cityPart

City part of the customer's address

Example:  "Tegel"
district

District of the customer's address

Example:  "District 12"
streetType

Street type of the customer's address

Example:  "Avenue"
streetBlock

Street block of the customer's address

Example:  "5th block"
portal

Portal of the customer's address

Example:  "Portal 1"
stairway

Stairway of the customer's address

Example:  "Right stairway"
door

Door of the customer's address

Example:  "Door 1"
additionalAddressInformation

Additional address information of the customer's address

Example:  "Additional information"
floor

Floor of the customer's address

Example:  "2nd floor"
buildingName

Building name

Example:  "Empire State Building"

Responses

OK

Response Body application/json

id integer(int64)

Amendment proposal id

street required

Street of the customer

Example:  "Am Bahnhof"
houseNumber

Number of the customer's house

Example:  "90"
zipCode required

Zip code of the customer

Example:  "12133"
city required

City of the customer

Example:  "Munich"
countryCode string(ISO 3166-1) required

Country of the customer

Example:  "DE"
province

Province for southern Europe/US countries

Example:  "Madrid/California"
provinceCode

Province code for southern Europe/US countries

Example:  "MD/CA"
secondStreet

Second street line of the customer's address

Example:  "Second Street"
cityPart

City part of the customer's address

Example:  "Tegel"
district

District of the customer's address

Example:  "District 12"
streetType

Street type of the customer's address

Example:  "Avenue"
streetBlock

Street block of the customer's address

Example:  "5th block"
portal

Portal of the customer's address

Example:  "Portal 1"
stairway

Stairway of the customer's address

Example:  "Right stairway"
door

Door of the customer's address

Example:  "Door 1"
additionalAddressInformation

Additional address information of the customer's address

Example:  "Additional information"
floor

Floor of the customer's address

Example:  "2nd floor"
buildingName

Building name

Example:  "Empire State Building"
Validation of the request failed.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value
type
Allowed values:
TIMESTAMP BOOLEAN DATE MONTH_DAY TIME TERM TERM_LIST INTEGER DECIMAL STRING MONEY LIMITABLE_CONFIG_PROPERTY I18N_KEY I18N_KEY_LIST PERMISSION_LIST ENUM AVAILABILITY_LIST
reference

Reference to validation error

Example:  "parent.child"
Authentication failed. No api-key, wrong api-key or wrong header name.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value
type
Allowed values:
TIMESTAMP BOOLEAN DATE MONTH_DAY TIME TERM TERM_LIST INTEGER DECIMAL STRING MONEY LIMITABLE_CONFIG_PROPERTY I18N_KEY I18N_KEY_LIST PERMISSION_LIST ENUM AVAILABILITY_LIST
reference

Reference to validation error

Example:  "parent.child"
Authorization failed. The caller has no privilege to the given resource.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value
type
Allowed values:
TIMESTAMP BOOLEAN DATE MONTH_DAY TIME TERM TERM_LIST INTEGER DECIMAL STRING MONEY LIMITABLE_CONFIG_PROPERTY I18N_KEY I18N_KEY_LIST PERMISSION_LIST ENUM AVAILABILITY_LIST
reference

Reference to validation error

Example:  "parent.child"
Entity does not exists.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value
type
Allowed values:
TIMESTAMP BOOLEAN DATE MONTH_DAY TIME TERM TERM_LIST INTEGER DECIMAL STRING MONEY LIMITABLE_CONFIG_PROPERTY I18N_KEY I18N_KEY_LIST PERMISSION_LIST ENUM AVAILABILITY_LIST
reference

Reference to validation error

Example:  "parent.child"
Concurrent modification detected. The entity was modified by another request.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value
type
Allowed values:
TIMESTAMP BOOLEAN DATE MONTH_DAY TIME TERM TERM_LIST INTEGER DECIMAL STRING MONEY LIMITABLE_CONFIG_PROPERTY I18N_KEY I18N_KEY_LIST PERMISSION_LIST ENUM AVAILABILITY_LIST
reference

Reference to validation error

Example:  "parent.child"
Access denied - rate limit is exceeded.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value
type
Allowed values:
TIMESTAMP BOOLEAN DATE MONTH_DAY TIME TERM TERM_LIST INTEGER DECIMAL STRING MONEY LIMITABLE_CONFIG_PROPERTY I18N_KEY I18N_KEY_LIST PERMISSION_LIST ENUM AVAILABILITY_LIST
reference

Reference to validation error

Example:  "parent.child"
Unexpected system error.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value
type
Allowed values:
TIMESTAMP BOOLEAN DATE MONTH_DAY TIME TERM TERM_LIST INTEGER DECIMAL STRING MONEY LIMITABLE_CONFIG_PROPERTY I18N_KEY I18N_KEY_LIST PERMISSION_LIST ENUM AVAILABILITY_LIST
reference

Reference to validation error

Example:  "parent.child"