API Set Project Id - Revision history

Trent: Remove username/password API auth; ApiKey only

2026-07-25T18:55:16Z

Remove username/password API auth; ApiKey only

Trent: Document batch setFixedId body array

2026-07-25T18:49:46Z

Document batch setFixedId body array

Peter at 03:57, 11 April 2024

2024-04-11T03:57:09Z

Trent at 23:59, 27 February 2023

2023-02-27T23:59:20Z

Trent at 23:56, 27 February 2023

2023-02-27T23:56:58Z

Trent at 23:51, 27 February 2023

2023-02-27T23:51:46Z

Trent: Created page with "== Set Project Id== You can use our api to set an entry's or projects Id. To do this you need to POST a message to your site. Below is an example of what needs to be posted...."

2023-02-27T23:49:36Z

Created page with "== Set Project Id== You can use our api to set an entry's or projects Id. To do this you need to POST a message to your site. Below is an example of what needs to be posted...."

New page

== Set Project Id==
You can use our api to set an entry's or projects Id. To do this you need to POST a message to your site. Below is an example of what needs to be posted.

If you only want to update a project see [[API Update Project]]

<syntaxhighlight lang="JavaScript" line>

fetch('/api/data/setFixedId', {
method:'POST',
headers:{'Content-Type': 'application/json'},
body: JSON.stringify({
Username:'admin username',
Password: 'password',
FairId: '9df61f13-474b-442f-ac1f-edca7348ef71', //This value can be found in your url it's the value of f
Body: [{
ProjectKey: '36 char GUID'
FixedId: 'Your Id'
},...]
})
})
.then(response => response.json())
.then(data=>{console.log('Success: ',data);})
.catch((error)=>{console.log('Error: ', error);});

</syntaxhighlight>

[[Category: API]]

@@ Line 9: / Line 9: @@
 ! Field !! Required !! Description
 |-
-| <code>ApiKey</code> || Yes* || Private API key for your site. Prefer this over username/password.
+| <code>ApiKey</code> || Yes || Private API key for your site.
 |-
 | <code>FairId</code> || Yes || Fair GUID from the site URL (<code>f</code> query parameter).
@@ Line 18: / Line 16: @@
 |}
 Calls must be run '''server-side''' — do not expose your API key in a browser.

@@ Line 27: / Line 27: @@
 If you want to remove the fixed id you set just set the value of FixedId to null FixedId:null
+*The body of the posted data is an array so you can update multiple project Id's at once.
 [[Category: API]]

← Older revision		Revision as of 23:56, 27 February 2023
Line 24:		Line 24:

	</syntaxhighlight>		</syntaxhighlight>
		+
		+	If you want to remove the fixed id you set just set the value of FixedId to null FixedId:null
		+
		+

	[[Category: API]]		[[Category: API]]

@@ Line 1: / Line 1: @@
-== Set Project Id==
+== Set Project Id ==
-You can use our api to set an entry's or projects Id. To do this you need to POST a message to your site. Below is an example of what needs to be posted.
+Sets fixed/display project ids for one or more existing projects.
-If you only want to update a project see [[API Update Project]]
+=== Authentication ===
 <syntaxhighlight lang="JavaScript" line>
 fetch('/api/data/setFixedId', {
      method:'POST',
@@ Line 11: / Line 41: @@
      body: JSON.stringify({
              ApiKey:'<Private key>',
-             FairId: '9df61f13-474b-442f-ac1f-edca7348ef71', //This value can be found in your url it's the value of f
+             FairId: '9df61f13-474b-442f-ac1f-edca7348ef71', // value of f in your URL
-             Body: [{
+             Body: [
-                   ProjectKey: '36 char GUID',
+				{ ProjectKey: "32161f13-474b-442f-ac1f-edca7348e000", FixedId: "AB-100" },
-                   FixedId: 'Your Id'
+				{ ProjectKey: "42161f13-474b-442f-ac1f-edca7348e001", FixedId: "AB-101" }
-            },...]
          })
 })
@@ Line 21: / Line 51: @@
 .then(data=>{console.log('Success: ',data);})
 .catch((error)=>{console.log('Error: ', error);});
-If you want to remove the fixed id you set just set the value of FixedId to null FixedId:null
+=== Related APIs ===
 [[Category: API]]