Utility Pages

Endpoints for managing utility pages

Get Utility Page

get

https://api.bitbadges.io/api/v0https://api.bitbadges.io/testnet/api/v0

/utilityPage/{utilityPageId}

Gets a utility page by specific ID.

await BitBadgesApi.getUtilityPage("utilityPage123", { ... });

SDK Links:

• Request Type

• Response Type

• SDK API Function

Scopes:

• manageUtilityPages - Required and must have view permissions for private listings

Authorizations

apiKey

Path parameters

utilityPageIdstringRequired

Utility listing ID

Responses

200

Success response

application/json

400

Bad Request - Invalid configuration or request

application/json

500

Internal Server Error

application/json

get

/utilityPage/{utilityPageId}

HTTPcURLJavaScriptPython

GET /api/v0/utilityPage/{utilityPageId} HTTP/1.1
Host: api.bitbadges.io
x-api-key: YOUR_API_KEY
Accept: */*

{
  "listing": {
    "_docId": "text",
    "_id": "text",
    "listingId": "text",
    "type": "text",
    "createdBy": "bb1...",
    "managedBy": "bb1...",
    "directLink": "text",
    "createdAt": "1713301889",
    "lastUpdated": "1713301889",
    "metadata": {
      "name": "Name",
      "description": "Brief description.",
      "image": "https://example.com/image.png",
      "bannerImage": "https://example.com",
      "category": "text",
      "externalUrl": "text",
      "tags": [
        "text"
      ],
      "socials": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "offChainTransferabilityInfo": {
        "host": "text",
        "assignMethod": "text"
      },
      "attributes": [
        {
          "type": "text",
          "name": "Name",
          "value": "text"
        }
      ],
      "additionalInfo": [
        {
          "name": "Name",
          "image": "https://example.com/image.png",
          "description": "Brief description.",
          "url": "text"
        }
      ],
      "fetchedAtBlock": 1,
      "fetchedAt": "1713301889",
      "_isUpdating": true
    },
    "inheritMetadataFrom": {
      "claimId": "text",
      "applicationId": "text",
      "collectionId": "text",
      "listId": "customOrReservedListId",
      "mapId": "text",
      "badgeId": "text"
    },
    "content": [
      {
        "type": "text",
        "label": "text",
        "content": "text"
      }
    ],
    "links": [
      {
        "url": "text",
        "claimId": "text",
        "applicationId": "text",
        "collectionId": "text",
        "listId": "customOrReservedListId",
        "mapId": "text",
        "metadata": {
          "name": "Name",
          "description": "Brief description.",
          "image": "https://example.com/image.png",
          "bannerImage": "https://example.com",
          "category": "text",
          "externalUrl": "text",
          "tags": [
            "text"
          ],
          "socials": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "offChainTransferabilityInfo": {
            "host": "text",
            "assignMethod": "text"
          },
          "attributes": [
            {
              "type": "text",
              "name": "Name",
              "value": "text"
            }
          ],
          "additionalInfo": [
            {
              "name": "Name",
              "image": "https://example.com/image.png",
              "description": "Brief description.",
              "url": "text"
            }
          ],
          "fetchedAtBlock": 1,
          "fetchedAt": "1713301889",
          "_isUpdating": true
        }
      }
    ],
    "displayTimes": {
      "start": 1,
      "end": 1
    },
    "visibility": "public",
    "categories": [
      "text"
    ],
    "approvalStatus": {
      "isApproved": true,
      "isFeatured": true,
      "featuredPriority": 1,
      "rejected": true,
      "reason": "text",
      "updatedBy": "bb1..."
    },
    "viewCount": 1,
    "estimatedCost": {
      "amount": 1,
      "denom": "text"
    },
    "estimatedTime": "text",
    "viewsByPeriod": {
      "hourly": 1,
      "daily": 1,
      "weekly": 1,
      "monthly": 1
    },
    "linkedTo": {
      "collectionId": "text",
      "badgeIds": [
        {
          "start": "1",
          "end": "10"
        }
      ],
      "listId": "customOrReservedListId"
    },
    "locale": "text",
    "homePageView": {
      "type": "badges",
      "category": "text"
    }
  }
}

Get Utility Pages - Batch

post

https://api.bitbadges.io/api/v0https://api.bitbadges.io/testnet/api/v0

/utilityPages/fetch

Fetches utility pages based on the provided criteria.

Requires authentication for private listings.

await BitBadgesApi.getUtilityPages(...);

SDK Links:

• Request Type

• Response Type

• SDK API Function

Scopes:

• manageUtilityPages - Required for private listings

Authorizations

apiKey & userMaybeSignedIn

Header parameters

x-api-keystringRequired

BitBadges API Key for authentication

Body

application/json

listingIdsstring[]Required

The specific IDs to fetch

Responses

200

Success response

application/json

400

Bad Request - Invalid configuration or request

application/json

500

Internal Server Error

application/json

post

/utilityPages/fetch

HTTPcURLJavaScriptPython

POST /api/v0/utilityPages/fetch HTTP/1.1
Host: api.bitbadges.io
x-api-key: text
Authorization: cookie YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 23

{
  "listingIds": [
    "text"
  ]
}

{
  "docs": [
    {
      "_docId": "text",
      "_id": "text",
      "listingId": "text",
      "type": "text",
      "createdBy": "bb1...",
      "managedBy": "bb1...",
      "directLink": "text",
      "createdAt": "1713301889",
      "lastUpdated": "1713301889",
      "metadata": {
        "name": "Name",
        "description": "Brief description.",
        "image": "https://example.com/image.png",
        "bannerImage": "https://example.com",
        "category": "text",
        "externalUrl": "text",
        "tags": [
          "text"
        ],
        "socials": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "offChainTransferabilityInfo": {
          "host": "text",
          "assignMethod": "text"
        },
        "attributes": [
          {
            "type": "text",
            "name": "Name",
            "value": "text"
          }
        ],
        "additionalInfo": [
          {
            "name": "Name",
            "image": "https://example.com/image.png",
            "description": "Brief description.",
            "url": "text"
          }
        ],
        "fetchedAtBlock": 1,
        "fetchedAt": "1713301889",
        "_isUpdating": true
      },
      "inheritMetadataFrom": {
        "claimId": "text",
        "applicationId": "text",
        "collectionId": "text",
        "listId": "customOrReservedListId",
        "mapId": "text",
        "badgeId": "text"
      },
      "content": [
        {
          "type": "text",
          "label": "text",
          "content": "text"
        }
      ],
      "links": [
        {
          "url": "text",
          "claimId": "text",
          "applicationId": "text",
          "collectionId": "text",
          "listId": "customOrReservedListId",
          "mapId": "text",
          "metadata": {
            "name": "Name",
            "description": "Brief description.",
            "image": "https://example.com/image.png",
            "bannerImage": "https://example.com",
            "category": "text",
            "externalUrl": "text",
            "tags": [
              "text"
            ],
            "socials": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "offChainTransferabilityInfo": {
              "host": "text",
              "assignMethod": "text"
            },
            "attributes": [
              {
                "type": "text",
                "name": "Name",
                "value": "text"
              }
            ],
            "additionalInfo": [
              {
                "name": "Name",
                "image": "https://example.com/image.png",
                "description": "Brief description.",
                "url": "text"
              }
            ],
            "fetchedAtBlock": 1,
            "fetchedAt": "1713301889",
            "_isUpdating": true
          }
        }
      ],
      "displayTimes": {
        "start": 1,
        "end": 1
      },
      "visibility": "public",
      "categories": [
        "text"
      ],
      "approvalStatus": {
        "isApproved": true,
        "isFeatured": true,
        "featuredPriority": 1,
        "rejected": true,
        "reason": "text",
        "updatedBy": "bb1..."
      },
      "viewCount": 1,
      "estimatedCost": {
        "amount": 1,
        "denom": "text"
      },
      "estimatedTime": "text",
      "viewsByPeriod": {
        "hourly": 1,
        "daily": 1,
        "weekly": 1,
        "monthly": 1
      },
      "linkedTo": {
        "collectionId": "text",
        "badgeIds": [
          {
            "start": "1",
            "end": "10"
          }
        ],
        "listId": "customOrReservedListId"
      },
      "locale": "text",
      "homePageView": {
        "type": "badges",
        "category": "text"
      }
    }
  ],
  "pagination": {
    "bookmark": "text",
    "hasMore": true
  }
}

Search Utility Pages

get

https://api.bitbadges.io/api/v0https://api.bitbadges.io/testnet/api/v0

/utilityPages/search

Searches for utility pages based on the provided criteria. Currently, this only gets the signed in user's utility pages.

  await BitBadgesApi.searchUtilityPages(...);

SDK Links:

• Request Type

• Response Type

• SDK API Function

Scopes:

• manageUtilityPages - Required

Authorizations

apiKey & userSignedIn

Query parameters

bookmarkstringOptional

The pagination bookmark to start from

Header parameters

x-api-keystringRequired

BitBadges API Key for authentication

Responses

200

Success response

application/json

400

Bad Request - Invalid configuration or request

application/json

500

Internal Server Error

application/json

get

/utilityPages/search

HTTPcURLJavaScriptPython

GET /api/v0/utilityPages/search HTTP/1.1
Host: api.bitbadges.io
x-api-key: text
Authorization: cookie YOUR_SECRET_TOKEN
Accept: */*

