---
title: "Update a merchant"
method: POST
path: "/v3/merchants/{mId}"
tags: ["MERCHANTS"]
---

# Update a merchant

`POST /v3/merchants/{mId}`

## Path parameters

- `mId` string, required

## Query parameters

- `expand` string

## Headers

- `User-Agent` string, required

## Request body

- object
  - `id` string — Unique identifier
  - `name` string, required — Name of the merchant
  - `owner` object, required — The account that owns this merchant
    - `id` string — Unique identifier
    - `name` string, required — Full name of the employee
    - `nickname` string — Nickname of the employee (shows up on receipts)
    - `customId` string — Custom ID of the employee
    - `email` string — Email of the employee (optional)
    - `inviteSent` boolean — Returns true if this employee was sent an invite to activate their account
    - `claimedTime` integer — Timestamp of when this employee claimed their account
    - `deletedTime` integer — Timestamp of when this employee was deleted
    - `pin` string — Employee PIN (hashed)
    - `unhashedPin` string — Employee PIN
    - `role` 'OWNER' | 'ADMIN' | 'MANAGER' | 'EMPLOYEE' — Employee System Role
    - `roles` object[]
      - `id` string — Unique identifier.
    - `isOwner` boolean — Returns true if this employee is the owner account for this merchant
    - `shifts` object[] — This employee's shifts
      - `id` string — Unique identifier.
    - `payments` object[] — This employee's payments
      - `id` string — Unique identifier.
    - `orders` object[] — This employee's orders
      - `id` string — Unique identifier.
    - `employeeCards` object[] — This employee's employee cards
      - `id` string — Unique identifier.
    - `merchant` object — The merchant employing this employee.
      - `id` string — Unique identifier.
  - `address` object — The address of the merchant.
    - `address1` string — Customer's address, line one.
    - `address2` string — Customer's address, line two.
    - `address3` string — Customer's address, line three.
    - `city` string — Customer's city.
    - `country` string — Customer's country.
    - `state` string — Customer's state.
    - `zip` string — Postal code of the customer's address.

## Response `200`

---

[API](https://skmtc.net/clover/apis/platform-api.md) · [All operations](https://skmtc.net/clover/apis/platform-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/clover/platform-api/versions/08da265101a3/schema)