API Add Category

Add Category

Creates or updates a project category for the fair.

Authentication

All data API calls are POST (unless noted) with JSON body:

Field	Required	Description
ApiKey	Yes*	Private API key for your site. Prefer this over username/password.
Username / Password	Yes*	Alternate auth if not using ApiKey.
FairId	Yes	Fair GUID from the site URL (f query parameter).
Body	Depends	Request payload. Use {} when no body fields are needed.

• Provide either ApiKey or Username+Password.

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/category', {
    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: {
				Id: 0,  // 0 for new
				Name: "Biology",
				NameShort: "BIO",
				Description: "Life sciences",
				Grades: [6,7,8,9,10,11,12],  // optional grade filter
				DoNotShowInOnlineJudging: false,
				DoNotAllowTeams: false,
				MaxTeamSize: 3,
				EntryTypeId: 1  // optional, from Get Info EntryTypes
			}
        })
})
.then(response => response.json())
.then(data=>{console.log('Success: ',data);})
.catch((error)=>{console.log('Error: ', error);});

Response

On success Body is the category with Id set:

{
  Success: true,
  Message: null,
  Body: { Id: 12, Name: "Biology", NameShort: "BIO", ... }
}

Field notes

• Use returned Id as CategoryId when adding/updating projects.
• Grades is stored as a category grade filter when provided.
• Categories can be listed via API Get Info → Categories.

Related APIs

• API Get Info
• API Add Project / API Update Project