> ## Documentation Index > Fetch the complete documentation index at: https://docs.appcharge.com/llms.txt > Use this file to discover all available pages before exploring further. # Create Badge > Creates a badge. ## OpenAPI ````yaml openapi-badges-api.json POST /components/v1/badge openapi: 3.0.3 info: title: Badges API version: 1.0.0 servers: - url: https://api-sandbox.appcharge.com security: - PublisherTokenAuth: [] tags: - name: Badges paths: /components/v1/badge: post: tags: - Badges description: Creates a badge. requestBody: required: true content: application/json: schema: oneOf: - $ref: '#/components/schemas/EmblemBadgeCreate' - $ref: '#/components/schemas/RibbonBadgeCreate' discriminator: propertyName: type mapping: emblem: $ref: '#/components/schemas/EmblemBadgeCreate' ribbon: $ref: '#/components/schemas/RibbonBadgeCreate' responses: '200': description: Badge created successfully. content: application/json: schema: oneOf: - $ref: '#/components/schemas/EmblemBadgeResponse' - $ref: '#/components/schemas/RibbonBadgeResponse' discriminator: propertyName: type mapping: emblem: $ref: '#/components/schemas/EmblemBadgeResponse' ribbon: $ref: '#/components/schemas/RibbonBadgeResponse' '400': description: Bad request. Invalid input or validation failure. components: schemas: EmblemBadgeCreate: title: Emblem Badge allOf: - $ref: '#/components/schemas/BadgeBase' - description: Create an emblem badge. - type: object properties: type: type: string enum: - emblem description: Badge type. example: emblem required: - type - badgeImageUrl RibbonBadgeCreate: title: Ribbon Badge allOf: - $ref: '#/components/schemas/RibbonBadgeBase' - description: Create a ribbon badge. - type: object properties: type: type: string enum: - ribbon description: Badge type. example: ribbon text: type: string description: Text displayed on ribbon badge. example: New Year Sale backgroundColor: allOf: - $ref: '#/components/schemas/BackgroundColorGradient' - description: |- Background color. If not provided, the value defaults to `{"colorOne": "#000000"}`. example: colorOne: '#00c6ff' colorTwo: '#0072ff' gradientDirection: to right textColor: type: object description: |- Text color. If not provided, the value defaults to `{"colorOne": "#000000"}`. properties: colorOne: type: string default: '#000000' pattern: ^#[0-9a-fA-F]{6}$ description: Text color in hex format. example: '#ffffff' imageUrl: type: string format: url description: >- Badge image URL in PNG or JPEG format. For uploaded files, this is the Appcharge-hosted CDN URL. For external image URLs, this is the original image URL served from the provided URL. External image URLs are saved and used as-is, and Appcharge doesn't download, copy, upload, or host them. Images must remain available at the provided URLs. We recommend uploading image files instead of using external URLs when possible. example: https://media.appcharge.com/media/69133d595af23405d8e843a5 required: - type - text EmblemBadgeResponse: title: Emblem Badge type: object properties: id: type: string description: Badge ID. example: 507f1f77bcf86cd799439011 name: type: string description: Badge name. example: New Year Celebration publisherBadgeId: type: string description: Badge ID that you defined. example: new_year_celebration type: type: string enum: - emblem description: Badge type. example: emblem badgeImageUrl: type: string format: url description: >- Badge image URL. For uploaded files, this is the Appcharge-hosted CDN URL. For external image URLs, this is the original image URL served from the provided URL. example: https://media.appcharge.com/media/69133d595af23405d8e843a5 RibbonBadgeResponse: title: Ribbon Badge type: object properties: id: type: string description: Badge ID. example: 507f1f77bcf86cd799439012 name: type: string description: Badge name. example: New Year Celebration publisherBadgeId: type: string description: Badge ID that you defined. example: new_year_celebration type: type: string enum: - ribbon description: Badge type. example: ribbon badgeImageUrl: type: string format: url description: >- Badge image URL. For uploaded files, this is the Appcharge-hosted CDN URL. For external image URLs, this is the original image URL served from the provided URL. example: https://media.appcharge.com/media/69133d595af23405d8e843a5 text: type: string description: Badge text. example: New Year Sale backgroundColor: allOf: - $ref: '#/components/schemas/BackgroundColorGradient' - description: Background color details. example: colorOne: '#00c6ff' colorTwo: '#0072ff' gradientDirection: to right textColor: type: object properties: colorOne: type: string pattern: ^#[0-9a-fA-F]{6}$ description: Text color in hex format. example: '#ffffff' BadgeBase: type: object properties: name: type: string description: Badge name. example: New Year Celebration publisherBadgeId: type: string description: Badge ID that you define. example: new_year_celebration type: type: string description: Badge type. example: ribbon badgeImageUrl: type: string format: url description: >- Badge image URL in PNG or JPEG format. For uploaded files, this is the Appcharge-hosted CDN URL. For external image URLs, this is the original image URL served from the provided URL. External image URLs are saved and used as-is, and Appcharge doesn't download, copy, upload, or host them. Images must remain available at the provided URLs. We recommend uploading image files instead of using external URLs when possible. example: https://media.appcharge.com/media/69133d595af23405d8e843a5 required: - name - publisherBadgeId - type RibbonBadgeBase: type: object properties: name: type: string description: Badge name. example: New Year Celebration publisherBadgeId: type: string description: Badge ID that you define. example: new_year_celebration type: type: string description: Badge type. example: ribbon required: - name - publisherBadgeId - type BackgroundColorGradient: type: object properties: colorOne: type: string default: '#000000' pattern: ^#[0-9a-fA-F]{6}$ description: Primary gradient color in hex format. example: '#00c6ff' colorTwo: type: string pattern: ^#[0-9a-fA-F]{6}$ description: Secondary gradient color in hex format. example: '#0072ff' gradientDirection: type: string enum: - to bottom - to top - to right - to left - to bottom right - to top left - to bottom left - to top right default: to bottom description: Direction of gradient transition between `colorOne` and `colorTwo`. example: to right securitySchemes: PublisherTokenAuth: type: apiKey in: header name: x-publisher-token description: Publisher token, as displayed in the Publisher Dashboard. ````