Mercury: Update a customer
Mercury customers.updateCustomer: arguments, response, policy and SDK examples.
← Customers operations · Get started
Operation mercury.updatecustomer
Provider route: POST /ar/customers/{customerId}. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/mercury with npm, or alter-sdk-mercury with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { MercuryIntegration } from "@alter-ai/mercury";
async function execute(input: Parameters<MercuryIntegration["customers"]["updateCustomer"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new MercuryIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.customers.updateCustomer(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_mercury import MercuryIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = MercuryIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.customers.update_customer(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.customerId | string | Required within parent | The customer who will receive the invoice. Use the /api/v1/ar/customers endpoint to list your customers and find the corresponding id, or create a new customer first. Format: uuid |
body | Model | Optional | Expand Update a customer — request body — body |
Referenced models: Update a customer — request body — body
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Get a customer — response body |
Referenced models: Get a customer — response body
Schemas
Section titled “Schemas”Get a customer — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Response data for Accounts Receivable customer API endpoints |
address | JSON | Optional | |
address (anyOf 1) | JSON | Alternative | |
address (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get a customer — response body — address Address of customer address1, address2, city, country, postal Code, region |
address (anyOf 1) (allOf 2) | JSON | All variants apply | Address of customer. |
address (anyOf 2) | null | Alternative | |
deletedAt | JSON | Optional | |
deletedAt (anyOf 1) | JSON | Alternative | |
deletedAt (anyOf 1) (allOf 1) | string | All variants apply | Format: yyyy-mm-ddThh:MM:ssZ |
deletedAt (anyOf 1) (allOf 2) | JSON | All variants apply | The time the customer was deleted, if it was deleted. |
deletedAt (anyOf 2) | null | Alternative | |
email | JSON | Required within parent | |
email (allOf 1) | string | All variants apply | |
email (allOf 2) | JSON | All variants apply | Email of customer. |
id | JSON | Required within parent | |
id (allOf 1) | string | All variants apply | The customer who will receive the invoice. Use the /api/v1/ar/customers endpoint to list your customers and find the corresponding id, or create a new customer first. Format: uuid |
id (allOf 2) | JSON | All variants apply | ArCustomerId |
name | string | Required within parent | Name of customer. Maximum length: 5000 Minimum length: 1 |
Referenced models: Get a customer — response body — address Address of customer address1, address2, city, country, postal Code, region
Update a customer — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Request data to update a customer using the public api Additional keys: not allowed |
address | JSON | Optional | |
address (anyOf 1) | JSON | Alternative | |
address (anyOf 1) (allOf 1) | Model | All variants apply | Expand Create a customer — request body — body address The address for the customer Address input for creating or updating customers |
address (anyOf 1) (allOf 2) | JSON | All variants apply | The address for the customer. |
address (anyOf 2) | null | Alternative | |
email | JSON | Required within parent | |
email (allOf 1) | string | All variants apply | |
email (allOf 2) | JSON | All variants apply | The email address for the customer. |
name | string | Required within parent | The name of the customer. Maximum length: 5000 Minimum length: 1 |
resendOpenInvoices | boolean | Required within parent | Open invoices for the customer will be resent with updated data when this is true. |
Referenced models: Create a customer — request body — body address The address for the customer Address input for creating or updating customers
Get a customer — response body — address Address of customer address1, address2, city, country, postal Code, region
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Customer address information for Accounts Receivable API |
address1 | string | Required within parent | Primary street address line. Maximum length: 299 Minimum length: 1 |
address2 | JSON | Optional | |
address2 (anyOf 1) | string | Alternative | Secondary street address line (optional). Maximum length: 299 Minimum length: 1 |
address2 (anyOf 2) | null | Alternative | |
city | string | Required within parent | City name. Maximum length: 299 Minimum length: 1 |
country | JSON | Required within parent | |
country (allOf 1) | string | All variants apply | |
country (allOf 2) | JSON | All variants apply | Two-letter country code (ISO 3166-1 alpha-2). |
postalCode | string | Required within parent | Postal or ZIP code Maximum length: 299 Minimum length: 1 |
region | JSON | Required within parent | |
region (allOf 1) | string | All variants apply | |
region (allOf 2) | JSON | All variants apply | State, province, or region. |
Create a customer — request body — body address The address for the customer Address input for creating or updating customers
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Address input for creating or updating customers Additional keys: not allowed |
address1 | string | Required within parent | Primary street address line. Maximum length: 299 Minimum length: 1 |
address2 | JSON | Optional | |
address2 (anyOf 1) | string | Alternative | Secondary street address line (optional). Maximum length: 299 Minimum length: 1 |
address2 (anyOf 2) | null | Alternative | |
city | string | Required within parent | City name. Maximum length: 299 Minimum length: 1 |
country | JSON | Required within parent | |
country (allOf 1) | string | All variants apply | |
country (allOf 2) | JSON | All variants apply | Two-letter country code (ISO 3166-1 alpha-2). |
name | string | Required within parent | The mailing name of the address. |
postalCode | string | Required within parent | Postal or ZIP code. Maximum length: 299 Minimum length: 1 |
region | JSON | Required within parent | |
region (allOf 1) | string | All variants apply | |
region (allOf 2) | JSON | All variants apply | Either a two-letter US state code i.e. "CA" for California or a free-form identification of a particular region worldwide. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: mercury.updatecustomer. Catalog operation: mercury:updateCustomer. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.