Sender Profile API

Sender profiles allow you to group senders (email, LinkedIn, or Twitter) together and assign them to campaigns. You can create profiles, manage senders within profiles, and associate profiles with cam

Get All Sender Profiles

Update a sender profile. You can update the name, add/remove senders, and assign LinkedIn or Twitter identities.

bash

curl -X GET 'https://api.supersend.io/v1/sender-profiles?TeamId=team-uuid&limit=50&offset=0&name=Sales' -H "Authorization: Bearer <API_KEY>" -H "Content-Type: application/json"

# Response
{
  "success": true,
  "senderProfiles": [
    {
      "id": "profile-uuid",
      "name": "Sales Team Profile",
      "type": "email_sender",
      "status": "active",
      "TeamId": "team-uuid",
      "OrgId": "org-uuid",
      "UserId": "user-uuid",
      "sender_disable_strategy": false,
      "createdAt": "2025-11-27T10:30:00Z",
      "updatedAt": "2025-11-27T10:30:00Z",
      "Senders": [
        {
          "id": "sender-uuid",
          "email": "sales@example.com",
          "SenderProfileId": "profile-uuid"
        }
      ],
      "twitterIdentity": null,
      "linkedinIdentity": {
        "id": "identity-uuid",
        "username": "sales-team",
        "type": 1,
        "status": 1
      }
    }
  ],
  "total": 1
}

Create Sender Profile

Note: You cannot include the same sender ID in both sendersToAdd and sendersToRemove arrays. The update will trigger demand calculation for active campaigns.

Update Sender Profile

Soft delete a sender profile. All senders associated with the profile will have their SenderProfileId set to null.

Delete Sender Profile

Note: This is a soft delete operation. The profile is marked as deleted but not permanently removed from the database.

bash

curl -X POST 'https://api.supersend.io/v1/sender-profile' -H "Authorization: Bearer <API_KEY>" -H "Content-Type: application/json" -d '{
  "name": "Sales Team Profile",
  "TeamId": "team-uuid",
  "type": "email_sender"
}'

# Response
{
  "success": true,
  "senderProfile": {
    "id": "profile-uuid",
    "name": "Sales Team Profile",
    "type": "email_sender",
    "status": "active",
    "TeamId": "team-uuid",
    "OrgId": "org-uuid",
    "UserId": "user-uuid",
    "createdAt": "2025-11-27T10:30:00Z",
    "updatedAt": "2025-11-27T10:30:00Z"
  }
}

Get Campaign Sender Profiles

Get all sender profiles associated with a specific campaign.

bash

sender_disable_strategy

Add Sender Profile to Campaign

Associate a sender profile with a campaign. This allows the campaign to use all senders in the profile.

bash

curl -X PUT 'https://api.supersend.io/v1/sender-profile/<id>' -H "Authorization: Bearer <API_KEY>" -H "Content-Type: application/json" -d '{
  "TeamId": "team-uuid",
  "name": "Updated Sales Team Profile",
  "sendersToAdd": ["sender-uuid-1", "sender-uuid-2"],
  "sendersToRemove": ["sender-uuid-3"],
  "twitterIdentityId": "identity-uuid",
  "linkedinIdentityId": null,
  "sender_disable_strategy": false
}'

# Response
{
  "success": true,
  "senderProfile": {
    "id": "profile-uuid",
    "name": "Updated Sales Team Profile",
    "type": "email_sender",
    "status": "active",
    "TeamId": "team-uuid",
    "sender_disable_strategy": false,
    "Senders": [
      {
        "id": "sender-uuid-1",
        "email": "sales1@example.com"
      },
      {
        "id": "sender-uuid-2",
        "email": "sales2@example.com"
      }
    ],
    "twitterIdentity": {
      "id": "identity-uuid",
      "username": "sales-team",
      "type": 2,
      "status": 1
    },
    "linkedinIdentity": null
  }
}

Remove Sender Profile from Campaign

Note: The sender profile must belong to the same team as the campaign. If the campaign is active, this will trigger demand calculation. If the association already exists, the request will return an error.

bash

curl -X DELETE 'https://api.supersend.io/v1/sender-profile/<id>' -H "Authorization: Bearer <API_KEY>" -H "Content-Type: application/json"

# Response
{
  "success": true,
  "message": "Sender profile deleted successfully"
}

bash

curl -X GET 'https://api.supersend.io/v1/campaign-sender-profile?CampaignId=campaign-uuid' -H "Authorization: Bearer <API_KEY>" -H "Content-Type: application/json"

# Response
{
  "success": true,
  "senderProfiles": [
    {
      "id": "profile-uuid",
      "name": "Sales Team Profile",
      "type": "email_sender",
      "status": "active",
      "TeamId": "team-uuid",
      "Senders": [
        {
          "id": "sender-uuid",
          "email": "sales@example.com"
        }
      ],
      "twitterIdentity": null,
      "linkedinIdentity": {
        "id": "identity-uuid",
        "username": "sales-team",
        "type": 1,
        "status": 1
      }
    }
  ]
}

Examples

bash

curl -X POST 'https://api.supersend.io/v1/campaign-sender-profile' -H "Authorization: Bearer <API_KEY>" -H "Content-Type: application/json" -d '{
  "CampaignId": "campaign-uuid",
  "SenderProfileId": "profile-uuid"
}'

# Response
{
  "success": true,
  "association": {
    "id": "association-uuid",
    "CampaignId": "campaign-uuid",
    "SenderProfileId": "profile-uuid",
    "createdAt": "2025-11-27T10:30:00Z"
  },
  "name": "Sales Team Profile",
  "senders": [
    {
      "id": "sender-uuid",
      "email": "sales@example.com"
    }
  ]
}

bash

curl -X DELETE 'https://api.supersend.io/v1/campaign-sender-profile' -H "Authorization: Bearer <API_KEY>" -H "Content-Type: application/json" -d '{
  "CampaignId": "campaign-uuid",
  "SenderProfileId": "profile-uuid"
}'

# Response
{
  "success": true,
  "message": "Association deleted successfully"
}