customer Deletion

POST

/open/customer/delete

This API endpoint is designed to allow authorized users to delete customer records from a system or database. Deleting a customer typically involves permanently removing their information from the system, including any associated data

api_key: This is the API key provided by the marketplace to authenticate and validate the request.
marketplace_user_id: This represents the ID of the user within the marketplace's SaaS account.
user_id: This appears to be the same as marketplace_user_id, both set to "1314".
vendor_id: This is the ID of the customer whose record is targeted for deletion ("1313" in this case).
new_request: This parameter is used to indicate that this is a new request (set to 1), likely triggering the initiation of a delete operation as described in your note.
password: This parameter contains the customer's password. However, it's unusual and insecure to include a password in a request payload, especially in plaintext. This should be avoided for security reasons.

Request

Body Params application/json

Example

{
      "api_key"                 : {{api_key}},
      "marketplace_user_id" : "1314",
      "user_id" : "1314",
      "vendor_id" : "1313",
      "new_request" : 1,
      "password": "safjka"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.yelo.red/open/customer/delete' \
--header 'Content-Type: application/json' \
--data-raw '{
      "api_key"                 : eagagg3467sadkjhfi,
      "marketplace_user_id" : "1314",
      "user_id" : "1314",
      "vendor_id" : "1313",
      "new_request" : 1,
      "password": "safjka"
}'

Responses

🟢200Success

application/json

Body

Example

{}

Modified at 2024-04-18 10:27:28

getUserTheme

Add Customer