Skip to content

Begins a BuddyPress or BuddyBoss migration by importing the groups as spaces and returns the progress record plus the maximum source ids the polling loop needs.

Send config as a map of BuddyPress group id to the destination space group. reset_migration=yes clears any saved progress before starting. After this call the migration advances by repeatedly polling the status endpoint.

Endpoint

  • Method: POST

  • Path: /migrations/buddypress/start

  • Edition: Core

  • Controller: BPMigrationController@startMigration

  • Route source: fluent-community/Modules/Migrations/Http/migration_api.php:15

  • Controller source: fluent-community/Modules/Migrations/Http/Controllers/BPMigrationController.php

  • Requires the FluentCommunity community-admin permission (or a WordPress super admin).

  • Highly destructive when delete_current_data=yes is sent: the feeds, comments, reactions, media, activity and profile tables are truncated, every community space is deleted, and the whole uploads/fluent-community directory is removed from disk. There is no confirmation step and nothing can be recovered.

Reconstructed sample

This endpoint belongs to a module that is not active on the reference install (or needs a file upload), so the payload below was reconstructed by reading the controller rather than recorded. Field names and types follow the source; values are illustrative.

POST Start Buddypress Migration

POST
/migrations/buddypress/start

Begins a BuddyPress or BuddyBoss migration by importing the groups as spaces and returns the progress record plus the maximum source ids the polling loop needs.

Controller: BPMigrationController@startMigration
Route source: fluent-community/Modules/Migrations/Http/migration_api.php:15

Authorizations

ApplicationPasswords

WordPress Application Passwords — use Basic auth with username:application_password.

Type
API Key (header: Authorization)

Request Body

application/json
JSON
{
  
"reset_migration": "string",
  
"delete_current_data": "string",
  
"config": {
  
}
}

Responses

Successful response

application/json
JSON
{
  
"current_status": {
  
  
"migrated_groups": {
  
  
  
"1": 0,
  
  
  
"2": 0
  
  
},
  
  
"last_activity_id": 0,
  
  
"last_migrated_member_id": 0,
  
  
"migrated_posts_count": 0,
  
  
"last_migrated_user_id": 0,
  
  
"current_stage": "string"
  
},
  
"max_ids": {
  
  
"group_member_max": "string",
  
  
"max_user_id": 0,
  
  
"max_activity_id": "string"
  
}
}

Playground

Authorization
Body

Samples

Powered by VitePress OpenAPI

FluentCommunity developer documentation