Skip to content

Resolves a FluentCRM tag into a page of contacts to enrol in the course, optionally creating WordPress users for contacts that do not have one.

Requires a valid tag_id. Paging is driven by offset and per_page (clamped between 50 and 500, default 200); create_missing controls user creation and notify_new_users controls whether new accounts are emailed.

Endpoint

  • Method: POST

  • Path: /admin/courses/{course_id}/students/resolve-crm-tag

  • Edition: PRO

  • Controller: BulkMembersController@resolveCrmTagCourse

  • Route source: fluent-community-pro/app/Http/Routes/api.php:120

  • Controller source: fluent-community-pro/app/Http/Controllers/BulkMembersController.php

  • Requires a course admin for this course.

  • Requires FluentCommunity Pro and an active FluentCRM installation.

Live sample

The request and response below were recorded against a running FluentCommunity install and then anonymised — member names, emails, avatars and post content are fictional, and long collections are trimmed to a few entries.

POST Post Resolve CRM Tag Course

POST
/admin/courses/{course_id}/students/resolve-crm-tag

Resolves a FluentCRM tag into a page of contacts to enrol in the course, optionally creating WordPress users for contacts that do not have one.

Controller: BulkMembersController@resolveCrmTagCourse
Route source: fluent-community-pro/app/Http/Routes/api.php:120

Authorizations

ApplicationPasswords

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

Type
API Key (header: Authorization)

Parameters

Path Parameters

course_id*

Course ID extracted from the URL path.

Type
integer
Required

Request Body

application/json
JSON
{
  
"offset": 0,
  
"per_page": 0,
  
"tag_id": 0
}

Responses

Successful response

application/json
JSON
{
  
"failed": 0,
  
"has_more": true,
  
"next_offset": 0,
  
"processed": 0,
  
"total": 0,
  
"user_ids": [
  
  
0
  
]
}

Playground

Authorization
Variables
Key
Value
Body

Samples

Powered by VitePress OpenAPI

FluentCommunity developer documentation