logo
EasyListing
Api reference/Subscriber

Edit

Edit Subscriber ✏️

This endpoint allows you to edit the details of a subscriber. You can update specific fields like the first name, last name, email, and status.

🔑 Authentication

Include your API key in the request header:

EL_API_KEY: YOUR_SECRET_API_KEY

Patch Endpoint 🔧

URL: /edit/subscriber

HTTP Method: PATCH

Request Body 📥

The request body must include the id of the subscriber, which is required to identify the subscriber. Other fields are optional.

Required Field:

  • id (sub id): required to identify the subscriber.

Allowed Updates:

You can include one or more of the following fields in the request body:

  • firstName
  • lastName
  • email
  • status

If any other fields are included, they will cause an error.

Successful Response ✅

If the update is successful, the response will look like this:

{
  "error": null,
  "message": "Subscriber edited successfully",
  "ok": true
}

❌ Possible Errors

Error CodeMessageStatus
UNALLOWED_UPDATE_FIELDThis data can not be updated400
PROVIDED_EMAIL_INVALIDThe provided email is not a valid email400

For further API details, check out the API Reference.

On this page