Skip to main content

Approve Application

POST 

/api/admin/portal/applications/:application/approve

Approve an application: provisions a Customer location (with the chosen pricing tier, sales rep, catalog, payment term, credit limit and order-value discount ladder) and a company-admin buyer, then emails the invitation.

Required scope: customers:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Omitting a field is not the same as sending null. An omitted product_pricing_tier_id, payment_term_id, credit_limit or order_discount_tiers_json takes the tenant's approval default (see Get Approval Defaults); sending null sets none, even when a default exists. With no approval defaults configured, an omitted field sets nothing. An omitted or null portal_catalog_id leaves the account on the catalog marked Default.

order_discount_tiers_json (optional) is the new account's order-value discount ladder, e.g. [{"min_subtotal": 5000, "percent": 5}]. At most 10 tiers; thresholds must be distinct and each percentage must exceed the one below it, or the request is rejected with 422.

payment_term_id must reference an existing payment term.

The applicant's website, tax ID and resale certificate number are copied to the new customer (website, tax_id, tax_exemption_reference), and an uploaded resale certificate is filed in the document store linked to the customer. tax_exempt (optional, default false) marks the new customer tax exempt; it is never inferred from the application.

portal_catalog_ids (array of catalog ids, nullable): the new account's catalogs — it sees their union. Omitted → the tenant's approval-default catalogs (approval_default_catalog_ids); null or [] → none, so the account follows the catalog marked Default. The legacy single portal_catalog_id is still accepted as a one-item list; sending both is a 422.

The applicant's resale certificate number, issuing state and expiry are copied to the customer (tax_exemption_reference, tax_exemption_state, tax_exemption_expires_on). tax_exempt is only set when the reviewer sends it — a verified certificate never sets it.

store_id (optional, nullable): the store the new customer belongs to, which decides which store's portal brand its dealers see and which store their orders are placed on. Omitted, the store the applicant registered through (requested_store_id) is used; null sets no store. Must be an active (not archived) store.

Request​

Responses​

OK

Response Headers
    Content-Type