v1

latestOpenAPI 3.1.0MIT2026-07-243952451019.0 KB

Communities::Bans::UnbanAction

Create Ban Unban Action

Enqueue an async background job to unban one or more contacts from a community. The action record is returned immediately with status: queued. Poll GET /communities/bans/unban_actions/{id} until status is completed.

post/communities/{community_id}/bans/unban_actions

Path parameters

community_idinteger required

Request body

Example request

{
  "communities_bans_unban_action": {
    "communities_bans_unban_action": {
      "target_all": false,
      "target_ids": [
        "MnOpQr",
        "StUvWx"
      ]
    }
  }
}

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.