Customers

Update customer (partial)

Update specific fields on a customer. Send only the fields you want to change — anything you don’t send stays as it is. To clear a nullable field, send null.

Example — rename a customer:

{"name": "Acme Holdings, Inc."}

Example — update phone and website together:

{"phone": "555-0199", "website": "https://acme.example"}

Custom fields

Set custom fields by name:

{"custom_fields": [{"Partner": true}, {"Tier": "Gold"}]}

Each item is a one-key object where the key is the custom field’s name and the value is whatever you want to set. Use null to clear a field. If the name doesn’t match a custom field in your organization you’ll get a 422 back — we won’t silently ignore it. If you happen to have two custom fields with the same name, use the id-based shape:

{"custom_fields": [{"field": {"id": 42}, "value": {"custom_field_id": 42, "value": "Acme"}}]}

Omitting custom_fields from the request leaves existing values untouched.

PATCH

public

customers

{customer_id}

Update customer (partial)

curl --request PATCH \
  --url https://api.dualentry.com/public/v1/customers/{customer_id}/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "custom_fields": [
    {}
  ],
  "name": "<string>",
  "unique_id": "<string>",
  "email": "<string>",
  "address": "<string>",
  "country": "<string>",
  "phone": "<string>",
  "website": "<string>",
  "full_address": {
    "street": "<string>",
    "city": "<string>",
    "postal_code": "<string>",
    "state": "",
    "country": "",
    "second_line": "",
    "name": "<string>"
  },
  "shipping_address": {
    "street": "<string>",
    "city": "<string>",
    "postal_code": "<string>",
    "state": "",
    "country": "",
    "second_line": "",
    "name": "<string>"
  }
}
'

{
  "id": 123,
  "address": "<string>",
  "country": "<string>",
  "name": "<string>",
  "unique_id": "<string>",
  "website": "<string>",
  "email": "<string>",
  "customer_type": "<string>",
  "is_active": true,
  "phone": "<string>",
  "record_status": "<string>",
  "is_taxable": true,
  "default_tax_code": "<string>",
  "tax_registration_number": "<string>",
  "custom_fields": [],
  "created_by": {
    "actor_type": "<string>",
    "email": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  },
  "updated_by": {
    "actor_type": "<string>",
    "email": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  },
  "approval_status": "<string>",
  "next_approvers": [
    {
      "id": 123,
      "first_name": "<string>",
      "last_name": "<string>",
      "email": "<string>",
      "full_name": "<string>",
      "avatar_url": "<string>"
    }
  ],
  "rejected_by": {
    "id": 123,
    "first_name": "<string>",
    "last_name": "<string>",
    "email": "<string>",
    "full_name": "<string>",
    "rejection_reason": "<string>"
  },
  "shipping_address": {
    "street": "<string>",
    "city": "<string>",
    "postal_code": "<string>",
    "state": "",
    "country": "",
    "second_line": "",
    "name": "<string>"
  }
}

Authorizations

X-API-KEY

string

header

required

Path Parameters

customer_id

integer

required

Body

application/json

Partial update payload for PATCH /public/customers/{id}/.

Every field is optional: send only the fields you want to change. Unset fields are left untouched on the existing record.

custom_fields

Custom Fields · object[] | null

name

string | null

unique_id

string | null

Required string length: 1 - 64

string | null

address

string | null

country

string | null

phone

string | null

Maximum string length: 32

Pattern: ^[0-9\s\+\-\.]*$

website

string | null

full_address

AddressSchemaIn · object

Show child attributes

shipping_address

AddressSchemaIn · object

Show child attributes

Response

integer

required

address

string

required

country

string

required

name

string

required

unique_id

string | null

required

website

string

required

string

required

customer_type

string

required

is_active

boolean

required

phone

string

required

record_status

string

required

is_taxable

boolean

required

default_tax_code

string

required

tax_registration_number

string

required

default_currency

required

Available options:

AED,

AFN,

ALL,

AMD,

ANG,

AOA,

ARS,

AUD,

AWG,

AZN,

BAM,

BBD,

BDT,

BGN,

BHD,

BIF,

BMD,

BND,

BOB,

BRL,

BSD,

BTN,

BWP,

BYN,

BZD,

CAD,

CDF,

CHF,

CLF,

CLP,

