Skip to content

Activate process

Endpoint

PUT /organizations/{org_id}/runs/{run_id}/activate

This endpoint restores (unarchives) a previously archived process instance (run), making it active again.

Request

Replace {org_id} with your Organization ID and {run_id} with the ID of the process run to activate.

Headers

  • Authorization: Bearer {your_access_token}
  • Accept: application/json
  • X-Tallyfy-Client: APIClient

Body

No request body is needed for this PUT request.

Code samples

const accessToken = 'YOUR_PERSONAL_ACCESS_TOKEN';
const orgId = 'YOUR_ORGANIZATION_ID';
const runId = 'PROCESS_RUN_ID_TO_ACTIVATE';
const apiUrl = `https://go.tallyfy.com/api/organizations/${orgId}/runs/${runId}/activate`;
const headers = new Headers();
headers.append('Authorization', `Bearer ${accessToken}`);
headers.append('Accept', 'application/json');
headers.append('X-Tallyfy-Client', 'APIClient');
fetch(apiUrl, {
method: 'PUT', // Use PUT method
headers: headers
// No body required for this request
})
.then(response => {
return response.json().then(data => { // Attempt to parse JSON regardless of status
if (!response.ok) { // Expect 200 OK on success
console.error(`Failed to activate process ${runId}:`, data);
throw new Error(`HTTP error! status: ${response.status}`);
}
console.log(`Successfully activated process ${runId}. Status: ${response.status}`);
return data; // Activation returns the updated process
});
})
.then(data => {
console.log('Activated process details:');
console.log(JSON.stringify(data, null, 2));
})
.catch(error => {
console.error(`Error activating process ${runId}:`, error.message);
});

Response

A successful request returns a 200 OK status code. The response body contains the details of the reactivated process run, with the archived_at timestamp removed and the status updated (likely to its pre-archive state, e.g., active or complete).

{
"data": {
"id": "PROCESS_RUN_ID_TO_ACTIVATE",
"name": "Restored Project Run",
"status": "active", // Or 'complete', etc.
"archived_at": null, // Timestamp is removed
// ... other process properties ...
"last_updated": "2024-05-22T11:00:00Z" // Reflects activation time
}
}

If the process run ID is not found, was not archived, or you lack permission, an error status code (404, 400, 403) will be returned.


Processes > Archive process

The DELETE endpoint enables archiving of process instances by hiding them from default views while maintaining data accessibility for future restoration through authenticated API requests.

Processes > Delete process

A DELETE endpoint permanently removes a specific process instance and its associated data with authentication headers returning either 200 OK or 204 No Content status codes upon successful deletion.

Processes > Update process

A PUT endpoint that allows updating properties of an existing process run including name summary owner tags folders and form field values while returning the complete updated process data upon success.

Tasks > Reopen task

A comprehensive guide for reopening completed tasks through DELETE requests with authentication headers showcasing implementation examples in JavaScript Python Java and Go.