Set merchant user password

Sets a new password for a specific merchant user account, replacing any existing password

POST/api/v1/{team_slug}/{app_slug}/merchant-users/{user_id}/new-password
API
Management
Updated
Apr 26, 2026

management-api:POST:/api/v1/{team_slug}/{app_slug}/merchant-users/{user_id}/new-password

Sets a new password for a specific merchant user account, replacing any existing password

API ownership

  • API family: Management API
  • Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data.
  • Do not use from: Browser-only storefront code or public clients.
  • Guide route: /apis/management/latest

The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation.

Operation

  • Method: POST
  • Path: /api/v1/\{team_slug\}/\{app_slug\}/merchant-users/\{user_id\}/new-password
  • Summary: Set merchant user password
  • Description: Sets a new password for a specific merchant user account, replacing any existing password
  • OpenAPI contract: management-api
  • Operation ID: Not documented in the OpenAPI contract.

Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID.

Parameters3 parameters
NameInRequiredTypeDescription
app_slugpathYesstringApp slug
team_slugpathYesstringTeam slug
user_idpathYesstringMerchant user ID
Request bodyDocumented body
  • Required: Yes
  • Description: New password details
  • Content: application/json (object)

Set New User Password

PropertyTypeRequiredDetails
new_passwordstringYes-

Generated example (synthetic):

{
  "new_password": "string"
}
Responses5 statuses
StatusDescriptionContent
200Password changed successfullyapplication/json (object)
400Invalid request (e.g. bad payload, validation error)application/json (object)
401Unauthorized accessapplication/json (object)
404User not foundapplication/json (object)
500Internal server errorapplication/json (object)

200 - object

String Result

PropertyTypeRequiredDetails
datastringNo-
detailsstring[]NoAdditional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes
successbooleanNo-

Generated example (synthetic):

{
  "data": "string",
  "details": [
    "string"
  ],
  "success": false
}

400 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

401 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

404 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

500 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

Contract identity

Use these fields to confirm you are implementing the intended endpoint contract.

  • API family: Management API
  • Method: POST
  • Path: /api/v1/\{team_slug\}/\{app_slug\}/merchant-users/\{user_id\}/new-password
  • Operation ID: Not documented in the OpenAPI contract.
  • OpenAPI tag: Merchant Users
  • OpenAPI summary: Set merchant user password

Set merchant user password

# Set merchant user password Sets a new password for a specific merchant user account, replacing any existing password
POST /api/v1/{team_slug}/{app_slug}/merchant-users/{user_id}/new-password
Purpose

Sets a new password for a specific merchant user account, replacing any existing password

Required inputs

app_slug path team_slug path user_id path

Primary response

200 ยท Password changed successfully

Operation key

management-api:POST:/api/v1/{team_slug}/{app_slug}/merchant-users/{user_id}/new-password

## API ownership - API family: Management API - Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data. - Do not use from: Browser-only storefront code or public clients. - Guide route: [/apis/management/latest](/apis/management/latest) The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation. ## Operation - Method: `POST` - Path: `/api/v1/{team_slug}/{app_slug}/merchant-users/{user_id}/new-password` - Summary: Set merchant user password - Description: Sets a new password for a specific merchant user account, replacing any existing password - OpenAPI contract: management-api - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:POST:/api/v1/{team_slug}/{app_slug}/merchant-users/{user_id}/new-password` Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID. ## Parameters | Name | In | Required | Type | Description | | --- | --- | --- | --- | --- | | app_slug | path | Yes | string | App slug | | team_slug | path | Yes | string | Team slug | | user_id | path | Yes | string | Merchant user ID | ## Request body - Required: Yes - Description: New password details - Content: application/json (object) ### Set New User Password | Property | Type | Required | Details | | --- | --- | --- | --- | | `new_password` | string | Yes | - | **Generated example (synthetic):** ```json { "new_password": "string" } ``` ## Responses | Status | Description | Content | | --- | --- | --- | | 200 | Password changed successfully | application/json (object) | | 400 | Invalid request (e.g. bad payload, validation error) | application/json (object) | | 401 | Unauthorized access | application/json (object) | | 404 | User not found | application/json (object) | | 500 | Internal server error | application/json (object) | ### 200 - object #### String Result | Property | Type | Required | Details | | --- | --- | --- | --- | | `data` | string | No | - | | `details` | string[] | No | Additional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "data": "string", "details": [ "string" ], "success": false } ``` ### 400 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ### 401 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ### 404 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ### 500 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ## Contract identity Use these fields to confirm you are implementing the intended endpoint contract. - API family: Management API - Method: `POST` - Path: `/api/v1/{team_slug}/{app_slug}/merchant-users/{user_id}/new-password` - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:POST:/api/v1/{team_slug}/{app_slug}/merchant-users/{user_id}/new-password` - OpenAPI tag: Merchant Users - OpenAPI summary: Set merchant user password