Asks

Get an ask

Payload + status to render the ask card. Requires membership in the conversation and being in the ask audience; otherwise 404. A pending ask past expires_at is reported as expired.

get/v5/asks/{id}

Request

  • Base URL: https://api.carbonvoice.app
  • URL: https://api.carbonvoice.app/v5/asks/{id}
  • Auth: one of:
    • API key in header pxtoken
    • OAuth 2 (implicit, authorization URL https://api.carbonvoice.app/oauth/authorize)

Path parameters

idstring required

Response

idstring required
conversation_idstring required
message_idstring required

The anchor message

creator_idstring required
creator_kind'agent' | 'user' required
type'single_choice' | 'multi_choice' | 'form' | 'free_text' | 'permission_request' | 'connect_account' required
payloadobject required

{ question, options?: [{ id, label }], form?: { fields: [{ id, label, required? }] }, connect?: { mode: "connect" | "reconnect", providers: [{ id, label }] }, details?: [{ label, value }] }

audienceobject required

"conversation" or { users: [ids] } — who may see the ask

respondersobject required

"any" or { users: [ids] } — who may answer the ask

response_mode'single' | 'per_user' required
status'pending' | 'answered' | 'expired' | 'canceled' required

Effective status: a pending ask past expires_at is expired

expires_atstring date-time nullable
answered_bystring nullable
answerobject nullable

The winning answer of a single ask: { user_id, action_id?, values?, created_at }

resolved_atstring date-time nullable
created_atstring date-time required

Changes

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