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:
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:
❌ Possible Errors
Error Code | Message | Status |
---|---|---|
UNALLOWED_UPDATE_FIELD | This data can not be updated | 400 |
PROVIDED_EMAIL_INVALID | The provided email is not a valid email | 400 |
For further API details, check out the API Reference.