v1

latestOpenAPI 3.1.0MIT2026-07-243952451019.0 KB

Communities::Bans::ExportAction

Create Ban Export Action

Enqueue an async background job to export community ban data to a file. The action record is returned immediately with status: queued. Poll GET /communities/bans/export_actions/{id} until status is completed.

post/communities/{community_id}/bans/export_actions

Path parameters

community_idinteger required

Request body

Example request

{
  "communities_bans_export_action": {
    "communities_bans_export_action": {
      "target_all": true,
      "target_ids": [],
      "fields": [
        "contact_name",
        "contact_email",
        "reason",
        "created_at"
      ]
    }
  }
}

Response

Created

idinteger

Action ID

public_idstring nullable

Action public ID

community_idinteger

ID of the Community this action belongs to

target_allboolean

When true the action targets all eligible records in the community rather than the explicit target_ids list

target_idsinteger[]

Integer IDs of the targeted records (memberships or bans)

failed_idsinteger[]

Integer IDs of records that could not be processed

target_countinteger nullable

Total number of records that will be processed

performed_countinteger nullable

Number of records processed so far

started_atstring date-time nullable

Timestamp when the background job began processing

completed_atstring date-time nullable

Timestamp when the background job finished

created_atstring date-time

Created at

updated_atstring date-time

Updated at

status'queued' | 'processing' | 'completed'

Current status of the async action. Progresses: queued → processing → completed.

fieldsstring[]

Column names included in the export file

Example response

{
  "id": 506,
  "public_id": "BnExP1",
  "community_id": 1,
  "target_all": true,
  "target_ids": [],
  "failed_ids": [],
  "target_count": 50,
  "performed_count": 50,
  "started_at": "2025-01-01T00:01:00.000Z",
  "completed_at": "2025-01-01T00:01:15.000Z",
  "created_at": "2025-01-01T00:00:00.000Z",
  "updated_at": "2025-01-01T00:01:15.000Z",
  "status": "completed",
  "fields": [
    "contact_name",
    "contact_email",
    "reason",
    "created_at"
  ]
}