{
  "docs": [
    {
      "_docId": "text",
      "_id": "text",
      "listingId": "text",
      "type": "text",
      "createdBy": "bb1...",
      "managedBy": "bb1...",
      "directLink": "text",
      "createdAt": "1713301889",
      "lastUpdated": "1713301889",
      "metadata": {
        "name": "Name",
        "description": "Brief description.",
        "image": "https://example.com/image.png",
        "bannerImage": "https://example.com",
        "category": "text",
        "externalUrl": "text",
        "tags": [
          "text"
        ],
        "socials": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "offChainTransferabilityInfo": {
          "host": "text",
          "assignMethod": "text"
        },
        "attributes": [
          {
            "type": "text",
            "name": "Name",
            "value": "text"
          }
        ],
        "additionalInfo": [
          {
            "name": "Name",
            "image": "https://example.com/image.png",
            "description": "Brief description.",
            "url": "text"
          }
        ],
        "fetchedAtBlock": 1,
        "fetchedAt": "1713301889",
        "_isUpdating": true
      },
      "inheritMetadataFrom": {
        "claimId": "text",
        "applicationId": "text",
        "collectionId": "text",
        "listId": "customOrReservedListId",
        "mapId": "text",
        "badgeId": "text"
      },
      "content": [
        {
          "type": "text",
          "label": "text",
          "content": "text"
        }
      ],
      "links": [
        {
          "url": "text",
          "claimId": "text",
          "applicationId": "text",
          "collectionId": "text",
          "listId": "customOrReservedListId",
          "mapId": "text",
          "metadata": {
            "name": "Name",
            "description": "Brief description.",
            "image": "https://example.com/image.png",
            "bannerImage": "https://example.com",
            "category": "text",
            "externalUrl": "text",
            "tags": [
              "text"
            ],
            "socials": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "offChainTransferabilityInfo": {
              "host": "text",
              "assignMethod": "text"
            },
            "attributes": [
              {
                "type": "text",
                "name": "Name",
                "value": "text"
              }
            ],
            "additionalInfo": [
              {
                "name": "Name",
                "image": "https://example.com/image.png",
                "description": "Brief description.",
                "url": "text"
              }
            ],
            "fetchedAtBlock": 1,
            "fetchedAt": "1713301889",
            "_isUpdating": true
          }
        }
      ],
      "displayTimes": {
        "start": 1,
        "end": 1
      },
      "visibility": "public",
      "categories": [
        "text"
      ],
      "approvalStatus": {
        "isApproved": true,
        "isFeatured": true,
        "featuredPriority": 1,
        "rejected": true,
        "reason": "text",
        "updatedBy": "bb1..."
      },
      "viewCount": 1,
      "estimatedCost": {
        "amount": 1,
        "denom": "text"
      },
      "estimatedTime": "text",
      "viewsByPeriod": {
        "hourly": 1,
        "daily": 1,
        "weekly": 1,
        "monthly": 1
      },
      "linkedTo": {
        "collectionId": "text",
        "badgeIds": [
          {
            "start": "1",
            "end": "10"
          }
        ],
        "listId": "customOrReservedListId"
      },
      "locale": "text",
      "homePageView": {
        "type": "badges",
        "category": "text"
      }
    }
  ],
  "pagination": {
    "bookmark": "text",
    "hasMore": true
  }
}

