Edit Customer

Updates an existing customer belonging to the authenticated merchant.

Updates only the fields that are sent. A field sent empty ("" or null) is cleared; a field that is not in the request keeps its stored value. Send at least one field.

Not allowed while one of the customer's invoices has an active payment link.

A customer who has invoices cannot be moved to another store. create a new customer under that store instead.

Path Parameters

customer_id*string

Unique identifier of the consumer to update.

Public customer id returned by Create Customer

Steps to find the customer_id:

Login to the iPOSpays portal using a Merchant account.
Navigate to the My Customers section.
Search for the customer using their name, email, or phone number.
Copy the Consumer ID from the customer details page.

Header Parameters

token*string

Authentication token generated using the API Key and Secret Key of the Merchant credentials. Required for all API requests.

Request Body

application/json

customer_externalRefId?|

Your own reference for this customer (for example, a CRM ID). Letters, numbers, underscore and hyphen only, up to 100 characters.

Lengthlength <= 100

email?|

Standard email address using English letters, digits and the usual symbols. Stored and returned in lower case. The customer must keep an email or a phone.

Formatemail

Lengthlength <= 254

phone?|

International (E.164) format with + and country code, for example +14045550123. Any country code is accepted; only the format (digits and length) is checked, the number itself is not verified. The customer must keep an email or a phone.

firstName?string

Customer first name, 2–25 characters. Letters, digits, space, period and apostrophe. Can be changed but not cleared.

Length2 <= length <= 25

lastName?|

Customer last name, 1–25 characters. Letters, digits, space, period and apostrophe.

Length1 <= length <= 25

Dba?|

DBA name, 2–25 characters. Letters, digits, space, period, apostrophe and _ $ , - @ &.

Length2 <= length <= 25

Zipcode?|

5, 6 or 9 letters/digits; a 6-character ZIP is stored as A1B 2C3. No hyphen (12345-6789 is rejected; send 123456789). When sent, City and State are required.

City?|

Letters and spaces, starting with a letter. Required when Zipcode is sent; not accepted without it. Ignored when the ZIP is found in Get Zipcodes.

Lengthlength <= 255

State?|

Letters only, for example GA. Required when Zipcode is sent; not accepted without it. Ignored when the ZIP is found in Get Zipcodes.

Lengthlength <= 255

Response Body

`application/json`

curl -X PUT "https://example.com" \  -H "token: your-access-token-here" \  -H "Content-Type: application/json" \  -d '{    "customer_externalRefId": "CRM-1258819-B",    "email": "docs.full.1258819@example.com",    "phone": "+14041258819",    "firstName": "Jane",    "lastName": "Smith",    "Dba": "Jane Cakes",    "Zipcode": "34343",    "City": "New Town",    "State": "FL"  }'

{
  "data": {
    "customer_id": "LMPD9SWTTI1LI05",
    "customer_externalRefId": "CRM-1258819-B",
    "email": "docs.full.1258819@example.com",
    "phone": "+14041258819",
    "firstName": "Jane",
    "lastName": "Smith",
    "Dba": "Jane Cakes",
    "Zipcode": "34343",
    "City": "New Town",
    "State": "FL",
    "storeId": "05cbaac8502f"
  },
  "message": "Customer updated successfully",
  "response_code": "SUCCESS",
  "status_code": 200,
  "request_id": "TEST-20261008183423-CPEXH9",
  "timestamp": "2026-10-08T13:04:23.307Z"
}

{
  "data": null,
  "message": "The request contains invalid input parameters.",
  "response_code": "BAD_REQUEST",
  "status_code": 400,
  "request_id": "TEST-20261008183425-CP8XIZ",
  "timestamp": "2026-10-08T13:04:25.885Z",
  "errors": [
    {
      "field": "customer_id",
      "messages": [
        "customer_id must be a valid customer id"
      ]
    }
  ]
}

{
  "data": null,
  "message": "Missing authentication token. Please include a valid API token in your request.",
  "response_code": "TOKEN_MISSING",
  "status_code": 401,
  "request_id": "TEST-20261022075139-ZTUYSV",
  "timestamp": "2026-10-22T07:51:39.697Z"
}

{
  "data": null,
  "message": "Customer not found",
  "response_code": "NOT_FOUND",
  "status_code": 404,
  "request_id": "TEST-20261008183432-WB-IEL",
  "timestamp": "2026-10-08T13:04:32.317Z"
}

{
  "data": [
    {
      "customer_id": "L5F0EM0GSPOZ4O5",
      "customer_externalRefId": null,
      "email": "docs.email.1258819@example.com",
      "phone": null,
      "firstName": "Email Only",
      "lastName": null,
      "Dba": null,
      "Zipcode": null,
      "City": null,
      "State": null,
      "storeId": "05cbaac8502f"
    }
  ],
  "message": "Customer with same email and different phone found",
  "response_code": "CONFLICT",
  "status_code": 409,
  "request_id": "TEST-20261012160458-7MSGDT",
  "timestamp": "2026-10-12T10:34:58.671Z"
}

{
  "data": null,
  "message": "Unsupported content type",
  "response_code": "BAD_REQUEST",
  "status_code": 415,
  "request_id": "<generated per request>",
  "timestamp": "<ISO 8601 time>",
  "errors": [
    {
      "field": "body",
      "messages": [
        "Content-Type must be application/json"
      ]
    }
  ]
}

{
  "data": null,
  "message": "Too many requests, please try again in a minute",
  "response_code": "RATE_LIMITED",
  "status_code": 429,
  "timestamp": "<ISO 8601 time>"
}

{
  "data": null,
  "message": "An error occurred while processing your request. Please try again later.",
  "response_code": "INTERNAL_ERROR",
  "status_code": 500,
  "request_id": "<generated per request>",
  "timestamp": "<ISO 8601 time>"
}

Path Parameters

Header Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

404application/json

409application/json

415application/json

429application/json

500application/json

customer_id wrong format

firstName missing

Neither email nor phone

Unknown field

customer_externalRefId not a string

customer_externalRefId longer than 100

email not a string

email longer than 254

phone not a string

firstName empty

firstName not a string

firstName longer than 100

lastName longer than 100

lastName not a string

Dba longer than 100

Dba with invalid characters

Dba not a string

Zipcode not a string

storeId not a string

Body is a JSON array

Body sent as text/plain

customer_id in lower case

customer_id shorter than 8 characters

Zipcode without City and State

City / State without Zipcode

ZIP with a hyphen is rejected

Empty JSON body

Malformed JSON body

token header missing

Customer of another merchant

storeId of another merchant

Invalid token

Expired token

Token could not be verified

Token revoked or inactive

Token is not a MERCHANT or STORE token

Account is inactive (message starts with MERCHANT or STORE)

Customer does not exist

Deactivated store

Email already used by another customer of the store

Customer has an invoice with an active payment link

storeId shared by more than one store

Move a customer who has invoices to another store

Move a customer who has an active recurring payment to another store

One of the customer's invoices is being collected in the portal

Unexpected server error

Error while verifying the token

Auth public key not configured on the server

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`