Skip to navigation
View as Markdown

Purpose

Deletes one or more Contact Lists (a.k.a. tag/contact list entities) by ID(s) for the partner/broadcast module.


Endpoint

  • Method: GET (unusual for a delete operation; documented as currently used in Postman)

  • URL: https://business.me-mate.net/partners/broadcast/delete/taglist

Recommendation: For RESTful design, this operation is typically implemented as DELETE or POST (e.g., /delete/taglist) with a JSON body. However, this request is currently configured as GET with a raw JSON body in Postman—use it as-is if that’s what the server expects.


Authentication & Required Headers

Include the following headers when calling this endpoint:

HeaderRequiredValue / Notes
X-Requested-WithYesXMLHttpRequest
AuthorizationYesBearer {{auth token}} (token stored as a Postman variable)

Notes:

  • The collection/workspace currently uses a variable named {{auth token}}. Ensure it contains a valid partner session token.

Request Body

Although the method is GET, this request uses a raw JSON body in Postman.

Schema

{
"ids": "string"
}

ids format (important)

  • ids is a string that itself contains a JSON array representation, e.g. "[112995]".

  • This is not an actual JSON array type in the payload; it is a string that looks like an array.

Examples:

  • Single id: "[112995]"

  • Multiple ids (if supported by backend): "[112995,112996]"

Example payload (as currently used)

{
"ids": "[112995]"
}

Success Response

200 OK

Example body:

{
"status": true,
"msg": "1 Contact List(s) Deleted Successfully!"
}

Error Cases (plausible)

Exact error shapes may vary; these are common outcomes to handle.

  • 401 Unauthorized — Missing/expired token.

    • Example: Authorization header absent or invalid.
  • 403 Forbidden — Token is valid but lacks permission to delete lists.

  • 422 Unprocessable Entity — Validation error (e.g., ids missing, empty, wrong formatting, non-existent IDs).

  • 500 Internal Server Error — Unexpected backend failure.


Postman Usage Checklist

  1. Set/update the variable auth token (Global or Environment) with a valid token.

  2. Confirm headers:

    • X-Requested-With: XMLHttpRequest

    • Authorization: Bearer {{auth token}}

  3. In Body → raw → JSON, provide:

    {"ids":"[112995]"}
  4. Click Send and verify you receive 200 with {"status":true,...}.

Headers

X-Requested-WithstringOptional

Response

OK
msgstring
statusboolean