Create Utility Page

post

https://api.bitbadges.io/api/v0https://api.bitbadges.io/testnet/api/v0

/utilityPages

Creates a new utility page. This is also available in the developer portal.

await BitBadgesApi.createUtilityPage(...);

SDK Links:

• Request Type

• Response Type

• SDK API Function

Scopes:

• manageUtilityPages - Required

Authorizations

apiKey & userSignedIn

Header parameters

x-api-keystringRequired

BitBadges API Key for authentication

Body

application/json

typestringRequired

The type of the listing

visibilitystring · enumRequired

The visibility of the listing

Possible values:

directLinkstringOptional

The direct link for the listing. If specified, we will skip the entire content / listing page. Thus, content and links should be empty [].

categoriesstring[]Required

The categories of the listing

localestringOptional

Locale (ex: es, fr, etc.). If not specified, we assume en.

estimatedTimestringOptional

The estimated time to complete or deliver this utility/service

Responses

200

Success response

application/json

400

Bad Request - Invalid configuration or request

application/json

500

Internal Server Error

application/json

post

/utilityPages

HTTPcURLJavaScriptPython

POST /api/v0/utilityPages HTTP/1.1
Host: api.bitbadges.io
x-api-key: text
Authorization: cookie YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1693

{
  "metadata": {
    "name": "Name",
    "description": "Brief description.",
    "image": "https://example.com/image.png",
    "bannerImage": "https://example.com",
    "category": "text",
    "externalUrl": "text",
    "tags": [
      "text"
    ],
    "socials": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "offChainTransferabilityInfo": {
      "host": "text",
      "assignMethod": "text"
    },
    "attributes": [
      {
        "type": "text",
        "name": "Name",
        "value": "text"
      }
    ],
    "additionalInfo": [
      {
        "name": "Name",
        "image": "https://example.com/image.png",
        "description": "Brief description.",
        "url": "text"
      }
    ]
  },
  "content": [
    {
      "type": "text",
      "label": "text",
      "content": "text"
    }
  ],
  "links": [
    {
      "url": "text",
      "claimId": "text",
      "applicationId": "text",
      "collectionId": "text",
      "listId": "customOrReservedListId",
      "mapId": "text",
      "metadata": {
        "name": "Name",
        "description": "Brief description.",
        "image": "https://example.com/image.png",
        "bannerImage": "https://example.com",
        "category": "text",
        "externalUrl": "text",
        "tags": [
          "text"
        ],
        "socials": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "offChainTransferabilityInfo": {
          "host": "text",
          "assignMethod": "text"
        },
        "attributes": [
          {
            "type": "text",
            "name": "Name",
            "value": "text"
          }
        ],
        "additionalInfo": [
          {
            "name": "Name",
            "image": "https://example.com/image.png",
            "description": "Brief description.",
            "url": "text"
          }
        ],
        "fetchedAtBlock": 1,
        "fetchedAt": "1713301889",
        "_isUpdating": true
      }
    }
  ],
  "type": "text",
  "visibility": "public",
  "displayTimes": {
    "start": 1,
    "end": 1
  },
  "directLink": "text",
  "categories": [
    "text"
  ],
  "linkedTo": {
    "collectionId": "text",
    "badgeIds": [
      {
        "start": "1",
        "end": "10"
      }
    ],
    "listId": "customOrReservedListId"
  },
  "inheritMetadataFrom": {
    "claimId": "text",
    "applicationId": "text",
    "collectionId": "text",
    "listId": "customOrReservedListId",
    "mapId": "text",
    "badgeId": "text"
  },
  "locale": "text",
  "estimatedCost": {
    "amount": 1,
    "denom": "text"
  },
  "estimatedTime": "text"
}

