---
updatedAt: 2025-11-11T02:11:06.000Z
agentTools:
  projectIndex: https://beamable2.readme.io/llms.txt
---

# post

# OpenAPI definition

```json
{
  "info": {
    "title": "announcements basic",
    "version": "1.0",
    "contact": {
      "name": "Beamable Support",
      "url": "https://api.beamable.com",
      "email": "support@beamable.com"
    }
  },
  "servers": [
    {
      "url": "https://api.beamable.com"
    }
  ],
  "paths": {
    "/basic/announcements/": {
      "post": {
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EmptyResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request"
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Announcement"
              }
            }
          }
        },
        "security": [
          {
            "scope": [],
            "user": []
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "ItemCreateRequest": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "contentId": {
            "type": "string"
          },
          "properties": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ItemProperty"
            }
          }
        }
      },
      "WebhookComet": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "method": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "variables": {
            "$ref": "#/components/schemas/RouteVariables"
          },
          "symbol": {
            "type": "string"
          },
          "route": {
            "$ref": "#/components/schemas/ServiceRoute"
          },
          "parameters": {
            "$ref": "#/components/schemas/RouteParameters"
          }
        }
      },
      "AnnouncementAttachment": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "symbol": {
            "type": "string"
          },
          "count": {
            "type": "integer"
          },
          "type": {
            "type": "string"
          },
          "properties": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AttachmentProperty"
            }
          }
        },
        "required": [
          "count"
        ]
      },
      "RouteVariable": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "name": {
            "type": "string"
          },
          "typeName": {
            "type": "string"
          }
        }
      },
      "WebhookInvocationStrategy": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "invocationType": {
            "type": "string"
          },
          "retryType": {
            "type": "string"
          }
        }
      },
      "Announcement": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "body": {
            "type": "string"
          },
          "channel": {
            "type": "string"
          },
          "start_date": {
            "type": "string"
          },
          "gift": {
            "$ref": "#/components/schemas/PlayerReward"
          },
          "mongo_start_date": {
            "type": "integer"
          },
          "stat_requirements": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PlayerStatRequirement"
            }
          },
          "mongo_end_date": {
            "type": "integer"
          },
          "symbol": {
            "type": "string"
          },
          "clientData": {
            "type": "object",
            "additionalProperties": true
          },
          "validationErrors": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "end_date": {
            "type": "string"
          },
          "title": {
            "type": "string"
          },
          "attachments": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AnnouncementAttachment"
            }
          },
          "summary": {
            "type": "string"
          }
        }
      },
      "RouteParameter": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "name": {
            "type": "string"
          },
          "body": {
            "type": "string"
          },
          "typeName": {
            "type": "string"
          },
          "variableRef": {
            "$ref": "#/components/schemas/VariableReference"
          }
        }
      },
      "RouteVariables": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "variables": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RouteVariable"
            }
          }
        }
      },
      "PlayerReward": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "description": {
            "type": "string"
          },
          "addItemRequests": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ItemCreateRequest"
            }
          },
          "changeCurrencies": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CurrencyChangeReward"
            }
          },
          "callWebhooks": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/WebhookReward"
            }
          },
          "addItems": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/NewItemReward"
            }
          },
          "applyVipBonus": {
            "type": "boolean"
          },
          "addCurrencyMap": {
            "type": "object",
            "additionalProperties": true
          }
        }
      },
      "VariableReference": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "name": {
            "type": "string"
          }
        }
      },
      "AttachmentProperty": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "name": {
            "type": "string"
          },
          "value": {
            "type": "string"
          }
        }
      },
      "PlayerStatRequirement": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "domain": {
            "type": "string"
          },
          "stat": {
            "type": "string"
          },
          "constraint": {
            "type": "string"
          },
          "value": {
            "type": "string"
          },
          "access": {
            "type": "string"
          }
        }
      },
      "RouteParameters": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "parameters": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RouteParameter"
            }
          },
          "payload": {
            "type": "string"
          },
          "objectId": {
            "type": "string"
          }
        }
      },
      "ServiceRoute": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "service": {
            "type": "string"
          },
          "endpoint": {
            "type": "string"
          },
          "serviceTypeStr": {
            "type": "string"
          }
        }
      },
      "CurrencyChangeReward": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "symbol": {
            "type": "string"
          },
          "amount": {
            "type": "integer"
          }
        },
        "required": [
          "amount"
        ]
      },
      "EmptyResponse": {
        "properties": {
          "result": {
            "type": "string"
          }
        },
        "additionalProperties": false,
        "title": "Empty Response",
        "type": "object"
      },
      "ItemProperty": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "name": {
            "type": "string"
          },
          "value": {
            "type": "string"
          }
        }
      },
      "WebhookReward": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "webhookSymbol": {
            "type": "string"
          },
          "strategy": {
            "$ref": "#/components/schemas/WebhookInvocationStrategy"
          },
          "webHookComet": {
            "$ref": "#/components/schemas/WebhookComet"
          }
        }
      },
      "NewItemReward": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "symbol": {
            "type": "string"
          },
          "properties": {
            "type": "object",
            "additionalProperties": true
          }
        }
      }
    },
    "securitySchemes": {
      "scope": {
        "type": "apiKey",
        "name": "X-DE-SCOPE",
        "in": "header",
        "description": "Customer and project scope. This should contain the '<customer-id>.<project-id>'."
      },
      "user": {
        "type": "http",
        "description": "Bearer authentication with an player access token in the Authorization header.",
        "scheme": "bearer",
        "bearerFormat": "Bearer <Access Token>"
      }
    }
  },
  "security": [],
  "externalDocs": {
    "description": "Beamable Documentation",
    "url": "https://docs.beamable.com"
  },
  "openapi": "3.0.2",
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```