Update Customer

Beta

PATCH/v1/sales/customers/{id}

Idempotent with Idempotency-Key header. Learn more

Partially updates a customer account. When a Stripe integration is active, customer changes are synced to Stripe.

idstring

Customer ID.

include[]optional arrayenumValues:bill_to_addressship_to_addresstype

Sub-objects to expand in the response. When omitted, sub-objects are returned as null.

nameoptional string

Customer name.

numberoptional string

Customer number.

noteoptional stringnullable

Note. Send null to clear.

statusoptional stringenumValues:normalpreferredhold_shipment

Account status code.

emailoptional stringnullable

Email address. Send null to clear.

phoneoptional stringnullable

Phone number. Send null to clear.

urloptional stringnullable

Website URL. Send null to clear.

is_edi_enabledoptional boolean

Whether EDI is enabled.

commission_policyoptional stringenumValues:commission_appliedcommission_exempt

Commission policy.

freight_policyoptional stringenumValues:free_freightbilled_freight

Freight policy.

default_carrier_idoptional string

Default carrier ID.

default_service_level_idoptional stringnullable

Default service level ID. Send null to clear.

default_payment_term_idoptional string

Default payment term ID.

default_shipping_term_idoptional string

Default shipping term ID.

default_priorityoptional stringenumValues:lownormalhigh

Default priority code.

default_sales_rep_user_idoptional stringnullable

Default sales rep user ID. Send null to clear.

bill_to_address_idoptional stringnullable

Bill-to address ID. Send null to clear.

ship_to_address_idoptional stringnullable

Ship-to address ID. Send null to clear.

customer_price_group_idsoptional array of string

Price group IDs. Replaces all existing price groups when provided.

customer_type_group_idoptional string

Customer type group ID.

carrier_billing_typeoptional stringenumValues:senderthird_party

Carrier billing type.

carrier_billing_accountoptional stringnullable

Carrier billing account number. Send null to clear.

credit_limitoptional objectnullable

Credit limit. Send null to clear.

valuestring (decimal)

The decimal value.

unit_idstring

The unit ID for the value.

idstring

Customer ID.

objectstringenumValues:customer

Resource type identifier.

namestring

Display name.

numberstring

Customer number.

statusstringenumValues:normalpreferredhold_shipment

Account status code.

is_edi_enabledboolean

Whether EDI is enabled.

is_parent_accountboolean

Whether this is a parent account.

commission_policystringenumValues:commission_appliedcommission_exempt

Commission policy.

notestringnullable

Note.

credit_limitobjectExpandablenullable

Credit limit.

idstring

Quantity ID.

objectstringenumValues:quantity

Resource type identifier.

valuestring (decimal)

Decimal value.

display_valuestring

Formatted value with unit abbreviation (e.g. "$1,234.56" or "100 kg").

unitobjectnullable

Associated unit.

Always returned as null in this endpoint.

contact_infoobjectExpandablenullable

Contact information.

objectstringenumValues:customer_contact_info

Resource type identifier.

emailstringnullable

Email address.

phonestringnullable

Phone number.

urlstringnullable

Website URL.

freight_preferencesobjectExpandablenullable

Freight preferences.

objectstringenumValues:customer_freight_preferences

Resource type identifier.

statusstringenumValues:free_freightbilled_freight

Freight policy.

carrierobjectExpandablenullable

Default carrier.

idstring

Carrier ID.

objectstringenumValues:carrier

Resource type identifier.

namestring

Display name.

codestringnullableenumValues:fedexupsusps

Carrier code.

account_numberstringnullable

Account number.

customer_portal_visibilitystringenumValues:visiblehidden

Customer portal visibility.

ownerobjectnullable

Owner.

Always returned as null in this endpoint.

service_levelsobjectnullable

Service levels.

Always returned as null in this endpoint.

deleted_atstring (date-time)nullable

Soft-delete timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

service_levelobjectExpandablenullable

Default service level.

idstring

Service level ID.

objectstringenumValues:service_level

Resource type identifier.

namestring

Display name.

service_level_tokenstring

Service level token.

customer_portal_visibilitystringenumValues:visiblehidden

Customer portal visibility.

is_defaultboolean

Default service level for the carrier.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

billing_typestringnullableenumValues:senderthird_party

Carrier billing type.

billing_accountstringnullable

Carrier billing account number.