{
  "doc": {
    "_docId": "text",
    "_id": "text",
    "listingId": "text",
    "type": "text",
    "createdBy": "bb1...",
    "managedBy": "bb1...",
    "directLink": "text",
    "createdAt": "1713301889",
    "lastUpdated": "1713301889",
    "metadata": {
      "name": "Name",
      "description": "Brief description.",
      "image": "https://example.com/image.png",
      "bannerImage": "https://example.com",
      "category": "text",
      "externalUrl": "text",
      "tags": [
        "text"
      ],
      "socials": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "offChainTransferabilityInfo": {
        "host": "text",
        "assignMethod": "text"
      },
      "attributes": [
        {
          "type": "text",
          "name": "Name",
          "value": "text"
        }
      ],
      "additionalInfo": [
        {
          "name": "Name",
          "image": "https://example.com/image.png",
          "description": "Brief description.",
          "url": "text"
        }
      ],
      "fetchedAtBlock": 1,
      "fetchedAt": "1713301889",
      "_isUpdating": true
    },
    "inheritMetadataFrom": {
      "claimId": "text",
      "applicationId": "text",
      "collectionId": "text",
      "listId": "customOrReservedListId",
      "mapId": "text",
      "badgeId": "text"
    },
    "content": [
      {
        "type": "text",
        "label": "text",
        "content": "text"
      }
    ],
    "links": [
      {
        "url": "text",
        "claimId": "text",
        "applicationId": "text",
        "collectionId": "text",
        "listId": "customOrReservedListId",
        "mapId": "text",
        "metadata": {
          "name": "Name",
          "description": "Brief description.",
          "image": "https://example.com/image.png",
          "bannerImage": "https://example.com",
          "category": "text",
          "externalUrl": "text",
          "tags": [
            "text"
          ],
          "socials": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "offChainTransferabilityInfo": {
            "host": "text",
            "assignMethod": "text"
          },
          "attributes": [
            {
              "type": "text",
              "name": "Name",
              "value": "text"
            }
          ],
          "additionalInfo": [
            {
              "name": "Name",
              "image": "https://example.com/image.png",
              "description": "Brief description.",
              "url": "text"
            }
          ],
          "fetchedAtBlock": 1,
          "fetchedAt": "1713301889",
          "_isUpdating": true
        }
      }
    ],
    "displayTimes": {
      "start": 1,
      "end": 1
    },
    "visibility": "public",
    "categories": [
      "text"
    ],
    "approvalStatus": {
      "isApproved": true,
      "isFeatured": true,
      "featuredPriority": 1,
      "rejected": true,
      "reason": "text",
      "updatedBy": "bb1..."
    },
    "viewCount": 1,
    "estimatedCost": {
      "amount": 1,
      "denom": "text"
    },
    "estimatedTime": "text",
    "viewsByPeriod": {
      "hourly": 1,
      "daily": 1,
      "weekly": 1,
      "monthly": 1
    },
    "linkedTo": {
      "collectionId": "text",
      "badgeIds": [
        {
          "start": "1",
          "end": "10"
        }
      ],
      "listId": "customOrReservedListId"
    },
    "locale": "text",
    "homePageView": {
      "type": "badges",
      "category": "text"
    }
  }
}

