Trigger Promotion Flows

Trigger one or more promotion flow actions.

POST https://api.sonorancms.com/v2/community/promotion-flows/trigger

Rate limit: 13 requests per minute

Authenticated v2 endpoints are rate limited per credential rather than per IP address.

Trigger one or more promotion flow actions.

Request Body

| --- | --- | --- | --- |

Example Request

local Sonoran = require("sonoran")

local sonoran = Sonoran.createClient({
  product = Sonoran.productEnums.CMS,
  apiKey = "YOUR_API_KEY",
  communityId = "YOUR_COMMUNITY_ID",
  defaultServerId = 1,
  timeoutMs = 30000,
})

local payload = {
  ["data"] = {
    {
      ["flowId"] = "flow-1",
      ["users"] = {
        "ExampleUser"
      },
      ["promote"] = true
    }
  }
}

local response = sonoran.cms:triggerPromotionFlowsV2(payload)

if response.success then
  print(response.data)
else
  print(response.reason)
end

const Sonoran = require("sonoran.js");

const instance = Sonoran.instance({
  apiKey: "YOUR_API_KEY",
  communityId: "YOUR_COMMUNITY_ID",
  product: Sonoran.productEnums.CMS,
  serverId: 1,
});

async function main() {
  const payload = {
  "data": [
    {
      "flowId": "flow-1",
      "users": [
        "ExampleUser"
      ],
      "promote": true
    }
  ]
};

  const response = await instance.cms.triggerPromotionFlowsV2(payload);

  if (response.success) {
    console.log(response.data);
  } else {
    console.error(response.reason);
  }
}

main().catch((error) => {
  console.error(error);
});

from sonoran import Instance, productEnums

instance = Instance(
    apiKey="YOUR_API_KEY",
    communityId="YOUR_COMMUNITY_ID",
    product=productEnums.CMS,
    serverId=1,
)

payload = {
  "data": [
    {
      "flowId": "flow-1",
      "users": [
        "ExampleUser"
      ],
      "promote": True
    }
  ]
}

response = instance.cms.triggerPromotionFlowsV2(payload)

if response.success:
    print(response.data)
else:
    print(response.reason)

using Sonoran;
using System.Text.Json;

using var sonoran = new SonoranClient(new SonoranClientOptions
{
    product = SonoranProduct.CMS,
    apiKey = "YOUR_API_KEY",
    communityId = "YOUR_COMMUNITY_ID",
    defaultServerId = 1
});

var payload = new {
  data = new[] {
    new {
      flowId = "flow-1",
      users = new[] {
        "ExampleUser"
      },
      promote = true
    }
  }
};

var response = await sonoran.Cms.triggerPromotionFlowsV2(payload);

if (response.success)
{
    Console.WriteLine(JsonSerializer.Serialize(response.data));
}
else
{
    Console.WriteLine(response.reason);
}

openapi: "3.0.3"

info:

  title: "Sonoran CMS v2 - Trigger Promotion Flows"

  version: "1.0.0"

  description: "Trigger one or more promotion flow actions."

servers:

  -

    url: "https://api.sonorancms.com"

paths:

  /v2/community/promotion-flows/trigger:

    post:

      summary: "Trigger Promotion Flows"

      operationId: "triggerPromotionFlows"

      security:

        -

          bearerAuth: []

      responses:

        "200":

          description: "Successful response"

          content:

            application/json:

              schema:

                type: "object"

              example:

                success: true

                data:

                  -

                    users:

                      - "00000000-0000-0000-0000-000000000000"

                    flow: "44444444-4444-4444-4444-444444444444"

                    promote: true

                    succeeded: true

                    message: "Promotion executed successfully"

                    config:

                      id: "44444444-4444-4444-4444-444444444444"

                      communityUuid: "00000000-0000-0000-0000-000000000000"

                      labelFrom: "Cadet"

                      labelTo: "Officer"

                      ranksToAdd:

                        - "22222222-2222-2222-2222-222222222222"

                      ranksToRemove: []

                      actions:

                        data: []

                        promotionType: "both"

                      promotionType: "both"

                meta:

                  timestamp: "2026-04-15T00:00:00.000Z"

                  path: "/v2/community/promotion-flows/trigger"

components:

  securitySchemes:

    bearerAuth:

      type: "http"

      scheme: "bearer"

      bearerFormat: "JWT"

curl --request POST \

  --url "https://api.sonorancms.com/v2/community/promotion-flows/trigger" \

  --header "Authorization: Bearer YOUR_API_KEY" \

  --header "Accept: application/json" \

  --data '{"data":[{"flowId":"flow-1","users":["ExampleUser"],"promote":true}]}'

Response

The data array contains one result object per flow/user combination. Each entry includes the users involved, the flow id, whether it was a promotion or demotion, the execution result, and the resolved flow config.


{

  "success": true,

  "data": [

    {

      "users": [

        "00000000-0000-0000-0000-000000000000"

      ],

      "flow": "44444444-4444-4444-4444-444444444444",

      "promote": true,

      "succeeded": true,

      "message": "Promotion executed successfully",

      "config": {

        "id": "44444444-4444-4444-4444-444444444444",

        "communityUuid": "00000000-0000-0000-0000-000000000000",

        "labelFrom": "Cadet",

        "labelTo": "Officer",

        "ranksToAdd": [

          "22222222-2222-2222-2222-222222222222"

        ],

        "ranksToRemove": [],

        "actions": {

          "data": [],

          "promotionType": "both"

        },

        "promotionType": "both"

      }

    }

  ],

  "meta": {

    "timestamp": "2026-04-15T00:00:00.000Z",

    "path": "/v2/community/promotion-flows/trigger"

  }

}

PreviousGet Promotion Flows NextUndo Rank Change

Last updated 28 days ago

Was this helpful?

openapi: "3.0.3"

info:

  title: "Sonoran CMS v2 - Trigger Promotion Flows"

  version: "1.0.0"

  description: "Trigger one or more promotion flow actions."

servers:

  -

    url: "https://api.sonorancms.com"

paths:

  /v2/community/promotion-flows/trigger:

    post:

      summary: "Trigger Promotion Flows"

      operationId: "triggerPromotionFlows"

      security:

        -

          bearerAuth: []

      responses:

        "200":

          description: "Successful response"

          content:

            application/json:

              schema:

                type: "object"

              example:

                success: true

                data:

                  -

                    users:

                      - "00000000-0000-0000-0000-000000000000"

                    flow: "44444444-4444-4444-4444-444444444444"

                    promote: true

                    succeeded: true

                    message: "Promotion executed successfully"

                    config:

                      id: "44444444-4444-4444-4444-444444444444"

                      communityUuid: "00000000-0000-0000-0000-000000000000"

                      labelFrom: "Cadet"

                      labelTo: "Officer"

                      ranksToAdd:

                        - "22222222-2222-2222-2222-222222222222"

                      ranksToRemove: []

                      actions:

                        data: []

                        promotionType: "both"

                      promotionType: "both"

                meta:

                  timestamp: "2026-04-15T00:00:00.000Z"

                  path: "/v2/community/promotion-flows/trigger"

components:

  securitySchemes:

    bearerAuth:

      type: "http"

      scheme: "bearer"

      bearerFormat: "JWT"