Skip to content

Create group

Endpoint

POST /organizations/{org_id}/groups

Creates a new group in your Tallyfy organization.

Request

Replace {org_id} with your actual Organization ID.

Headers

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

Body (JSON)

FieldTypeRequiredDescription
namestringYesGroup name (max 200 chars, must be unique in the org)
descriptionstringYesA description for the group
membersarray of integersNoUser IDs to add as members
guestsarray of stringsNoEmail addresses for guests to add

Example body:

{
"name": "Onboarding Specialists",
"description": "Team responsible for new client onboarding.",
"members": [1001, 1005, 1008],
"guests": ["client.liaison@partner.com"]
}

Code samples

const accessToken = 'YOUR_PERSONAL_ACCESS_TOKEN';
const orgId = 'YOUR_ORGANIZATION_ID';
const apiUrl = `https://go.tallyfy.com/api/organizations/${orgId}/groups`;
const groupData = {
name: "Marketing Campaign Crew",
description: "Cross-functional team for marketing initiatives.",
members: [1002, 1003],
guests: ["freelancer@design.co"]
};
const response = await fetch(apiUrl, {
method: 'POST',
headers: {
'Authorization': `Bearer ${accessToken}`,
'Accept': 'application/json',
'X-Tallyfy-Client': 'APIClient',
'Content-Type': 'application/json'
},
body: JSON.stringify(groupData)
});
const data = await response.json();
if (!response.ok) {
console.error("Failed to create group:", data);
} else {
console.log('Created group:', JSON.stringify(data, null, 2));
}

Response

A successful request returns a 201 Created status. The response JSON wraps the new group inside a data object.

{
"data": {
"id": "new_group_id_789",
"name": "Onboarding Specialists",
"description": "Team responsible for new client onboarding.",
"logo": null,
"members": [1001, 1005, 1008],
"guests": ["client.liaison@partner.com"],
"created_at": "2025-06-10T14:30:00.000Z",
"last_updated": "2025-06-10T14:30:00.000Z"
}
}

Save the returned id — you’ll need it to get, update, or delete this group later.


Groups > Update group

Tallyfy’s PUT endpoint for groups lets you rename a group or change its description and fully replace its member and guest lists by sending updated user IDs or email arrays to /organizations/[org_id]/groups/[group_id] with code samples in JavaScript and Python and Java and Go and C++ and C#.

Groups > Get group

The Tallyfy API lets you fetch details of a specific group within your organization by sending a GET request to /organizations/[org_id]/groups/[group_id] and it returns the group’s name and description along with member IDs and guest emails and timestamps with an optional with=assets parameter to include logo file details.

Code Samples > Managing groups

Tallyfy’s Groups API lets you bundle members and guests into reusable groups that can be assigned to tasks and processes through standard create/list/get/update/delete operations scoped to your organization.

Tags > Create tag

Tallyfy’s API lets you create organization tags by sending a POST request to the tags endpoint with a required title (up to 30 characters) and an optional hex color code then returns the new tag’s ID and details with a 201 status.