Update Utility Page

put

https://api.bitbadges.io/api/v0https://api.bitbadges.io/testnet/api/v0

/utilityPages

Updates an existing utility page. This is also available in the developer portal.

await BitBadgesApi.updateUtilityPage(...);

SDK Links:

• Request Type

• Response Type

• SDK API Function

Scopes:

• manageUtilityPages - Required

Authorizations

apiKey & userSignedIn

Header parameters

x-api-keystringRequired

BitBadges API Key for authentication

Body

application/json

listingIdstringRequired

The listing ID to update

visibilitystring · enumRequired

The visibility of the listing

Possible values:

directLinkstringOptional

The direct link for the listing. If specified, we will skip the entire content / listing page. Thus, content and links should be empty [].

This is incompatible with inherited metadata.

categoriesstring[]Required

The categories of the listing

localestringOptional

Locale (ex: es, fr, etc.). If not specified, we assume "en" (English).

estimatedTimestringOptional

The estimated time to complete or deliver this utility/service

Responses

200

Success response

application/json

400

Bad Request - Invalid configuration or request

application/json

500

Internal Server Error

application/json

put

/utilityPages

HTTPcURLJavaScriptPython

PUT /api/v0/utilityPages HTTP/1.1
Host: api.bitbadges.io
x-api-key: text
Authorization: cookie YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1698

