Skip to navigation
View as Markdown

Purpose

Remove one or more tags from one or more contacts (phone numbers) within a specific contact list. The API queues a background job to process the tag removals.

Endpoint

  • Method: POST

  • URL: https://business.me-mate.net/api/betav3/tagmanage/tag/removeTagFromContacts

Required Headers

  • X-Requested-With: XMLHttpRequest

Auth / Variables

  • api_key (required): pass as a variable using {{api_key}}.
    • Recommended: store api_key as a collection/environment variable in Postman.

Request Body Schema

Content-Type: JSON (raw)

{
"api_key": "string",
"contacts": [
{
"contactListId": "string",
"numbers": ["string"],
"tagRemove": [0]
}
]
}

Field Explanations

  • api_key (string, required): API key used to authorize the request.

  • contacts (array, required): One or more contact-list batches to process.

    • contactListId (string, required): Identifier of the contact list containing the contacts.

    • numbers (array of strings, required): Phone numbers to remove tags from.

      • Note on formatting: Use a consistent numeric format (typically country code + number, no spaces). Ensure the format matches how numbers are stored in your contact list.
    • tagRemove (array of integers, required): Tag IDs to remove from the specified numbers.

      • Note: Values in tagRemove are tag IDs (not tag names).

Example Request Payload

{"api_key":"{{api_key}}","contacts":[{"contactListId":"113056","numbers":["91913632xxxx","91945645xxxx"],"tagRemove":[274,275]}]}

Example Successful Response (200)

{"status":true,"msg":"Tag remove jobs queued","queued_jobs":1,"skipped_items":0}

Response Fields (high level)

  • status (boolean): Indicates whether the request was accepted.

  • msg (string): Human-readable message.

  • queued_jobs (number): How many jobs were queued for processing.

  • skipped_items (number): How many items were skipped.

Common Error Cases

  • 4xx: Invalid/missing api_key, invalid request body (missing/incorrect fields), invalid contact list or numbers.

  • 5xx: Server-side error while accepting/queuing the job.

Headers

X-Requested-WithstringOptional

Request

This endpoint expects an object.
api_keystringRequired
contactslist of objectsRequired

Response

OK
msgstring
statusboolean
queued_jobsinteger
skipped_itemsinteger