defaultsobjectExpandablenullable

Default settings.

objectstringenumValues:customer_defaults

Resource type identifier.

payment_termobjectExpandablenullable

Default payment term.

idstring

Payment term ID.

objectstringenumValues:payment_term

Resource type identifier.

namestring

Display name.

statusstringenumValues:active|inactive

Payment term status.

ownerobjectnullable

Owner of this resource.

Always returned as null in this endpoint.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last-updated timestamp.

shipping_termobjectExpandablenullable

Default shipping term.

idstring

Shipping term ID.

objectstringenumValues:shipping_term

Resource type identifier.

namestring

Display name.

typestringenumValues:free_freightflat_rate_freightcarrier_rate_freight

Shipping term type.

ownerobjectnullable

Owner.

Always returned as null in this endpoint.

flat_rateobjectnullable

Flat rate quantity, if any.

Always returned as null in this endpoint.

minimum_order_valueobjectnullable

Minimum order value quantity, if any.

Always returned as null in this endpoint.

free_shipping_service_levelsobjectnullable

Service levels that qualify for free shipping.

Always returned as null in this endpoint.

created_atstring (date-time)

When this shipping term was created.

updated_atstring (date-time)

When this shipping term was last updated.

priorityobjectExpandablenullable

Default priority.

idstring

Priority ID.

objectstringenumValues:priority

Resource type identifier.

codestringenumValues:lownormalhigh

Machine-readable code.

namestring

Display name.

ownerobjectnullable

Owner of this resource.

Always returned as null in this endpoint.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

sales_repobjectExpandablenullable

Default sales rep.

idstring

User ID.

objectstringenumValues:user

Resource type identifier.

emailstringnullable

Email address.

namestringnullable

Display name.

usernamestringnullable

Username.

email_verified_atstring (date-time)nullable

Email verified timestamp, null if unverified.

image_urlstringnullable

Profile image URL.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

notification_preferencesobjectExpandablenullable

Notification preferences.

objectstringenumValues:customer_notification_preferences

Resource type identifier.

accepts_invoice_emailsboolean

Whether invoice emails are accepted.

bill_to_addressobjectExpandablenullable

Default billing address.

idstring

Address ID.

objectstringenumValues:address

Resource type identifier.

namestring

Display name of the address.

phonestringnullable

Phone number associated with the address.

emailstringnullable

Email address associated with the address.

is_drop_shipboolean

Whether the address is a drop ship location.

geolocationobjectnullable

Geolocation details for the address.

Always returned as null in this endpoint.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

ship_to_addressobjectExpandablenullable

Default shipping address.

idstring

Address ID.

objectstringenumValues:address

Resource type identifier.

namestring

Display name of the address.

phonestringnullable

Phone number associated with the address.

emailstringnullable

Email address associated with the address.

is_drop_shipboolean

Whether the address is a drop ship location.

geolocationobjectnullable

Geolocation details for the address.

Always returned as null in this endpoint.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

typeobjectExpandablenullable

Customer type group.

price_groupsobjectExpandablenullable

Pricing groups.

objectstringenumValues:list

Object type for AccountGroup list

page_infoobject

Pagination metadata for AccountGroup list

next_cursorstringnullable

Cursor to fetch the next page, null if no more pages.

prev_cursorstringnullable

Cursor to fetch the previous page, null if on the first page.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of object

Array of AccountGroup resources in this page

idstring

Account group ID.

objectstringenumValues:account_group

Resource type identifier.

namestring

Display name.

descriptionstringnullable

Description.

commission_policystringenumValues:commission_appliedcommission_exempt

Commission policy.

freight_policystringenumValues:free_freightbilled_freight

Freight policy.

typestringenumValues:pricing_grouptype_group

Account group type.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

parent_accountobjectExpandablenullable

Parent account. Present if this is a child account.

idstring

Customer ID.

objectstringenumValues:customer

Resource type identifier.

namestring

Display name.

numberstring

Customer number.

statusstringenumValues:normalpreferredhold_shipment

Account status code.

is_edi_enabledboolean

Whether EDI is enabled.

is_parent_accountboolean

Whether this is a parent account.

commission_policystringenumValues:commission_appliedcommission_exempt

Commission policy.

notestringnullable

Note.

credit_limitobjectExpandablenullable

Credit limit.

Always returned as null in this endpoint.

contact_infoobjectExpandablenullable

