Update Account

​

Update an account.

Path Parameters
  • account_id
    Type: string · Account Id
    required

    The ID of the account to update

Headers
  • Accept
    enum
    const:  
    application/json
    required

    Response format. Must be application/json.

    values
    • application/json
  • Content-Type
    enum
    const:  
    application/json
    required

    Request payload format. Must be application/json when a body is sent.

    values
    • application/json
Body·AccountUpdate
required
application/json
  • address
    Type: object · Address nullable
  • available_processor_configs
    Type: array string[] · Available Processor Configs
  • description
    Type: string | null · Description
  • mcc
    Type: string | null · Mcc
  • name
    Type: string | null · Name
  • organization_id
    Type: string | null · Organization Id
  • parent_id
    Type: string | null · Parent Id
  • status
    Type: string · AccountStatusenum nullable
    values
    • active
    • inactive
    • blocked
  • surcharge_rate
    Type: number | null · Surcharge Rate

    Surcharge percentage (e.g., 3.5 for 3.5%). Setting to null disables automatic surcharge logic. Setting to 0 means surcharges will NEVER be applied unless explicitly overridden.

  • tax_id
    Type: string | null · Tax Id
Responses
  • application/json
  • application/json
Request Example for put/v1/accounts/{account_id}
curl 'https://api.uat.koard.com/v1/accounts/{account_id}' \
  --request PUT \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'x-koard-apikey: YOUR_SECRET_TOKEN' \
  --data '{
  "address": {
    "city": "",
    "state": "",
    "street_line1": "",
    "street_line2": "",
    "zip": ""
  },
  "available_processor_configs": [
    ""
  ],
  "description": null,
  "mcc": null,
  "name": null,
  "organization_id": null,
  "parent_id": null,
  "status": "active",
  "surcharge_rate": null,
  "tax_id": null
}'

{
  "address": {
    "city": "string",
    "state": "string",
    "street_line1": "string",
    "street_line2": "",
    "zip": "string"
  },
  "available_processor_configs": [],
  "created_at": "2026-04-20T15:32:06.309Z",
  "deleted_at": null,
  "description": "string",
  "has_access_to_apple_config": false,
  "has_access_to_mms": false,
  "id": "string",
  "mcc": null,
  "name": "string",
  "organization_id": null,
  "parent_account_ids": [],
  "status": "active",
  "surcharge_rate": null,
  "tax_id": null,
  "type": "admin",
  "updated_at": null
}

Successful Response