PATCH
/
v1
/
addresses
/
{addressId}

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-site-context
string
required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Path Parameters

addressId
string
required

Fabric internal id of the record

Body

application/json
type
enum<string>
required

type of the address. M=Mail, E=Email, P=Postal

Available options:
M,
E,
P
globalAddressId
number

global address id

addressLine1
string

address line 1. If sent it has to contain 1 character or more.

addressLine2
string

address line 2

addressLine3
string

address line 3

addressLine4
string

address line 4

county
string

county

city
string

city

state
string

state

zipCode
number

zipCode

postalCode
string

postalCode

country
string

country

latitude
number

latitude

longitude
number

longitude

isDefault
boolean

flag that indicates if the address is default

additionalAttributes
object

Contains all additional attributes not captured in the schema.

Response

200 - application/json
_id
string
required

Fabric internal id of the record

type
enum<string>
required

type of the address. M=Mail, E=Email, P=Postal

Available options:
M,
E,
P
isDeleted
boolean
required

flag that indicates if the record is deleted

isDefault
boolean
required

flag that indicates if the record is default

createdAt
string
required

date of creation of the record

updatedAt
string
required

laste date of update of the record

globalAddressId
number

global address id

addressLine1
string

address line 1

addressLine2
string

address line 2

addressLine3
string

address line 3

addressLine4
string

address line 4

county
string

county

city
string

city

state
string

state

zipCode
number

zipCode

postalCode
string

postalCode

country
string

country

latitude
number

latitude

longitude
number

longitude

additionalAttributes
object

Contains all additional attributes not captured in the schema.

Was this page helpful?

Delete addressOverview