API Reference
Customers
Customers
Update customer
PATCH
/
customers
/
{id}
curl --request PATCH \
--url https://api.kohortpay.com/customers/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"deletedAt": "2021-07-22T00:00:00.000Z"
}'
{
"id": "cus_1234567890",
"emailAddress": "[email protected]",
"firstName": "John",
"lastName": "Doe",
"phoneNumber": "+1 555 555 5555",
"livemode": true,
"isBlocked": true,
"organizationId": "org_1234567890",
"addressId": "adr_1234567890",
"shippingAddressId": "adr_1234567890",
"metadata": {
"my_system_id": "1JYLo8KerLxWZaQtys6ZQ1xS"
},
"createdAt": "2021-07-22T00:00:00.000Z",
"createdBy": "usr_1234567890",
"updatedAt": "2021-07-22T00:00:00.000Z",
"blockedAt": "2021-07-22T00:00:00.000Z",
"blockedBy": "usr_1234567890",
"updatedBy": "usr_1234567890",
"deletedAt": "2021-07-22T00:00:00.000Z"
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Unique customer ID
Body
application/json
Response
201 - application/json
Customer successfully updated.
The response is of type object
.
curl --request PATCH \
--url https://api.kohortpay.com/customers/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"deletedAt": "2021-07-22T00:00:00.000Z"
}'
{
"id": "cus_1234567890",
"emailAddress": "[email protected]",
"firstName": "John",
"lastName": "Doe",
"phoneNumber": "+1 555 555 5555",
"livemode": true,
"isBlocked": true,
"organizationId": "org_1234567890",
"addressId": "adr_1234567890",
"shippingAddressId": "adr_1234567890",
"metadata": {
"my_system_id": "1JYLo8KerLxWZaQtys6ZQ1xS"
},
"createdAt": "2021-07-22T00:00:00.000Z",
"createdBy": "usr_1234567890",
"updatedAt": "2021-07-22T00:00:00.000Z",
"blockedAt": "2021-07-22T00:00:00.000Z",
"blockedBy": "usr_1234567890",
"updatedBy": "usr_1234567890",
"deletedAt": "2021-07-22T00:00:00.000Z"
}