Skip to main content
POST
Publish Credential

Description

Publishes a draft credential made with Generate Credential. Publishing runs in the background and takes a few seconds. When it is done, the recipient gets an email (unless the group’s notifications are off), and Hyperstack sends a credential.issued webhook if you subscribed to one. Publishing may use a credit. A recipient already covered by a credit uses none.

Headers

string
required
Your API key: Bearer YOUR_API_KEY. Create a key in the Studio under Settings → Developers.

Path Parameters

string
required
ID of the draft credential.

Success Response Fields

boolean
true when the credential is queued for publishing.
string
Always "Credential published successfully". To see when the credential is live, call View Credential and look for the status active.

Responses

Last modified on October 20, 2026