MYmyclickfunnels
Communities::Bans::ExportAction

List Ban Export Actions

Changed on

List previous ban export actions for a community

get/communities/{community_id}/bans/export_actions

Request

Path parameters

community_idstring required

Query parameters

afterstring

ID of item after which the collection should be returned. More examples and info about pagination in our guides.

per_pageinteger

Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.

sort_order'asc' | 'desc'

Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples in our guides.

sort_property'id' | 'updated_at'

Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Response

OK

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"
    ]
  }
]

Changes

  • 511d88b30aeaRevision changes
    • info

      added the new optional query request parameter per_page

    • info

      for the path request parameter community_id, the type was generalized from integer to string

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status