Update customer

Updating customer information is easy with the update API. All you need is the customer id to update the necessary information.

Attention: With the Create customer API, customer information will not be updated by default. We advise to use this Update customer API to update existing information.

Update customer

PATCH https://api.notify.cm/v2/customers/{customer_id}

Authentication: API keys

Headers

Name	Type	Description
Authorization	string	Your test or live API key

Request Body

Name	Type	Description
Name	string	The name of the customer. Max. 250 characters
Address	string	Max. 250 characters
Postalcode	string	Max 10 characters
City	string	Max 250 characters
Country	string	Two characters country code. See documentation
Contact	string	The full name of the contact. Max 250 characters
Phone	string	Max 20 caharacters
Mobile	string	Max 20 characters
Email	string	Max 250 characters
InvoiceEmail	string	Address for invoices only. Max 250 characters
RegistrationNumber	string	Chamber of Commerce Registration number
Language	string	Language code. See documentation

200

HTTP/1.1 200 OK
Content-Type: application/hal+json

{
        "resource": "customer",
        "id": "a0f0660d-6c8d-422b-8114-e363b260521e",
        "customerCode":"10001",
        "name":"Creditpartners B.V.",
        "address": {
                "address":"",
                "postalcode":"",
                "city":"",
                "country":"NL"
        },
        "contact":"",
        "phone":"",
        "mobile":"",
        "email":"[email protected]",
        "invoiceEmail":"",
        "registrationNumber":"",
        "language":"dutch"
}

400

HTTP/1.1 400 Bad Request
Content-Type: application/hal+json

{
    "status": 400,
    "title": "Bad Request",
    "detail": "Field email in wrong format"
}

404

HTTP/1.1 404 Not Found
Content-Type: application/hal+json

{
    "status": 404,
    "title": "Not Found",
    "detail": "No customer exists with id I_dont_exist."
}

Example

curl -X PATCH https://api.notify.cm/v2/customers/a0f0660d-6c8d-422b-8114-e363b260521e \
   -H "Authorization: Bearer test_R7HQ9QpXgx8J32rW9X9UyXjgfNk6C7TQ2UD8M5rwf8vVnYxnSETvSuEC6SKFW8Ug" \
   -d "name=Creditpartners B.V." \
   -d "[email protected]"

Response

HTTP/1.1 200 OK
Content-Type: application/hal+json

{
        "resource": "customer",
        "id": "a0f0660d-6c8d-422b-8114-e363b260521e",
        "customerCode":"10001",
        "name":"Creditpartners B.V.",
        "address": {
                "address":"",
                "postalcode":"",
                "city":"",
                "country":"NL"
        },
        "contact":"",
        "phone":"",
        "mobile":"",
        "email":"[email protected]",
        "invoiceEmail":"",
        "registrationNumber":"",
        "language":"dutch"
}