Occassionally, you may need to update the details of a subproject using the Subproject API. This guide will walk you through how to update all details of your previously created subproject.
Before you can get started, you need the following already set up:
- All Subproject API configuration settings.
- Node.js and a familiarity with how to create a new app.
Once you setup your free Sinch account, create a new node app with npm.
npm initAccept the defaults for the application.
Add the fetch package with npm to generate the necessary dependencies.
npm install node-fetchCreate a new file named
index.mjsin the project and paste the provided code into the file.
import fetch from 'node-fetch';
const subprojectId = 'YOUR_subprojectId'; // The subproject ID you want to update
const displayName = 'Updated Display Name'; // New display name for the subproject
const labels = {
'region': 'US-West',
'department': 'Engineering'
};
const keyId = 'YOUR_Key_ID'; // Your Key ID from Sinch Build Dashboard
const keySecret = 'YOUR_Key_Secret'; // Your Key Secret from Sinch Build Dashboard
const updateData = {
displayName: displayName,
labels: labels
};
async function updateSubproject() {
try {
const response = await fetch(
`https://subproject.api.sinch.com/v1alpha1/subprojects/${subprojectId}`,
{
method: 'PATCH',
headers: {
'Authorization': `Basic ${Buffer.from(`${keyId}:${keySecret}`).toString('base64')}`,
'Content-Type': 'application/json'
},
body: JSON.stringify(updateData)
}
);
if (!response.ok) {
throw new Error(`HTTP error! status: ${response.status}`);
}
const data = await response.json();
console.log('Subproject updated successfully:', data);
return data;
} catch (error) {
console.error('Error updating subproject:', error);
throw error;
}
}
// Execute the function
updateSubproject();Now, we'll customize and run the code that will update your subproject.
Assign your values to the following parameters:
Parameter Your value YOUR_subprojectIdThe subproject ID that you would like to update. displayNameThe display name of the subproject is replaced by providing a new one. labelsUpdate any label key:value pairs. You can assign new values to current keys or add entirely new pairs. YOUR_Key_IDYour Key ID from Sinch Build Dashboard under Settings, then Access Keys. YOUR_Key_SecretYour Key Secret from Sinch Build Dashboard under Settings, then Access Keys. Save the file.
Execute the code and update your subproject.
Run the following command:
node index.mjs
Check out our full API reference for more subproject options.