API Set Project Id

Set Project Id

Sets fixed/display project ids for one or more existing projects.

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/setFixedId', {
    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: [
				{ ProjectKey: "32161f13-474b-442f-ac1f-edca7348e000", FixedId: "AB-100" },
				{ ProjectKey: "42161f13-474b-442f-ac1f-edca7348e001", FixedId: "AB-101" }
			]
        })
})
.then(response => response.json())
.then(data=>{console.log('Success: ',data);})
.catch((error)=>{console.log('Error: ', error);});

Response

On success:

{
  Success: true,
  Message: "",  // lists any ProjectKeys that failed: "Id not set for {guid}"
  Body: null
}

Field notes

• Body is an array of { ProjectKey, FixedId } (not a single object).
• Empty array returns: There are no Id's to set.
• Individual failures are reported in Message while Success may still be true.

Related APIs

• API Add Project (also accepts FixedProjectId at create time)
• API Get Projects