Contact information.

Always returned as null in this endpoint.

freight_preferencesobjectExpandablenullable

Freight preferences.

Always returned as null in this endpoint.

defaultsobjectExpandablenullable

Default settings.

Always returned as null in this endpoint.

notification_preferencesobjectExpandablenullable

Notification preferences.

Always returned as null in this endpoint.

bill_to_addressobjectExpandablenullable

Default billing address.

Always returned as null in this endpoint.

ship_to_addressobjectExpandablenullable

Default shipping address.

Always returned as null in this endpoint.

typeobjectExpandablenullable

Customer type group.

Always returned as null in this endpoint.

price_groupsobjectExpandablenullable

Pricing groups.

Always returned as null in this endpoint.

parent_accountobjectExpandablenullable

Parent account. Present if this is a child account.

Always returned as null in this endpoint.

child_accountsobjectExpandablenullable

Child accounts. Present if this is a parent account.

Always returned as null in this endpoint.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

child_accountsobjectExpandablenullable

Child accounts. Present if this is a parent account.

objectstringenumValues:list

Object type for Customer list

page_infoobject

Pagination metadata for Customer list

next_cursorstringnullable

Cursor to fetch the next page, null if no more pages.

prev_cursorstringnullable

Cursor to fetch the previous page, null if on the first page.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of object

Array of Customer resources in this page

idstring

Customer ID.

objectstringenumValues:customer

Resource type identifier.

namestring

Display name.

numberstring

Customer number.

statusstringenumValues:normalpreferredhold_shipment

Account status code.

is_edi_enabledboolean

Whether EDI is enabled.

is_parent_accountboolean

Whether this is a parent account.

commission_policystringenumValues:commission_appliedcommission_exempt

Commission policy.

notestringnullable

Note.

credit_limitobjectnullable

Credit limit.

Always returned as null in this endpoint.

contact_infoobjectnullable

Contact information.

Always returned as null in this endpoint.

freight_preferencesobjectnullable

Freight preferences.

Always returned as null in this endpoint.

defaultsobjectnullable

Default settings.

Always returned as null in this endpoint.

notification_preferencesobjectnullable

Notification preferences.

Always returned as null in this endpoint.

bill_to_addressobjectnullable

Default billing address.

Always returned as null in this endpoint.

ship_to_addressobjectnullable

Default shipping address.

Always returned as null in this endpoint.

typeobjectnullable

Customer type group.

Always returned as null in this endpoint.

price_groupsobjectnullable

Pricing groups.

Always returned as null in this endpoint.

parent_accountobjectnullable

Parent account. Present if this is a child account.

Always returned as null in this endpoint.

child_accountsobjectnullable

Child accounts. Present if this is a parent account.

Always returned as null in this endpoint.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Responses

200

Successful response for Update Customer

Update Customer

curl API_HOST/v1/sales/customers/{id} \
  -X PATCH \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Augno-Version: 1.0.forge-preview.1" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Acme Corp Updated",
  "note": "Updated account notes",
  "freight_policy": "billed_freight",
  "default_carrier_id": "cr_01jm4r6700f8nwq3v5hx2d9ktp",
  "credit_limit": {}
}'

curl API_HOST/v1/sales/customers/{id} \
  -X PATCH \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Augno-Version: 1.0.forge-preview.1" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Acme Corp Updated",
  "note": "Updated account notes",
  "freight_policy": "billed_freight",
  "default_carrier_id": "cr_01jm4r6700f8nwq3v5hx2d9ktp",
  "credit_limit": {}
}'

200 example