{
  "listingId": "text",
  "metadata": {
    "name": "Name",
    "description": "Brief description.",
    "image": "https://example.com/image.png",
    "bannerImage": "https://example.com",
    "category": "text",
    "externalUrl": "text",
    "tags": [
      "text"
    ],
    "socials": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "offChainTransferabilityInfo": {
      "host": "text",
      "assignMethod": "text"
    },
    "attributes": [
      {
        "type": "text",
        "name": "Name",
        "value": "text"
      }
    ],
    "additionalInfo": [
      {
        "name": "Name",
        "image": "https://example.com/image.png",
        "description": "Brief description.",
        "url": "text"
      }
    ]
  },
  "content": [
    {
      "type": "text",
      "label": "text",
      "content": "text"
    }
  ],
  "links": [
    {
      "url": "text",
      "claimId": "text",
      "applicationId": "text",
      "collectionId": "text",
      "listId": "customOrReservedListId",
      "mapId": "text",
      "metadata": {
        "name": "Name",
        "description": "Brief description.",
        "image": "https://example.com/image.png",
        "bannerImage": "https://example.com",
        "category": "text",
        "externalUrl": "text",
        "tags": [
          "text"
        ],
        "socials": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "offChainTransferabilityInfo": {
          "host": "text",
          "assignMethod": "text"
        },
        "attributes": [
          {
            "type": "text",
            "name": "Name",
            "value": "text"
          }
        ],
        "additionalInfo": [
          {
            "name": "Name",
            "image": "https://example.com/image.png",
            "description": "Brief description.",
            "url": "text"
          }
        ],
        "fetchedAtBlock": 1,
        "fetchedAt": "1713301889",
        "_isUpdating": true
      }
    }
  ],
  "visibility": "public",
  "displayTimes": {
    "start": 1,
    "end": 1
  },
  "directLink": "text",
  "categories": [
    "text"
  ],
  "linkedTo": {
    "collectionId": "text",
    "badgeIds": [
      {
        "start": "1",
        "end": "10"
      }
    ],
    "listId": "customOrReservedListId"
  },
  "inheritMetadataFrom": {
    "claimId": "text",
    "applicationId": "text",
    "collectionId": "text",
    "listId": "customOrReservedListId",
    "mapId": "text",
    "badgeId": "text"
  },
  "locale": "text",
  "estimatedCost": {
    "amount": 1,
    "denom": "text"
  },
  "estimatedTime": "text"
}

