Circles

Invite (enroll) a Circle member

Mint a single-use enrollment deep link (both channels + QR) for an existing member.

post/api/v1/circles/{id}/members/invite

Request

  • Base URL: https://api.proof.holdings
  • URL: https://api.proof.holdings/api/v1/circles/{id}/members/invite
  • Auth: one of:
    • HTTP bearer
    • API key in cookie auth_token

Path parameters

idstring required

MongoDB ObjectId

Example:507f1f77bcf86cd799439011

Request body

member_idstring required

The member to mint an enrollment link for

Example request

{
  "member_id": "507f1f77bcf86cd799439011"
}

Response

Enrollment link minted

tokenstring required
member_idstring required

MongoDB ObjectId

telegram_deep_linkstring required
whatsapp_deep_linkstring required
qr_codestring required

QR code data URL for the primary deep link

qr_textstring required

UTF-8 text representation of the QR code

expires_ininteger required
suggested_share_textstring required

Suggested message to forward with the invite

Example response

{
  "token": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4",
  "member_id": "507f1f77bcf86cd799439011",
  "telegram_deep_link": "https://t.me/proof_holdings_bot?start=pm_...",
  "whatsapp_deep_link": "https://wa.me/15551112222?text=pm_...",
  "qr_code": "data:image/png;base64,...",
  "expires_in": 86400
}

Changes

No recorded changes to this operation across all 2 revisions of this API.