Skip to content
Tallyfy

Update process

Endpoint

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

Updates properties of an existing process (run). You only need to send the fields you want to change.

Request

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

Headers

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

Body (JSON)

Send a JSON object with only the fields you want to modify. Updatable fields:

  • name (string): Process name (max 550 characters).
  • summary (string): Process description text.
  • owner_id (string): User ID of the new process owner. Must belong to the organization.
  • starred (boolean): Whether the process is starred/favorited.
  • is_public (boolean): Whether the process is publicly accessible.
  • publicly_hidden_fields (array): Field IDs to hide from public view.
  • users (array of strings): User IDs assigned to the process. Replaces all current user assignees.
  • groups (array of strings): Group IDs assigned to the process. Replaces all current group assignees.
  • prerun (object): Update kick-off form field values. Keys are field timeline IDs, values depend on field type. See Launch process.

Example body:

{
  "name": "Onboarding - Globex Corp (Updated)",
  "summary": "Updated summary notes for this run.",
  "starred": true,
  "users": ["user_id_1", "user_id_2"]
}

Code Samples

const accessToken = 'YOUR_PERSONAL_ACCESS_TOKEN';
const orgId = 'YOUR_ORGANIZATION_ID';
const runId = 'PROCESS_RUN_ID_TO_UPDATE';
const apiUrl = `https://go.tallyfy.com/api/organizations/${orgId}/runs/${runId}`;


const updateData = {
  name: "JS Updated Process Name",
  summary: "Adding more details here.",
  starred: true
};


const headers = new Headers();
headers.append('Authorization', `Bearer ${accessToken}`);
headers.append('Accept', 'application/json');
headers.append('X-Tallyfy-Client', 'APIClient');
headers.append('Content-Type', 'application/json');


fetch(apiUrl, {
    method: 'PUT',
    headers: headers,
    body: JSON.stringify(updateData)
})
.then(response => {
    return response.json().then(data => {
        if (!response.ok) {
            console.error(`Failed to update process ${runId}:`, data);
            throw new Error(`HTTP error! status: ${response.status}`);
        }
        return data;
    });
})
.then(data => {
    console.log(`Successfully updated process ${runId}:`);
    console.log(JSON.stringify(data, null, 2));
})
.catch(error => {
    console.error(`Error updating process ${runId}:`, error.message);
});

Response

Returns 200 OK with the full updated process wrapped in a data object.

{
  "data": {
    "id": "PROCESS_RUN_ID_TO_UPDATE",
    "checklist_id": "template_timeline_id",
    "checklist_title": "Onboarding Template",
    "name": "Onboarding - Globex Corp (Updated)",
    "summary": "Updated summary notes for this run.",
    "status": "active",
    "progress": 25,
    "owner_id": "user_id",
    "starred": true,
    "is_public": false,
    "users": [],
    "groups": [],
    "created_at": "2025-01-15T10:00:00Z",
    "last_updated": "2025-01-20T14:30:00Z"
  }
}

If the run ID isn’t found, you don’t have permission, or the request body is invalid, you’ll get a 404, 403, or 422 error response.

Tasks > Update task

Tallyfy’s API lets you update any task (process or one-off) via a PUT request where you can change the title, deadline, assignees, form field values, and other properties — with assignee updates replacing the entire list rather than merging and with different field types like dropdowns and checkboxes requiring specific JSON formatting structures.

Templates > Update template

Tallyfy’s API lets you update an existing template by sending a PUT request with a required title field and optional properties like guidance text and owner and webhook URL and folder assignment and public visibility and auto-naming format and user/group lists where array fields fully replace existing lists rather than appending to them.

Edit Processes > Edit tasks and process properties

Tallyfy lets you modify a running process without restarting it by opening the process from Tracker view and clicking the Settings gear icon to rename it and reassign the owner and add notes or export data.

Code Samples > Managing processes (Runs)

The Tallyfy API manages processes (called “runs”) through org-scoped endpoints that cover launching from templates or as empty containers and listing and filtering and fetching details and updating and archiving and restoring and permanently deleting processes along with retrieving activity feeds for audit trails.
Get in touch
About Tallyfy