{
 "openapi": "3.1.0",
 "info": {
  "title": "Recipients (CRM)",
  "version": "20261030b",
  "description": "One row per person per broadcast, with what became of it — and why it was not sent where it was not. \"No consent\", \"hard bounced before\", \"duplicate address\" and \"on the suppression list\" are four different problems and three of them are fixable."
 },
 "servers": [
  {
   "url": "https://{tenant}.tranxact.ai",
   "variables": {
    "tenant": {
     "default": "demo"
    }
   }
  }
 ],
 "components": {
  "securitySchemes": {
   "bearer": {
    "type": "http",
    "scheme": "bearer"
   }
  },
  "schemas": {
   "broadcast-recipients": {
    "type": "object",
    "required": [],
    "properties": {
     "id": {
      "type": "string",
      "format": "uuid",
      "description": "Id",
      "readOnly": true
     },
     "org_id": {
      "type": "string",
      "format": "uuid",
      "description": "Org id",
      "readOnly": true
     },
     "org_unit_id": {
      "type": "string",
      "format": "uuid",
      "description": "Org unit id",
      "readOnly": true
     },
     "broadcast_id": {
      "type": "string",
      "format": "uuid",
      "description": "Broadcast id",
      "readOnly": true
     },
     "channel": {
      "type": "string",
      "description": "Channel",
      "readOnly": true
     },
     "contact_id": {
      "type": "string",
      "format": "uuid",
      "description": "Contact id",
      "readOnly": true
     },
     "lead_id": {
      "type": "string",
      "format": "uuid",
      "description": "Lead id",
      "readOnly": true
     },
     "account_id": {
      "type": "string",
      "format": "uuid",
      "description": "Account id",
      "readOnly": true
     },
     "address": {
      "type": "string",
      "description": "Address",
      "readOnly": true
     },
     "display_name": {
      "type": "string",
      "description": "Display name",
      "readOnly": true
     },
     "locale": {
      "type": "string",
      "description": "Locale",
      "readOnly": true
     },
     "status": {
      "type": "string",
      "description": "Status",
      "readOnly": true
     },
     "suppression_reason": {
      "type": "string",
      "description": "Suppression reason",
      "readOnly": true
     },
     "external_id": {
      "type": "string",
      "description": "External id",
      "readOnly": true
     },
     "sent_at": {
      "type": "string",
      "format": "date-time",
      "description": "Sent at",
      "readOnly": true
     },
     "delivered_at": {
      "type": "string",
      "format": "date-time",
      "description": "Delivered at",
      "readOnly": true
     },
     "first_opened_at": {
      "type": "string",
      "format": "date-time",
      "description": "First opened at",
      "readOnly": true
     },
     "last_opened_at": {
      "type": "string",
      "format": "date-time",
      "description": "Last opened at",
      "readOnly": true
     },
     "open_count": {
      "type": "integer",
      "description": "Open count",
      "readOnly": true
     },
     "click_count": {
      "type": "integer",
      "description": "Click count",
      "readOnly": true
     },
     "bounced_at": {
      "type": "string",
      "format": "date-time",
      "description": "Bounced at",
      "readOnly": true
     },
     "bounce_type": {
      "type": "string",
      "description": "Bounce type",
      "readOnly": true
     },
     "unsubscribed_at": {
      "type": "string",
      "format": "date-time",
      "description": "Unsubscribed at",
      "readOnly": true
     },
     "error_message": {
      "type": "string",
      "description": "Error message",
      "readOnly": true
     },
     "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Created at",
      "readOnly": true
     },
     "xf_text_1": {
      "type": "string",
      "description": "Xf text 1",
      "readOnly": true
     },
     "xf_text_2": {
      "type": "string",
      "description": "Xf text 2",
      "readOnly": true
     },
     "xf_text_3": {
      "type": "string",
      "description": "Xf text 3",
      "readOnly": true
     },
     "xf_text_4": {
      "type": "string",
      "description": "Xf text 4",
      "readOnly": true
     },
     "xf_text_5": {
      "type": "string",
      "description": "Xf text 5",
      "readOnly": true
     },
     "xf_num_1": {
      "type": "string",
      "format": "decimal",
      "description": "Xf num 1",
      "readOnly": true
     },
     "xf_num_2": {
      "type": "string",
      "format": "decimal",
      "description": "Xf num 2",
      "readOnly": true
     },
     "xf_num_3": {
      "type": "string",
      "format": "decimal",
      "description": "Xf num 3",
      "readOnly": true
     },
     "xf_date_1": {
      "type": "string",
      "format": "date",
      "description": "Xf date 1",
      "readOnly": true
     },
     "xf_date_2": {
      "type": "string",
      "format": "date",
      "description": "Xf date 2",
      "readOnly": true
     },
     "created_by": {
      "type": "string",
      "format": "uuid",
      "description": "Created by",
      "readOnly": true
     },
     "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "Updated at",
      "readOnly": true
     },
     "updated_by": {
      "type": "string",
      "format": "uuid",
      "description": "Updated by",
      "readOnly": true
     }
    }
   }
  }
 },
 "security": [
  {
   "bearer": []
  }
 ],
 "paths": {
  "/api/crm/broadcast-recipients": {
   "get": {
    "summary": "list broadcast-recipients",
    "operationId": "list_broadcast_recipients_0_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "post": {
    "summary": "Post recipients",
    "operationId": "action_broadcast_recipients_1_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/crm/broadcast-recipients/{id}": {
   "get": {
    "summary": "get broadcast-recipients",
    "operationId": "get_broadcast_recipients_0_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "put": {
    "summary": "Put recipients",
    "operationId": "action_broadcast_recipients_1_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "delete": {
    "summary": "Delete recipients",
    "operationId": "action_broadcast_recipients_2_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/crm/broadcast-recipients/{id}/copy": {
   "post": {
    "summary": "Copy",
    "operationId": "action_broadcast_recipients_0_6",
    "description": "Body keys: overrides, preview, withLines",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  }
 }
}