> For the complete documentation index, see [llms.txt](https://docs.payengine.co/payengine-api-v2.5/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.payengine.co/payengine-api-v2.5/onboarding/update-merchant-status.md).

# Update Merchant Status

## Update merchant status

<mark style="color:purple;">`PATCH`</mark> `https://<Platform-host>/merchant/:merchantId/status`

Update the status change for a merchant

#### Path Parameters

| Name                                           | Type   | Description                   |
| ---------------------------------------------- | ------ | ----------------------------- |
| merchant\_id<mark style="color:red;">\*</mark> | string | The ID of the merchant to get |

#### Request Body

| Name                                     | Type   | Description                                                                                                                                                                                                                                                              |
| ---------------------------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| status<mark style="color:red;">\*</mark> | string | <p>Status to be updated. Only the following status can be changed<br>1. Paused to Active<br>2. Active to Paused<br>3. Editing to Cancelled and Editing to Submitted-to-pe<br>4. In-review to Editing<br>5. In-review to Submitted-to-pe<br>6. In-review to Cancelled</p> |
| message                                  | string | Message                                                                                                                                                                                                                                                                  |

{% tabs %}
{% tab title="200 Returns a updated object" %}

```javascript
{
    "message": "merchant updated",
    "data": {
        "id": "fc545add-02ad-4481-8f6b-4421ac71ebea",
        "status": "submitted_to_pe",
        "processing_status": null,
        "is_sub_status_update": false,
        "is_primary_status_changed": true
    }
}
```

{% endtab %}
{% endtabs %}

### Sample Request

{% tabs %}
{% tab title="Sample Request" %}

```javascript
{
  "status": "submitted_to_pe",
  "message": "Submitted for review"
}
```

{% endtab %}
{% endtabs %}