Update Customer

This API would be called to update the details of an existing customer or reassign them to a different yield profile. To identify whose information is to be updated, you would need to pass the Customer ID of that customer.

πŸ“˜

Note

However since this is a Patch request, it is advisable that you only pass the parameter(s) you wish to be updated. All the possible fields are [name, email, mobile_number]

HTTP Method : PATCH
API Endpoint : {{baseurl}}/api/v1/customer

Sample cURL Request

curl --location --request PATCH 'https://dev-api.ovalfi-app.com/api/v1/api/v1/customer' \
--header 'Authorization: Bearer eyJidXNpbmVzc0lEIjoiMTIxMmI0OTctNTRiOS00ZTgzLTkwYzYtM2Y4NDEyMDYyZWZmIiwidXNlcklEIjoiMDBkZWU0NjMtZTQ4Yi00NDQxLTlhN2EtYTEyZTM0ZTNiY2M5Iiwia2V5IjoidXBkYXRlIn0=' \
--header 'Content-Type: application/json' \
--data-raw '{
    "customer_id": "6d187dbf-fcae-486b-805c-9437040d65e0",
    "name": "",
    "mobile_number": "",
    "email": "",
    "reference": ""
}'

Sample JSON Request

{
    "customer_id": "c56f266e-9382-4f17-8378-20a935b342f0",
    "name": "lala lava"
}

Response

{
    "status": 200,
    "data": {
        "id": "c56f266e-9382-4f17-8378-20a935b342f0",
        "customer_name": "lala lava",
        "mobile_number": "09090909011",
        "email": "[email protected]",
        "created_at": "2022-08-10T21:49:01.775563Z",
        "updated_at": {
            "Time": "2022-08-10T21:55:03.336658351+01:00",
            "Valid": true
        },
        "channel": "",
        "reference": "ref875797011",
        "api_yield_offering_id": "325d9c03-c708-4556-8725-b6a0842fdf3a"
    },
    "message": "update customer record successfully!",
    "error": null
}

What’s Next