Skip to main content
POST
Notify Certificate Code

Authorizations

HAIQU_API_KEY
string
query
required

Path Parameters

code
string
required

Body

application/json

Data model used by an external agent to report a certificate code as sent to a recipient or activated by them.

status
enum<string>
required

Lifecycle of a certificate (invitation) code.

Available options:
created,
sent,
activated
user_email
string | null

Response

Successful Response

The Pydantic model for a certificate code stored in the DB.

code
string
required
credits
integer
required
status
enum<string>
required

Lifecycle of a certificate (invitation) code.

Available options:
created,
sent,
activated
sent_to
string | null
required
user_id
integer | null
required
created_at
string<date-time>
required
sent_at
string<date-time> | null
required
activated_at
string<date-time> | null
required