Create - Badges Business API Docs

Create a collectible

⚠️

Collectibles will be permanently created on the blockchain. Collectibles on blockchain cannot be updated or altered.

Request

POST /collectibles

curl 'https://businessapi.badges.xyz/collectibles' \
-u E23d1aN95aAtnE3w9QmQyGjBRzu4...
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "My Collectible",
}'

Returns

Returns the collectible object if the update succeeded. Returns an error if create parameters are invalid.

RESPONSE

{
  "data": {
    "id": "9c9b5e7f-5fc6-4cec-8340-bf390dc18759",
    "name": "My Collectible",
    "description": "Thank you for collecting my collectible",
    "mime_type": "image/png",
    "artwork": "https://cdn.badges.xyz/api/organizations/images/1952ba5c89bf5ef69e69d9bac1decb0d855e1c260599f939ec11e18f32049fef.png",
    "cover": {
      "large": "https://cdn.badges.xyz/api/organizations/images/1952ba5c89bf5ef69e69d9bac1decb0d855e1c260599f939ec11e18f32049fef_large.png",
      "medium": "https://cdn.badges.xyz/api/organizations/images/1952ba5c89bf5ef69e69d9bac1decb0d855e1c260599f939ec11e18f32049fef_medium.png",
      "small": "https://cdn.badges.xyz/api//organizations/images/1952ba5c89bf5ef69e69d9bac1decb0d855e1c260599f939ec11e18f32049fef_small.png",
      "thumb": "https://cdn.badges.xyz/api/organizations/images/1952ba5c89bf5ef69e69d9bac1decb0d855e1c260599f939ec11e18f32049fef_thumb.png",
      "original": "https://cdn.badges.xyz/api/organizations/images/1952ba5c89bf5ef69e69d9bac1decb0d855e1c260599f939ec11e18f32049fef.png"
    },
    "total_count": 100,
    "claimed_count": 74,
    "available_count": 16,
    "contract_address": "0xd8cd77D7F98B2990D08EE2d957dF2a35459D0F1D",
    "blockchain_id": 0x64,
    "creator_id": "785e64de-2ad2-4ebd-83da-f60c480ee551",
    "organization_id": "1b9c9c78-1a4c-4d86-9e50-c1fcb3adbc05",
    "external_id": "88261967",
    "is_active": true,
    "created_at": "2023-04-30T23:50:17.000Z"
  }
}

Parameters

name string
Name for the object.

description string
Description for the object.

mime_type string
Mime Type for the artwork file associated with the object.

artwork url
URL of the artwork file associated with the object.

cover url
URL of the cover image for the file associated with the object.

total_count int
Total collectible count for the object.

claimed_count int
Total collectible claim count for the object.

available_count int
Total collectibles available count for the object.

creator_id uuid
User object id for the object.

organization_id uuid
Organization object id for the object.

external_id string
Custom External id for the object.

The collectible object List all collectibles