Skip to content

Mute

POST/tw-v2/interaction/mute

1 API unit per call · How billing works

Description

Mute a user account.

Usage notes

The request body is the same as for /tw-v2/interaction/follow. To undo it, use /tw-v2/interaction/unmute. If the change can't be confirmed, the request fails with 502 and is not billed.

A request costs one API unit. 400, 401, 403, 409, 422, 429 and 5xx errors are free; a 404 is billed.

Request Body

ParameterDescription
authTokenstringrequiredAuthentication token (auth_token cookie value) of the X account that mutes the user
userIdstringrequiredNumeric user ID of the account to mute
usernamestringoptionalOptional username of the same account, 1 to 15 letters, digits or underscores
proxystringoptionalOptional proxy in format 'host:port@user:pass'

Code Examples

const body = {
  authToken: 'YOUR_AUTH_TOKEN',
  userId: '10017528'
};

const response = await fetch('https://api.tweetapi.com/tw-v2/interaction/mute', {
  method: 'POST',
  headers: {
    'X-API-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify(body)
});

const data = await response.json();
console.log(data);

Response

Success Response (200 OK)

Synthetic example:

200
{
  "data": {
    "id": "10017528",
    "action": "mute",
    "timestamp": "2026-11-03T12:00:00.000Z",
    "success": true,
    "metadata": {
      "user_id": "10017528"
    }
  }
}

Errors

Errors return { statusCode, message } with a non-2xx HTTP status.

400
{
  "statusCode": 400,
  "message": "Request validation failed"
}

TweetAPI is a third-party API and is not affiliated with X Corp.