Update Customer

Update a customer's details.

Updates an existing customer's details. Only the fields you include in the request will be updated.

Endpoint

PATCH /v1/customers/:prop

Authentication

Accepts either a merchant API key or a business-user JWT.

Header	Value
Authorization	<api_key> or Bearer <jwt>

Path parameters

Parameter	Type	Description
prop	string	Customer UUID, email address, or refCode

Request body

All fields are optional — include only the fields you want to update.

Field	Type	Required	Description
firstName	string	No	Updated first name (minimum length 1)
lastName	string	No	Updated last name (minimum length 1)
phoneNumber	string	No	Updated phone number. Note: the update DTO does not apply @IsPhoneNumber validation, so any string is accepted at this layer; downstream consumers may still expect E.164 format.

Example request

cURL

curl -X PATCH https://ramp-api.ivorypay.io/api/v1/customers/[e-mail] \
  -H "Authorization: your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "firstName": "Aminat",
    "phoneNumber": "[phone]"
  }'

Node.js

const response = await fetch("https://ramp-api.ivorypay.io/api/v1/customers/[e-mail]", {
  method: "PATCH",
  headers: {
    "Authorization": "your_api_key",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    firstName: "Aminat",
    phoneNumber: "[phone]",
  }),
});

const data = await response.json();
console.log(data);

Python

import requests

response = requests.patch(
    "https://ramp-api.ivorypay.io/api/v1/customers/[e-mail]",
    headers={
        "Authorization": "your_api_key",
        "Content-Type": "application/json",
    },
    json={
        "firstName": "Aminat",
        "phoneNumber": "[phone]",
    },
)

print(response.json())

Go

package main

import (
	"bytes"
	"encoding/json"
	"fmt"
	"io"
	"net/http"
)

func main() {
	body, _ := json.Marshal(map[string]string{
		"firstName":   "Aminat",
		"phoneNumber": "[phone]",
	})

	req, _ := http.NewRequest("PATCH", "https://ramp-api.ivorypay.io/api/v1/customers/[e-mail]", bytes.NewBuffer(body))
	req.Header.Set("Authorization", "your_api_key")
	req.Header.Set("Content-Type", "application/json")

	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	respBody, _ := io.ReadAll(resp.Body)
	fmt.Println(string(respBody))
}

Example response

{
  "success": true,
  "message": "Customer was updated successfully",
  "data": {
    "id": "c3d4e5f6-a7b8-9012-cdef-a12345678901",
    "refCode": "abc123def4",
    "firstName": "Aminat",
    "lastName": "Okafor",
    "email": "[e-mail]",
    "phoneNumber": "[phone]"
  }
}