API Set Tags
From zFairs Contest Management
Contents
Set Tags
Applies a tag to one or more people or projects. Tag type (person vs project) is determined by the tag definition.
Authentication
All data API calls are POST (unless noted) with JSON body:
| Field | Required | Description |
|---|---|---|
ApiKey |
Yes | Private API key for your site. |
FairId |
Yes | Fair GUID from the site URL (f query parameter).
|
Body |
Depends | Request payload. Use {} when no body fields are needed.
|
Calls must be run server-side — do not expose your API key in a browser.
Response envelope
Most endpoints return:
{
Success: true,
Message: null, // error text when Success is false
Body: { ... } // endpoint-specific payload
}
Request
fetch('/api/data/tags/set', {
method:'POST',
headers:{'Content-Type': 'application/json'},
body: JSON.stringify({
ApiKey:'<Private key>',
FairId: '9df61f13-474b-442f-ac1f-edca7348ef71', // value of f in your URL
Body: {
tagId: 31,
Ids: [
"32161f13-474b-442f-ac1f-edca7348e000", // person or project public GUIDs
"42161f13-474b-442f-ac1f-edca7348e001"
]
}
})
})
.then(response => response.json())
.then(data=>{console.log('Success: ',data);})
.catch((error)=>{console.log('Error: ', error);});Response
On success:
{
Success: true,
Message: null,
Body: {}
}
On invalid tag:
{
Success: false,
Message: "Tag provide is not valid."
}
Field notes
- Get valid
tagIdvalues from API Get Tags. Idsis an array of person or project public GUIDs (depending on the tag type).- Invalid tag ids are rejected; the message text is exactly as returned by the API.
Related APIs
