Skip to main content

companyAddressDeleteBulk

Remove several of a company's addresses in one request.

Each id is deleted exactly as companyAddressDelete would delete it, and every deleted address emits its own event. An id that cannot be deleted lands in failedIds with an entry in failures saying why; the rest of the batch is deleted regardless, and repeated ids get one verdict.

An id that belongs to another company reads as ADDRESS_NOT_FOUND_ERROR — the lookup is always scoped to the company in the input.

Possible errors:

  • COMPANY_NOT_FOUND_ERROR: The company itself does not exist, so no id in the request could be read. Nothing was deleted.

AUTH: Role=[user.OWNER] OR (('user is authenticated') AND ('companyId(s) if present in input matches JWT'))

companyAddressDeleteBulk(
input: CompanyAddressBulkDeleteInput!
): AddressBulkDeleteResponse!

Arguments

companyAddressDeleteBulk.input ● CompanyAddressBulkDeleteInput! non-null input

Type

AddressBulkDeleteResponse object