Circles

Declare a member channel

Declare a channel (telegram or whatsapp) for a member. 409 when that channel type already exists.

post/api/v1/circles/{id}/members/{memberId}/channels

Request

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

Path parameters

idstring required

MongoDB ObjectId

Example:507f1f77bcf86cd799439011
memberIdstring required

MongoDB ObjectId

Example:507f1f77bcf86cd799439011

Request body

channel'telegram' | 'whatsapp' required
identifierstring required

The Telegram chat id (≤50) or E.164 WhatsApp phone (leading +) — validated per channel

Example request

{
  "channel": "whatsapp",
  "identifier": "+15551112222"
}

Response

Channel declared

idstring required

MongoDB ObjectId

channel'telegram' | 'whatsapp' required
status'declared' | 'verified' required
verified_atstring date-time nullable required
created_atstring date-time required

Example response

{
  "id": "507f1f77bcf86cd799439011",
  "channel": "whatsapp",
  "status": "declared"
}

Changes

No recorded changes to this operation across all 1 revision of this API.