CNY,

COP,

CRC,

CUP,

CVE,

CZK,

DJF,

DKK,

DOP,

DZD,

EGP,

ERN,

ETB,

EUR,

FJD,

FKP,

GBP,

GEL,

GHS,

GIP,

GMD,

GNF,

GTQ,

GYD,

HKD,

HNL,

HTG,

HUF,

IDR,

ILS,

INR,

IQD,

IRR,

ISK,

JMD,

JOD,

JPY,

KES,

KGS,

KHR,

KMF,

KPW,

KRW,

KWD,

KYD,

KZT,

LAK,

LBP,

LKR,

LRD,

LSL,

LYD,

MAD,

MDL,

MGA,

MKD,

MMK,

MNT,

MOP,

MRU,

MUR,

MVR,

MWK,

MXN,

MYR,

MZN,

NAD,

NGN,

NIO,

NOK,

NPR,

NZD,

OMR,

PAB,

PEN,

PGK,

PHP,

PKR,

PLN,

PYG,

QAR,

RON,

RSD,

RUB,

RWF,

SAR,

SBD,

SCR,

SDG,

SEK,

SGD,

SHP,

SLL,

SOS,

SRD,

STN,

SVC,

SYP,

SZL,

THB,

TJS,

TMT,

TND,

TOP,

TRY,

TTD,

TWD,

TZS,

UAH,

UGX,

USD,

UYU,

UZS,

VES,

VND,

VUV,

WST,

XAF,

XAG,

XAU,

XCD,

XDR,

XOF,

XPD,

XPF,

XPT,

YER,

ZAR,

ZMW,

ZWL

custom_fields

CustomFieldValuePairOutputSchema · object[]

Show child attributes

created_by

AuditActorSchemaOut · object

Schema for audit actor information.

Show child attributes

updated_by

AuditActorSchemaOut · object

Schema for audit actor information.

Show child attributes

approval_status

string | null

next_approvers

ApproverDictSchema · object[] | null

Show child attributes

rejected_by

RejectedBySchema · object

Schema for rejector information including rejection reason.

Show child attributes

shipping_address

AddressSchemaIn · object

Show child attributes

Last modified on May 28, 2026

Delete customer

List Items

⌘I

Update customer (partial)

curl --request PATCH \
  --url https://api.dualentry.com/public/v1/customers/{customer_id}/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "custom_fields": [
    {}
  ],
  "name": "<string>",
  "unique_id": "<string>",
  "email": "<string>",
  "address": "<string>",
  "country": "<string>",
  "phone": "<string>",
  "website": "<string>",
  "full_address": {
    "street": "<string>",
    "city": "<string>",
    "postal_code": "<string>",
    "state": "",
    "country": "",
    "second_line": "",
    "name": "<string>"
  },
  "shipping_address": {
    "street": "<string>",
    "city": "<string>",
    "postal_code": "<string>",
    "state": "",
    "country": "",
    "second_line": "",
    "name": "<string>"
  }
}
'

{
  "id": 123,
  "address": "<string>",
  "country": "<string>",
  "name": "<string>",
  "unique_id": "<string>",
  "website": "<string>",
  "email": "<string>",
  "customer_type": "<string>",
  "is_active": true,
  "phone": "<string>",
  "record_status": "<string>",
  "is_taxable": true,
  "default_tax_code": "<string>",
  "tax_registration_number": "<string>",
  "custom_fields": [],
  "created_by": {
    "actor_type": "<string>",
    "email": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  },
  "updated_by": {
    "actor_type": "<string>",
    "email": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  },
  "approval_status": "<string>",
  "next_approvers": [
    {
      "id": 123,
      "first_name": "<string>",
      "last_name": "<string>",
      "email": "<string>",
      "full_name": "<string>",
      "avatar_url": "<string>"
    }
  ],
  "rejected_by": {
    "id": 123,
    "first_name": "<string>",
    "last_name": "<string>",
    "email": "<string>",
    "full_name": "<string>",
    "rejection_reason": "<string>"
  },
  "shipping_address": {
    "street": "<string>",
    "city": "<string>",
    "postal_code": "<string>",
    "state": "",
    "country": "",
    "second_line": "",
    "name": "<string>"
  }
}

Documentation Index

Authorizations

Path Parameters

Body

Response