Update Organization Address

PATCH/v1/organizations/{organization_id}/address

Update the address for an organization

Path ParametersExpand Collapse

organization_id: string

Body ParametersJSONExpand Collapse

city: optional string

City or locality.

maxLength255

minLength1

country: optional string

Two-letter ISO 3166-1 alpha-2 country code.

line1: optional string

First line of the street address.

maxLength255

minLength1

line2: optional string

Second line of the street address (suite, unit, building). Omit to leave unchanged, send null to clear, or send a value to set it.

maxLength255

postal_code: optional string

Postal or ZIP code.

maxLength255

minLength1

state: optional string

State, province, or region. Omit to leave unchanged, send null to clear, or send a value to set it.

maxLength255

tax_id: optional string

Tax identification number (e.g. VAT, EIN, ABN). Omit to leave unchanged, send null to clear, or send a value to set it.

maxLength255

tax_id_type: optional string

Type of the tax identification number (e.g. eu_vat, us_ein, gb_vat, au_abn). Omit to leave unchanged, send null to clear, or send a value to set it.

maxLength255

ReturnsExpand Collapse

OrganizationAddress object { id, city, country, 9 more }

Organization address details.

id: string

Address ID.

city: string

City or locality.

country: string

Two-letter ISO 3166-1 alpha-2 country code.

created_at: string

When the address was created.

formatdate-time

line1: string

First line of the street address.

line2: string

Second line of the street address. Null when not provided.

organization_id: string

Organization ID the address belongs to.

postal_code: string

Postal or ZIP code.

state: string

State, province, or region. Null when not provided.

tax_id: string

Tax identification number. Null when not provided.

tax_id_type: string

Type of the tax identification number. Null when not provided.

updated_at: string

When the address was updated.

formatdate-time

Update Organization Address

curl https://api.nirvanalabs.io/v1/organizations/$ORGANIZATION_ID/address \
    -X PATCH \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $NIRVANA_LABS_API_KEY" \
    -d '{
          "city": "San Francisco",
          "country": "US",
          "line1": "123 Main St",
          "line2": "Suite 400",
          "postal_code": "94105",
          "state": "CA",
          "tax_id": "EU372000000",
          "tax_id_type": "eu_vat"
        }'

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "city": "San Francisco",
  "country": "US",
  "created_at": "2025-01-01T00:00:00Z",
  "line1": "123 Main St",
  "line2": "Suite 400",
  "organization_id": "123e4567-e89b-12d3-a456-426614174000",
  "postal_code": "94105",
  "state": "CA",
  "tax_id": "EU372000000",
  "tax_id_type": "eu_vat",
  "updated_at": "2025-01-01T00:00:00Z"
}

Returns Examples

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "city": "San Francisco",
  "country": "US",
  "created_at": "2025-01-01T00:00:00Z",
  "line1": "123 Main St",
  "line2": "Suite 400",
  "organization_id": "123e4567-e89b-12d3-a456-426614174000",
  "postal_code": "94105",
  "state": "CA",
  "tax_id": "EU372000000",
  "tax_id_type": "eu_vat",
  "updated_at": "2025-01-01T00:00:00Z"
}