Change addresses

The user needs to be logged in to use this endpoint, click here to read more.

Address API for current and future temporary or permanent address changes.

curl --location --request POST 'https://api.mediaconnect.no/capi/v1/customer/address' \ --header 'Content-Type: application/json' \ --data-raw '{ "product": "CO27409", "changeType": "update", "id": 3, "careOfAddress": "", "streetAddress": "Grubbegata", "streetNumber": 6, "entrance": "A", "postalCode": 179, "postalPlace": "Oslo", "postalAddress": "Postboks 265 Økern", "postalAddressPostalCode": "0510", "postalAddressPostalPlace": "Oslo", "countryCode": "NO", "period": { "startTime": 1559393560000, "endTime": 1562158360000 } }'

{ "addressList": [ { "product": "CO27409", "addressType": "delivery", "id": 3, "careOfAddress": "", "streetAddress": "Grubbegata", "streetNumber": 6, "entrance": "A", "floor": 6, "suite": "", "postalCode": 179, "postalPlace": "Oslo", "postalAddress": "Postboks 265 Økern", "postalAddressPostalCode": "0510", "postalAddressPostalPlace": "Oslo", "countryCode": "NO", "period": { "startTime": 1559393560000, "endTime": 1562158360000 } } ] }

Request

Authorization

OAuth 2.0

Authorization Code

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Authorize URL: https://connectid.no/user/oauth/authorize

Token URL: https://connectid.no/user/oauth/token

Refresh URL: https://connectid.no/user/oauth/token

Scopes:

read-For all access

Body Params application/json

product

string

optional

Product code: Multiple values separated by comma (each value maximum 12 character). Required unless changeType is createPermanent.

<= 12 characters

changeType

enum<string>

required

The type of this address change. Types must be one of:

update: Either requires an id for a current/future address, or updates the current home address. Specified dates but no id means a failure.

delete: Requires an id for a future address, only works until that address' start date has not been reached

create: Creates a future address change, can optionally take an id from a historical address to reuse that address, requires product

createPermanent: Same as create, but creates a permanent future address change, ignores product and end time

It is not possible to update the address data on a future address change, this is done by deleting an id and creating a new one with the correct address. When a period is specified to an update request, it is implied that the change is to be done to a future address change.

Allowed values:

updatedeletecreatecreatePermanent

integer

optional

Unique id for an address to use.

This is required in these instances:

Update of the period on a future address change.

Deleting a future address change.

Creating a future address change using an historical address.

This is optional in these instances:

Updating the current home address.

These instances will lead to errors:

Specifying the id for the current home address, but specifying period data on an update.

Leaving the id blank when specifying period data on an update.

Specifying the id for the current home address when creating a new future address change.

Leaving the id blank when deleting a future address change.

careOfAddress

string

optional

The C/O for this address change.

<= 40 characters

streetAddress

string

optional

The street for this address change

<= 40 characters

streetNumber

integer

optional

The street number for this address change

entrance

string

optional

The entrance for this address change

<= 12 characters

postalCode

string

optional

The postal code for this address change

<= 10 characters

postalPlace

string

optional

The postal place for this address change

<= 30 characters

postalAddress

string

optional

The postal address for this address change

<= 40 characters

postalAddressPostalCode

string

optional

The postal code for this address change's postal address

<= 10 characters

postalAddressPostalPlace

string

optional

The postal place for this address change's postal address

<= 30 characters

countryCode

string

optional

The country code for this address - ISO 3166 - alpha-2

This field is required for update and create.

<= 3 characters

period

object

optional

startTime

integer

optional

The start of an address's active period.

This field is required when creating a new future address.

Unix Epoch timestamps in milliseconds since 1st January 1970 UTC.

endTime

integer

optional

The end of an address's active period.

Unix Epoch timestamps in milliseconds since 1st January 1970 UTC.

Examples

Responses

🟢200OK

application/json

Body

addressList

array [object {16}]

optional

product

string

optional

The product code

<= 12 characters

addressType

enum<string>

optional

The type of this address item. Types returned on the different query types:

currentAddress: delivery and home

historicalAddress: temporary

futureAddress: temporary and permanent

Allowed values:

deliveryhometemporarypermanent

integer

optional

Unique id for this address

careOfAddress

string

optional

The C/O for this address

<= 40 characters

streetAddress

string

optional

The street for this address

<= 40 characters

streetNumber

integer

optional

The street number for this address

entrance

string

optional

The entrance for this address

<= 12 characters

floor

integer

optional

The floor for this address

suite

string

optional

The suite for this address

<= 10 characters

postalCode

string

optional

The postal code for this address

<= 10 characters

postalPlace

string

optional

The postal place for this address

<= 30 characters

postalAddress

string

optional

The postal address for this address

<= 40 characters

postalAddressPostalCode

string

optional

The postal code for this address's postal address

<= 10 characters

postalAddressPostalPlace

string

optional

The postal place for this address's postal address

<= 30 characters

countryCode

string

optional

The country code for this address - ISO 3166 - alpha-2

<= 3 characters

period

object

optional

Wrapper holding details about an address's active period

🟠400Bad Request

🟠429429

🔴500Server Error