deleteBidMessage

Requires permission biddesk:bid:read.

Deletes one of your own messages in a bid's room; it then shows as deleted, without its text. Only the bid's members can use its room. Requires Bid Desk and permission to read bids.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

mutation DeleteBidMessage($messageId: ID!) {
  deleteBidMessage(messageId: $messageId) {
    id
    senderName
    createdAt
    content
    deleted
    parentId
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation DeleteBidMessage($messageId: ID!) {\n  deleteBidMessage(messageId: $messageId) {\n    id\n    senderName\n    createdAt\n    content\n    deleted\n    parentId\n  }\n}",
  "variables": {
    "messageId": "id"
  }
}
EOF

Variables:

{
  "messageId": "id"
}

Response:

{
  "data": {
    "deleteBidMessage": {
      "id": "id",
      "senderName": "string",
      "createdAt": "2025-01-15T00:00:00Z",
      "content": "string",
      "deleted": true,
      "parentId": "id"
    }
  }
}

deleteBidMessage(
  messageId: ID!
): BidMessage!

Arguments

deleteBidMessage.messageId ● ID! non-null scalar

The message.

Type

BidMessage object

One message in a bid's room.