Create Organization Address

$ nirvana organizations:address create

POST/v1/organizations/{organization_id}/address

Create the address for an organization

ParametersExpand Collapse

--organization-id: string

Organization ID

--city: string

City or locality.

--country: string

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

--line1: string

First line of the street address.

--postal-code: string

Postal or ZIP code.

--line2: optional string

Second line of the street address (suite, unit, building).

--state: optional string

State, province, or region. Required by some tax jurisdictions (e.g. US, CA).

--tax-id: optional string

Tax identification number (e.g. VAT, EIN, ABN). Optional.

--tax-id-type: optional string

Type of the tax identification number (e.g. eu_vat, us_ein, gb_vat, au_abn). Optional.

ReturnsExpand Collapse

organization_address: 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.

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.

Create Organization Address

nirvana organizations:address create \
  --api-key 'My API Key' \
  --organization-id organization_id \
  --city 'San Francisco' \
  --country US \
  --line1 '123 Main St' \
  --postal-code 94105

{
  "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"
}