Update Customer Account

Updates a customer account, if the requesting manager has access permissions to it.

  • Method: PATCH

  • URL: /api/v1/customer-accounts/{id}/

circle-info

This endpoint requires that the requesting manager has access permissions to the customer account.

Example request body

PATCH /api/v1/customer-accounts/{id}/ (application/json)
{
    "description": "test desc"
}

Example responses

200 OK
{
    "id": 818,
    "customers_count": 0,
    "code": "tc6",
    "name": "Test Customer Company 6",
    "description": "test desc",
    "phone": "",
    "address": "",
    "email": "",
    "cognito_user_pool_id": "",
    "company": 339
}

Request parameters

Path parameters

  • id (in URL) — the ID of the customer account to update.

Body parameters (optional)

Name
Type
Description

name

string

ID of the cake to get

description

string

description

phone

string

phone

address

string

address

email

string

email

Notes

  • hasTryItOut: false

Was this helpful?