activities4

auth6

bank_integrations11

bank_transaction_rules8

bank_transactions9

charts4

claim_license1

client_gateway_tokens7

clients14

companies10

company_gateways8

company_ledger1

company_user1

connected_account1

credits8

Credits1

designs8

documents1

emails1

expense1

expense_categories8

expenses8

export1

group_settings9

health_check1

import1

imports2

invoices12

locations7

logout1

migration3

one_time_token1

payment_terms7

payment_termss1

payments11

ping2

postmark3

preview2

products9

projects9

Purchase Orders11

quotes12

Recurring Invoices11

recurring_expense1

recurring_expenses8

recurring_quotes9

refresh1

reports27

scheduler1

search1

statics1

subscriptions8

support1

system_logs2

tags8

task_schedulers7

task_status8

tasks10

tax_rates7

templates2

tokens8

update2

users11

vendors9

webcron1

webhooks7

Webhooks1

yodlee1

locations

Bulk location actions

Changed on Apr 20, 2026

POST /api/v1/locations/bulk

Bulk actions allow to make changes to multiple locations in a single request. The following actions are supported:

archive
restore
delete

All of these actions require an array of location ids to perform the requested action on ie.

"ids":['id1','id2']

post/api/v1/locations/bulk

Request

Base URL
https://demo.invoiceninja.com
Auth
none declared. Required headers: X-API-TOKEN, X-Requested-With
TypeScript
https://skmtc.dev/invoiceninja/apis/invoice-ninja-api-reference/docs/api/v1/locations/bulk/post.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

indexstring

Example:user

Replaces the default response index from data to a user specific string

ie.

  ?index=new_index

response is wrapped

  {
    'new_index' : [
      .....  
    ]
  }

Headers

X-API-TOKENstring required

Example:TOKEN

The API token to be used for authentication

X-Requested-Withstring required

Example:XMLHttpRequest

Used to send the XMLHttpRequest header

Request body

actionstring

The action to perform ie. archive / restore / delete

idsstring[]

Example request

{
  "action": "archive",
  "ids": [
    "2J234DFA,D2J234DFA,D2J234DFA"
  ]
}

Response

The Location list Response of the updated locations that were bulk updated

idstring

The location hashed id

namestring

The location name

address1string

The first line of the address

address2string

The second line of the address

citystring

The city name

statestring

The state or region

postal_codestring

The postal or zip code

country_idstring

The ID of the associated country

custom_value1string nullable

Custom field value 1

custom_value2string nullable

Custom field value 2

custom_value3string nullable

Custom field value 3

custom_value4string nullable

Custom field value 4

is_deletedboolean

Indicates if the location has been deleted

is_shipping_locationboolean

Indicates if this is a shipping location

user_idstring

The user hashed id

assigned_user_idstring

The assigned user hashed id

client_idstring

The client hashed id

vendor_idstring

The vendor hashed id

created_atinteger

Timestamp of when the location was created

updated_atinteger

Timestamp of when the location was last updated

Example response

{
  "id": "Kd5S2M",
  "name": "Warehouse A",
  "address1": "123 Business Street",
  "address2": "Suite 100",
  "city": "San Francisco",
  "state": "CA",
  "postal_code": "94107",
  "country_id": "840",
  "is_shipping_location": true,
  "user_id": "Opnel5aKBz",
  "assigned_user_id": "Opnel5aKBz",
  "client_id": "Opnel5aKBz",
  "vendor_id": "Opnel5aKBz",
  "created_at": 1623456789,
  "updated_at": 1623456999
}

Changes

Apr 20, 202669a36036d334 Revision changes
- info
  the response optional property became read-only for the status
May 24, 202593bb427f804b Revision changes
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status

Operation history (4 revisions)