Sender Profile API

Interfaces to manage sender profiles and campaign associations

Sender profiles allow you to group senders (email, LinkedIn, or Twitter) together and assign them to campaigns. This enables rotating between multiple senders automatically.

ℹ️

V2 API Available

V2 provides standardized responses for sender profile endpoints.

List Sender Profiles

Get all sender profiles for a team.

V2 API (Recommended)

bash

curl -X GET 'https://api.supersend.io/v2/sender-profiles?team_id=xxx&limit=20' \ -H "Authorization: Bearer YOUR_API_KEY"

# Response (200 OK) { "success": true, "data": [ { "object": "sender_profile", "id": "profile-uuid", "name": "Sales Team Profile", "sender_disable_strategy": true, "team_id": "team-uuid", "org_id": "org-uuid", "senders": [ { "id": "sender-uuid", "email": "sales@example.com", "send_as": "Sales Team <sales@example.com>", "warm": true, "disabled": false, "warming_stage": 3, "health_score": 95, "status": "active" } ], "linkedin_identity": null, "twitter_identity": null, "created_at": "2025-11-27T10:30:00Z", "updated_at": "2025-11-27T10:30:00Z" } ], "pagination": { "total": 3, "limit": 20, "offset": 0, "hasMore": false }, "request_id": "req_a1b2c3d4e5f6789012345678" }

V2 Query Parameters:

Parameter	Type	Required	Description
`team_id`	string	Yes	Team identifier
`name`	string	No	Search by profile name
`limit`	number	No	Results per page (default: 50, max: 100)
`offset`	number	No	Pagination offset (default: 0)

V1 API

bash

curl -X GET 'https://api.supersend.io/v1/sender-profiles?TeamId=xxx&limit=50' \
  -H "Authorization: Bearer YOUR_API_KEY"# Response
{
  "success": true,
  "senderProfiles": [...],
  "total": 3
}

Get Sender Profile

Get a specific sender profile.

V2 API (Recommended)

bash

curl -X GET 'https://api.supersend.io/v2/sender-profiles/profile-uuid' \ -H "Authorization: Bearer YOUR_API_KEY"

# Response (200 OK) { "success": true, "data": { "object": "sender_profile", "id": "profile-uuid", "name": "Sales Team Profile", "sender_disable_strategy": true, "team_id": "team-uuid", "org_id": "org-uuid", "senders": [ { "id": "sender-uuid", "email": "sales@example.com", "name": "Sales Sender", "warm": true, "disabled": false, "warming_stage": 3, "health_score": 95, "status": "active" } ], "linkedin_identity": { "id": "identity-uuid", "handle": "john-doe", "username": "John Doe", "first_name": "John", "last_name": "Doe", "photo": "https://...", "status": "active" }, "twitter_identity": null, "created_at": "2025-11-27T10:30:00Z", "updated_at": "2025-11-27T10:30:00Z" }, "request_id": "req_a1b2c3d4e5f6789012345678" }

Create Sender Profile

Create a new sender profile.

V2 API (Recommended)

bash

curl -X POST 'https://api.supersend.io/v2/sender-profiles' \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "name": "Sales Team Profile", "team_id": "team-uuid", "sender_disable_strategy": true }'

# Response (201 Created) { "success": true, "data": { "object": "sender_profile", "id": "profile-uuid", "name": "Sales Team Profile", "sender_disable_strategy": true, "team_id": "team-uuid", "org_id": "org-uuid", "senders": [], "linkedin_identity": null, "twitter_identity": null, "created_at": "2025-11-27T10:30:00Z", "updated_at": "2025-11-27T10:30:00Z" }, "request_id": "req_a1b2c3d4e5f6789012345678" }

V2 Create Parameters:

Parameter	Type	Required	Description
`name`	string	Yes	Profile name (1-100 characters)
`team_id`	string	Yes	Team identifier (UUID)
`sender_disable_strategy`	boolean	No	Enable sender disable strategy (default: true)

V1 API

bash

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

Note: V2 API does not use profile types. Sender profiles can contain email senders, LinkedIn identities, and Twitter identities simultaneously. The profile type is determined by the associated senders and identities.

Update Sender Profile

Update a sender profile, including adding/removing senders.

V2 API (Recommended)

bash

curl -X PATCH 'https://api.supersend.io/v2/sender-profiles/profile-uuid' \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "name": "Updated Profile Name", "sender_disable_strategy": false }'

# Response (200 OK) { "success": true, "data": { "object": "sender_profile", "id": "profile-uuid", "name": "Updated Profile Name", "sender_disable_strategy": false, "team_id": "team-uuid", "org_id": "org-uuid", "senders": [...], "linkedin_identity": {...}, "twitter_identity": null, "created_at": "2025-11-27T10:30:00Z", "updated_at": "2025-11-27T15:45:00Z" }, "request_id": "req_a1b2c3d4e5f6789012345678" }

V2 Update Parameters:

Parameter	Type	Required	Description
`name`	string	No	Profile name (1-100 characters)
`sender_disable_strategy`	boolean	No	Enable/disable sender disable strategy

Note: V2 Update does not support adding/removing senders or identities. Use V1 API for those operations.

V1 API

V1 supports more advanced operations:

bash

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

Delete Sender Profile

V2 API (Recommended)

bash

curl -X DELETE 'https://api.supersend.io/v2/sender-profiles/profile-uuid' \ -H "Authorization: Bearer YOUR_API_KEY"

# Response (200 OK) { "success": true, "message": "Sender profile deleted successfully", "request_id": "req_a1b2c3d4e5f6789012345678" }

V1 API

bash

curl -X DELETE 'https://api.supersend.io/v1/sender-profile/profile-uuid' \
  -H "Authorization: Bearer YOUR_API_KEY"

Campaign Associations (V1 Only)

Get Campaign Sender Profiles

bash

curl -X GET 'https://api.supersend.io/v1/campaign-sender-profile?CampaignId=xxx' \
  -H "Authorization: Bearer YOUR_API_KEY"

Add Profile to Campaign

bash

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

Remove Profile from Campaign

bash

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

V1 vs V2 Endpoint Mapping

Action	V1 Endpoint	V2 Endpoint
List	`GET /v1/sender-profiles`	`GET /v2/sender-profiles`
Get	`GET /v1/sender-profile/:id`	`GET /v2/sender-profiles/:id`
Create	`POST /v1/sender-profile`	`POST /v2/sender-profiles`
Update	`PUT /v1/sender-profile/:id`	`PATCH /v2/sender-profiles/:id`
Delete	`DELETE /v1/sender-profile/:id`	`DELETE /v2/sender-profiles/:id`
Campaign associations	V1 only	Not available in V2