{
  "id": "ac_01gf7a8200er3ar3pkfrb6kk29",
  "object": "customer",
  "name": "Acme Inc.",
  "number": "100042",
  "status": "normal",
  "is_edi_enabled": false,
  "is_parent_account": false,
  "commission_policy": "commission_applied",
  "note": "Preferred customer since 2020.",
  "credit_limit": {
    "id": "qty_01jm4r6700f8nwq3v5hx2d9ktp",
    "object": "quantity",
    "value": "1234.56",
    "display_value": "$1,234.56",
    "unit": null
  },
  "contact_info": {
    "object": "customer_contact_info",
    "email": "orders@acme.com",
    "phone": "555-123-4567",
    "url": "https://acme.com"
  },
  "freight_preferences": {
    "object": "customer_freight_preferences",
    "status": "billed_freight",
    "carrier": {
      "id": "cr_01jm4r6700f8nwq3v5hx2d9ktp",
      "object": "carrier",
      "name": "FedEx",
      "code": "fedex",
      "account_number": null,
      "customer_portal_visibility": "visible",
      "owner": null,
      "service_levels": null,
      "deleted_at": null,
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    },
    "service_level": {
      "id": "crop_01jm4r6700f8nwq3v5hx2d9ktp",
      "object": "service_level",
      "name": "FedEx Ground",
      "service_level_token": "fedex_ground",
      "customer_portal_visibility": "visible",
      "is_default": false,
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    },
    "billing_type": "sender",
    "billing_account": "123456789"
  },
  "defaults": {
    "object": "customer_defaults",
    "payment_term": {
      "id": "pytm_01jm4r6700f8nwq3v5hx2d9ktp",
      "object": "payment_term",
      "name": "Net 30",
      "status": "active",
      "owner": null,
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    },
    "shipping_term": {
      "id": "shtm_01jm4r6700f8nwq3v5hx2d9ktp",
      "object": "shipping_term",
      "name": "Prepaid",
      "type": "carrier_rate_freight",
      "owner": null,
      "flat_rate": null,
      "minimum_order_value": null,
      "free_shipping_service_levels": null,
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    },
    "priority": {
      "id": "pi_01jm4r6700f8nwq3v5hx2d9ktp",
      "object": "priority",
      "code": "normal",
      "name": "Normal",
      "owner": null,
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    },
    "sales_rep": {
      "id": "us_01gf7a8200e9pvbd6bgyq395ae",
      "object": "user",
      "email": "jdoe@augno.com",
      "name": "John Doe",
      "username": "jdoe",
      "email_verified_at": "2026-06-10T00:00:00Z",
      "image_url": "https://cdn.augno.com/avatars/us_01gf7a8200e9pvbd6bgyq395ae.jpg",
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    }
  },
  "notification_preferences": {
    "object": "customer_notification_preferences",
    "accepts_invoice_emails": true
  },
  "bill_to_address": {
    "id": "ad_01jm4r6700f8nwq3v5hx2d9ktp",
    "object": "address",
    "name": "Headquarters",
    "phone": null,
    "email": null,
    "is_drop_ship": false,
    "geolocation": null,
    "created_at": "2026-05-10T00:00:00Z",
    "updated_at": "2026-05-10T00:23:00Z"
  },
  "ship_to_address": {
    "id": "ad_01jm4r6700f8nwq3v5hx2d9ktp",
    "object": "address",
    "name": "Headquarters",
    "phone": null,
    "email": null,
    "is_drop_ship": false,
    "geolocation": null,
    "created_at": "2026-05-10T00:00:00Z",
    "updated_at": "2026-05-10T00:23:00Z"
  },
  "type": {
    "id": "acgp_01jm4r6700f8nwq3v5hx2d9ktp",
    "object": "account_group",
    "name": "Wholesale Customers",
    "description": null,
    "commission_policy": "commission_applied",
    "freight_policy": "billed_freight",
    "type": "type_group",
    "created_at": "2026-05-10T00:00:00Z",
    "updated_at": "2026-05-10T00:23:00Z"
  },
  "price_groups": {
    "object": "list",
    "page_info": {
      "next_cursor": null,
      "prev_cursor": null,
      "has_next_page": false,
      "has_prev_page": false
    },
    "data": [
      {
        "id": "acgp_01jm4r6700f8nwq3v5hx2d9ktp",
        "object": "account_group",
        "name": "Wholesale Customers",
        "description": null,
        "commission_policy": "commission_applied",
        "freight_policy": "billed_freight",
        "type": "type_group",
        "created_at": "2026-05-10T00:00:00Z",
        "updated_at": "2026-05-10T00:23:00Z"
      }
    ]
  },
  "parent_account": null,
  "child_accounts": null,
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

{
  "id": "ac_01gf7a8200er3ar3pkfrb6kk29",
  "object": "customer",
  "name": "Acme Inc.",
  "number": "100042",
  "status": "normal",
  "is_edi_enabled": false,
  "is_parent_account": false,
  "commission_policy": "commission_applied",
  "note": "Preferred customer since 2020.",
  "credit_limit": {
    "id": "qty_01jm4r6700f8nwq3v5hx2d9ktp",
    "object": "quantity",
    "value": "1234.56",
    "display_value": "$1,234.56",
    "unit": null
  },
  "contact_info": {
    "object": "customer_contact_info",
    "email": "orders@acme.com",
    "phone": "555-123-4567",
    "url": "https://acme.com"
  },
  "freight_preferences": {
    "object": "customer_freight_preferences",
    "status": "billed_freight",
    "carrier": {
      "id": "cr_01jm4r6700f8nwq3v5hx2d9ktp",
      "object": "carrier",
      "name": "FedEx",
      "code": "fedex",
      "account_number": null,
      "customer_portal_visibility": "visible",
      "owner": null,
      "service_levels": null,
      "deleted_at": null,
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    },
    "service_level": {
      "id": "crop_01jm4r6700f8nwq3v5hx2d9ktp",
      "object": "service_level",
      "name": "FedEx Ground",
      "service_level_token": "fedex_ground",
      "customer_portal_visibility": "visible",
      "is_default": false,
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    },
    "billing_type": "sender",
    "billing_account": "123456789"
  },
  "defaults": {
    "object": "customer_defaults",
    "payment_term": {
      "id": "pytm_01jm4r6700f8nwq3v5hx2d9ktp",
      "object": "payment_term",
      "name": "Net 30",
      "status": "active",
      "owner": null,
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    },
    "shipping_term": {
      "id": "shtm_01jm4r6700f8nwq3v5hx2d9ktp",
      "object": "shipping_term",
      "name": "Prepaid",
      "type": "carrier_rate_freight",
      "owner": null,
      "flat_rate": null,
      "minimum_order_value": null,
      "free_shipping_service_levels": null,
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    },
    "priority": {
      "id": "pi_01jm4r6700f8nwq3v5hx2d9ktp",
      "object": "priority",
      "code": "normal",
      "name": "Normal",
      "owner": null,
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    },
    "sales_rep": {
      "id": "us_01gf7a8200e9pvbd6bgyq395ae",
      "object": "user",
      "email": "jdoe@augno.com",
      "name": "John Doe",
      "username": "jdoe",
      "email_verified_at": "2026-06-10T00:00:00Z",
      "image_url": "https://cdn.augno.com/avatars/us_01gf7a8200e9pvbd6bgyq395ae.jpg",
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    }
  },
  "notification_preferences": {
    "object": "customer_notification_preferences",
    "accepts_invoice_emails": true
  },
  "bill_to_address": {
    "id": "ad_01jm4r6700f8nwq3v5hx2d9ktp",
    "object": "address",
    "name": "Headquarters",
    "phone": null,
    "email": null,
    "is_drop_ship": false,
    "geolocation": null,
    "created_at": "2026-05-10T00:00:00Z",
    "updated_at": "2026-05-10T00:23:00Z"
  },
  "ship_to_address": {
    "id": "ad_01jm4r6700f8nwq3v5hx2d9ktp",
    "object": "address",
    "name": "Headquarters",
    "phone": null,
    "email": null,
    "is_drop_ship": false,
    "geolocation": null,
    "created_at": "2026-05-10T00:00:00Z",
    "updated_at": "2026-05-10T00:23:00Z"
  },
  "type": {
    "id": "acgp_01jm4r6700f8nwq3v5hx2d9ktp",
    "object": "account_group",
    "name": "Wholesale Customers",
    "description": null,
    "commission_policy": "commission_applied",
    "freight_policy": "billed_freight",
    "type": "type_group",
    "created_at": "2026-05-10T00:00:00Z",
    "updated_at": "2026-05-10T00:23:00Z"
  },
  "price_groups": {
    "object": "list",
    "page_info": {
      "next_cursor": null,
      "prev_cursor": null,
      "has_next_page": false,
      "has_prev_page": false
    },
    "data": [
      {
        "id": "acgp_01jm4r6700f8nwq3v5hx2d9ktp",
        "object": "account_group",
        "name": "Wholesale Customers",
        "description": null,
        "commission_policy": "commission_applied",
        "freight_policy": "billed_freight",
        "type": "type_group",
        "created_at": "2026-05-10T00:00:00Z",
        "updated_at": "2026-05-10T00:23:00Z"
      }
    ]
  },
  "parent_account": null,
  "child_accounts": null,
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

Update Customer

Path Parameters

Query Parameters

Request Body

Returns

Responses