Articles on: Community
This article is also available in:

Distribute and track your badge

Once your badge is created, its detail page lets you distribute it to your members, track deliveries, and automate distribution via the API.


Why it matters
  • Distribute your badges by email, in bulk or individually
  • Track sends, pending, and claims in real time
  • Automate distribution via the API to integrate it into your own tools


Access the badge detail page

From the "Badge Templates" list, click a badge to open its detail page. There you'll find its status (Active / Inactive), along with three indicators: Targeted sends, Pending, and Completed.
The page has three tabs:

  • Template — badge preview, description, and quick actions
  • Send history — tracking of all sends made
  • API Configuration — API key generation and documentation


Send the badge

In the Template tab, click "Send" to open the "Recipients" window. Enter one or more email addresses (separated by commas, spaces, or line breaks), or import a CSV file (up to 10 MB).
Click "Send" to start the distribution.


Click "Generate a unique link" to create a shareable claim link, along with a QR code. Copy the link or download the QR code to share it across your channels (posters, social media, etc.).


Track the send history

The Send history tab lists each send with its date, link, associated email, an optional note, and its status (e.g., Pending). Click "Copy link" to retrieve a previously generated link.


Set up API access

The API Configuration tab lets you integrate badge distribution into your own application. Click "Generate API key" to create your unique key.


Endpoint:

POST https://badgebot.mydid.com/api/v1/auth/sessions/builders/create

Example request:

curl -X POST https://badgebot.mydid.com/api/v1/auth/sessions/builders/create \
-H "Content-Type: application/json" \
-d '{
"apiKey": "YOUR_API_KEY",
"email": "user@example.com",
"note": "Welcome bonus badge"
}'

Example response:

{
"links": [
"https://mydid.page.link/iHu1WKFuPHADvEaH9"
]
}

Check out the full API documentation for the parameter reference, authentication details, and advanced usage examples.


Good to know

The "Deactivate" button at the bottom of the page lets you suspend the badge's distribution without deleting it. You can reactivate it at any time.

Updated on: 24/07/2026

Was this article helpful?

Share your feedback

Cancel

Thank you!