Docs / Reference / act: place participant

act: place participant.

Places one party in one role on one stock of a vertical's chain, with the evidence for it to The answer gives the participant, ready or not ready with the reason

Figure 1POST /v1/act/place_participantspecified

The caller sends PlaceParticipantInput to /v1/act/place_participant. The platform returns a card whose body is MarketParticipant.

POST/v1/act/place_participant

Place a participant. The call needs the brand rung under a token with the act grant, and it is served by the platform.

The route takes PlaceParticipantInput and returns a card whose body is MarketParticipant.

Request body#

The request body is PlaceParticipantInput.

field	type	required
`vertical`	`id`	yes
`segment`	`id`	no
`stock`	`text`	yes
`party`	`id`	yes
`party_kind`	`one of company \| brand \| person \| account \| community \| organisation`	yes
`role`	RoleAroundADecision	yes
`side`	`one of demand \| supply \| intermediary \| influence \| rules`	yes
`impact_on`	ParticipantImpact	no
`evidence`	EvidenceRef	yes

Response#

The route returns a card whose body is MarketParticipant. Every card ends with a foot that states the basis of each number, the scope of the call, and the time when the facts were true.

Headers#

header	required	meaning
`Scale-Scope`	yes	the scope the call runs in: tenant/, then /brand/, then /strategy/
`Scale-As-True-On`	no	the date the facts must have been true on; defaults to now
`Scale-As-Known-On`	no	the date the facts must have been known on; defaults to now
`Scale-Key`	no	for a change, the key made from the input; a repeat under the same key returns the unit held and writes nothing

A caller needs the brand rung and a token with the act grant. The platform serves this route.

Example#

The example sends the smallest body that PlaceParticipantInput allows. The build validates it against the schema of PlaceParticipantInput.

Example

curl -X POST https://api.scaleintelligence.co/v1/act/place_participant \
  -H "Scale-Key: $SCALE_KEY" -H "Scale-Scope: tenant/<id>" \
  -H "content-type: application/json" \
  -d '{ "vertical": "…", "stock": "…", "party": "…", "party_kind": "company", "role": "…", "side": "demand", "evidence": [] }'

import { client } from "@scale/sdk";
const answer = await client.act.place_participant({
    "vertical": "…",
    "stock": "…",
    "party": "…",
    "party_kind": "company",
    "role": "…",
    "side": "demand",
    "evidence": []
  });
// answer.body is a MarketParticipant. answer.foot holds the basis, the scope and the time.

import requests
answer = requests.post("https://api.scaleintelligence.co/v1/act/place_participant",
    headers={"Scale-Key": KEY, "Scale-Scope": "tenant/<id>"},
    json={
      "vertical": "…",
      "stock": "…",
      "party": "…",
      "party_kind": "company",
      "role": "…",
      "side": "demand",
      "evidence": []
    }).json()

let answer: Card = client.post("https://api.scaleintelligence.co/v1/act/place_participant")
    .header("Scale-Key", key).header("Scale-Scope", "tenant/<id>")
    .json(&PlaceParticipantInput { /* the fields of the page */ }).send().await?.json().await?;

MCP tool#

The MCP tool si.act.place_participant takes the same input and returns the same card. The tool changes data and needs a grant. An MCP host that renders cards draws this card from ui://scale-intelligence/cards/MarketParticipant. The tool’s page describes it.

POST /v1/act/place_participant
Scale-Scope: …
Scale-As-True-On: …
Scale-As-Known-On: …
Scale-Key: …
content-type: application/json

{
  "vertical": "…",
  "stock": "…",
  "party": "…",
  "party_kind": "company",
  "role": "…",
  "side": "demand",
  "evidence": []
}

Without a key, this page shows the request only. The request body is PlaceParticipantInput, and the route returns a card whose body is MarketParticipant.

Claims#

claim	state	route or tool
The platform serves the route /v1/act/place_participant at contract 0476e35e6e275db5.	target	`/v1/act/place_participant`