{
  "doc": {
    "_docId": "text",
    "_id": "text",
    "listingId": "text",
    "type": "text",
    "createdBy": "bb1...",
    "managedBy": "bb1...",
    "directLink": "text",
    "createdAt": "1713301889",
    "lastUpdated": "1713301889",
    "metadata": {
      "name": "Name",
      "description": "Brief description.",
      "image": "https://example.com/image.png",
      "bannerImage": "https://example.com",
      "category": "text",
      "externalUrl": "text",
      "tags": [
        "text"
      ],
      "socials": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "offChainTransferabilityInfo": {
        "host": "text",
        "assignMethod": "text"
      },
      "attributes": [
        {
          "type": "text",
          "name": "Name",
          "value": "text"
        }
      ],
      "additionalInfo": [
        {
          "name": "Name",
          "image": "https://example.com/image.png",
          "description": "Brief description.",
          "url": "text"
        }
      ],
      "fetchedAtBlock": 1,
      "fetchedAt": "1713301889",
      "_isUpdating": true
    },
    "inheritMetadataFrom": {
      "claimId": "text",
      "applicationId": "text",
      "collectionId": "text",
      "listId": "customOrReservedListId",
      "mapId": "text",
      "badgeId": "text"
    },
    "content": [
      {
        "type": "text",
        "label": "text",
        "content": "text"
      }
    ],
    "links": [
      {
        "url": "text",
        "claimId": "text",
        "applicationId": "text",
        "collectionId": "text",
        "listId": "customOrReservedListId",
        "mapId": "text",
        "metadata": {
          "name": "Name",
          "description": "Brief description.",
          "image": "https://example.com/image.png",
          "bannerImage": "https://example.com",
          "category": "text",
          "externalUrl": "text",
          "tags": [
            "text"
          ],
          "socials": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "offChainTransferabilityInfo": {
            "host": "text",
            "assignMethod": "text"
          },
          "attributes": [
            {
              "type": "text",
              "name": "Name",
              "value": "text"
            }
          ],
          "additionalInfo": [
            {
              "name": "Name",
              "image": "https://example.com/image.png",
              "description": "Brief description.",
              "url": "text"
            }
          ],
          "fetchedAtBlock": 1,
          "fetchedAt": "1713301889",
          "_isUpdating": true
        }
      }
    ],
    "displayTimes": {
      "start": 1,
      "end": 1
    },
    "visibility": "public",
    "categories": [
      "text"
    ],
    "approvalStatus": {
      "isApproved": true,
      "isFeatured": true,
      "featuredPriority": 1,
      "rejected": true,
      "reason": "text",
      "updatedBy": "bb1..."
    },
    "viewCount": 1,
    "estimatedCost": {
      "amount": 1,
      "denom": "text"
    },
    "estimatedTime": "text",
    "viewsByPeriod": {
      "hourly": 1,
      "daily": 1,
      "weekly": 1,
      "monthly": 1
    },
    "linkedTo": {
      "collectionId": "text",
      "badgeIds": [
        {
          "start": "1",
          "end": "10"
        }
      ],
      "listId": "customOrReservedListId"
    },
    "locale": "text",
    "homePageView": {
      "type": "badges",
      "category": "text"
    }
  }
}

Delete Utility Page

delete

https://api.bitbadges.io/api/v0https://api.bitbadges.io/testnet/api/v0

/utilityPages

Deletes a utility page. This is also available in the developer portal.

await BitBadgesApi.deleteUtilityPage(...);

SDK Links:

• Request Type

• Response Type

• SDK API Function

Scopes:

• manageUtilityPages - Required

Authorizations

apiKey & userSignedIn

Header parameters

x-api-keystringRequired

BitBadges API Key for authentication

Body

application/json

listingIdstringRequired

The listing ID to delete

Responses

200

Success response

application/json

Responseobject

400

Bad Request - Invalid configuration or request

application/json

500

Internal Server Error

application/json

delete

/utilityPages

HTTPcURLJavaScriptPython

DELETE /api/v0/utilityPages HTTP/1.1
Host: api.bitbadges.io
x-api-key: text
Authorization: cookie YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "listingId": "text"
}

{}