v1

latestSwagger 2.0Private2026-08-04128286690.5 KB
Account Services

POST the Physical Address for the Account

Use this method to add the address where the account's organization physically resides. The physical address is required to send emails and displays on the footer of every email that is sent from the account. The country (<code>country_code</code>) where the account organization resides determines whether you use the <code>state_code</code> to specify United States (<code>US</code>) and Canada (<code>CA</code>) addresses, or use the <code>state_name</code> to specify all other countries.

post/account/summary/physical_address

Request body

address_line1string required

Line 1 of the organization's street address.

address_line2string

Line 2 of the organization's street address.

address_line3string

Line 3 of the organization's street address.

citystring required

The city where the organization is located.

state_codestring

The two letter ISO 3166-1 code for the organization's state and only used if the <code>country_code</code> is <code>US</code> or <code>CA</code>. If not, exclude this property from the request body.

state_namestring

Use if the state where the organization is physically located is not in the United States or Canada. If <code>country_code</code> is <code>US</code> or <code>CA</code>, exclude this property from the request body.

postal_codestring

The postal code address (ZIP code) of the organization. This property is required if the <code>state_code</code> is <code>US</code> or <code>CA</code>, otherwise exclude this property from the request body.

country_codestring required

The two letter <a href='https://en.wikipedia.org/wiki/ISO_3166-1' target='_blank'>ISO 3166-1 code</a> for the organization's country.

Example request

{
  "address_line1": "123 Maple Street",
  "address_line2": "Unit 1",
  "address_line3": "Apartment 234",
  "city": "Boston",
  "state_code": "MA",
  "state_name": "EXCLUDE if country_code is US.",
  "postal_code": "02451",
  "country_code": "US"
}

Response

Request successful

address_line1string required

Line 1 of the organization's street address.

address_line2string

Line 2 of the organization's street address.

address_line3string

Line 3 of the organization's street address.

citystring required

The city where the organization is located.

state_codestring

The two letter ISO 3166-1 code for the organization's state and only used if the <code>country_code</code> is <code>US</code> or <code>CA</code>. If not, exclude this property from the request body.

state_namestring

Use if the state where the organization is physically located is not in the United States or Canada. If <code>country_code</code> is <code>US</code> or <code>CA</code>, exclude this property from the request body.

postal_codestring

The postal code address (ZIP code) of the organization. This property is required if the <code>state_code</code> is <code>US</code> or <code>CA</code>, otherwise exclude this property from the request body.

country_codestring required

The two letter <a href='https://en.wikipedia.org/wiki/ISO_3166-1' target='_blank'>ISO 3166-1 code</a> for the organization's country.

Example response

{
  "address_line1": "123 Maple Street",
  "address_line2": "Unit 1",
  "address_line3": "Apartment 234",
  "city": "Boston",
  "state_code": "MA",
  "state_name": "EXCLUDE if country_code is US.",
  "postal_code": "02451",
  "country_code": "US"
}