Managing Teams and Team Members via the Super Send API

Managing Teams and Team Members via the Super Send API

The Super Send API allows you to organize your campaigns into teams and manage team members effectively. This guide outlines how to use the API to manage teams and their members, including adding, updating, and assigning roles.

1. Creating a Team

To create a new team, send a POST request to the teams endpoint.

Example Request:

curl -X POST https://api.supersend.io/v1/teams \
-H "Authorization: Bearer <YOUR_API_KEY>" \
-H "Content-Type: application/json" \
-d '{
  "name": "Sales Team",
  "description": "Handles all sales campaigns."
}'

Required Fields:

name: The name of the team (required).

Optional Fields:

description: A brief description of the team.

2. Updating a Team

To modify an existing team, use the PUT method with the team’s unique ID.

Example Request:

curl -X PUT https://api.supersend.io/v1/teams/<TEAM_ID> \
-H "Authorization: Bearer <YOUR_API_KEY>" \
-H "Content-Type: application/json" \
-d '{
  "name": "Updated Sales Team",
  "description": "Updated description for the sales team."
}'

3. Managing Team Members

Adding a Team Member:

Send a POST request to the team_members endpoint.

Example Request:

curl -X POST https://api.supersend.io/v1/team_members \
-H "Authorization: Bearer <YOUR_API_KEY>" \
-H "Content-Type: application/json" \
-d '{
  "email": "[email protected]",
  "TeamId": "your-team-id",
  "role": "admin"
}'

Required Fields:

email: The email address of the team member.
TeamId: The ID of the team to which the member will be added.
role: The role of the team member ( admin or read-only).

Roles:

admin: Full access to team campaigns and settings.
read-only: View-only access to campaigns.

Updating a Team Member:

Modify the role or other details of an existing team member.

Example Request:

curl -X PUT https://api.supersend.io/v1/team_members/<MEMBER_ID> \
-H "Authorization: Bearer <YOUR_API_KEY>" \
-H "Content-Type: application/json" \
-d '{
  "role": "read-only"
}'

Removing a Team Member:

Send a DELETE request to the team member’s endpoint.

Example Request:

curl -X DELETE https://api.supersend.io/v1/team_members/<MEMBER_ID> \
-H "Authorization: Bearer <YOUR_API_KEY>"

4. Retrieving Teams and Team Members

Retrieve All Teams:

curl -X GET https://api.supersend.io/v1/teams \
-H "Authorization: Bearer <YOUR_API_KEY>"

Retrieve Team Details:

curl -X GET https://api.supersend.io/v1/teams/<TEAM_ID> \
-H "Authorization: Bearer <YOUR_API_KEY>"

Retrieve Team Members:

curl -X GET https://api.supersend.io/v1/team_members?TeamId=<TEAM_ID> \
-H "Authorization: Bearer <YOUR_API_KEY>"

5. Best Practices for Managing Teams

Use Descriptive Names:
Name teams clearly to represent their purpose (e.g., "Marketing Team").

Assign Appropriate Roles:
Use admin for managers and read-only for members needing limited access.

Monitor Membership:
Regularly review team members to ensure correct roles and access levels.

Maintain Team Organization:
Ensure campaigns are grouped logically within the appropriate teams.



By effectively managing teams and team members through the Super Send API, you can maintain clear organization and control over your campaigns.

Updated on: 22/01/2025