# SenderPool Senders resource
The Senders in a SenderPool subresource lets you manage which senders are assigned to a specific SenderPool. You can list, add, and remove senders from a pool.
## Sender Properties
## Add Senders to a SenderPool
`POST https://comms.twilio.com/v1/SenderPools/{senderPoolId}/Senders`
Add one or more Senders to a SenderPool.
### Path parameters
```json
[{"schema":{"x-twilio-version":1,"description":"A reference to a SenderPool.","title":"SenderPoolId","type":"string","pattern":"^comms_senderpool_[0-7][a-hjkmnpqrstv-z0-9]{25,34}","example":"comms_senderpool_01h9krwprkeee8fzqspvwy6nq8","refName":"SenderPoolId","modelName":""},"name":"senderPoolId","in":"path","required":true,"x-twilio-version":1}]
```
### Request body parameters
```json
{"schema":{"title":"AddSendersToSenderPoolRequest","description":"List of Senders to add to the SenderPool.","type":"array","minItems":1,"maxItems":10000,"items":{"title":"AddSendersToSenderPoolRequestItem","description":"A Sender identified by ID to add to the SenderPool.","x-twilio-version":1,"type":"object","required":["senderId"],"properties":{"senderId":{"x-twilio-version":1,"description":"A reference to a Sender.","title":"SenderId","type":"string","pattern":"^comms_sender_[0-7][a-hjkmnpqrstv-z0-9]{25,34}","example":"comms_sender_01h9krwprkeee8fzqspvwy6nq8","refName":"SenderId","modelName":""}}}},"examples":{"AddSenderToSenderPool":{"x-twilio-version":1,"summary":"Add Sender to SenderPool","value":{"lang":"json","value":"[\n {\n \"senderId\": \"comms_sender_01h9krwprkeee8fzqspvwy6nq8\"\n }\n]","meta":"","code":"[\n {\n \"senderId\": \"comms_sender_01h9krwprkeee8fzqspvwy6nq8\"\n }\n]","tokens":[["[","#C9D1D9"],"\n ",["{","#C9D1D9"],"\n ",["\"senderId\"","#7EE787"],[":","#C9D1D9"]," ",["\"comms_sender_01h9krwprkeee8fzqspvwy6nq8\"","#A5D6FF"],"\n ",["}","#C9D1D9"],"\n",["]","#C9D1D9"]],"annotations":[],"themeName":"github-dark","style":{"color":"#c9d1d9","background":"#0d1117"}}},"AddMultipleSendersToSenderPool":{"x-twilio-version":1,"summary":"Add multiple Senders to SenderPool","value":{"lang":"json","value":"[\n {\n \"senderId\": \"comms_sender_01h9krwprkeee8fzqspvwy6nq8\"\n },\n {\n \"senderId\": \"comms_sender_01h9krwprkeee8fzqspvwy6nq7\"\n },\n {\n \"senderId\": \"comms_sender_01h9krwprkeee8fzqspvwy6nq6\"\n }\n]","meta":"","code":"[\n {\n \"senderId\": \"comms_sender_01h9krwprkeee8fzqspvwy6nq8\"\n },\n {\n \"senderId\": \"comms_sender_01h9krwprkeee8fzqspvwy6nq7\"\n },\n {\n \"senderId\": \"comms_sender_01h9krwprkeee8fzqspvwy6nq6\"\n }\n]","tokens":[["[","#C9D1D9"],"\n ",["{","#C9D1D9"],"\n ",["\"senderId\"","#7EE787"],[":","#C9D1D9"]," ",["\"comms_sender_01h9krwprkeee8fzqspvwy6nq8\"","#A5D6FF"],"\n ",["},","#C9D1D9"],"\n ",["{","#C9D1D9"],"\n ",["\"senderId\"","#7EE787"],[":","#C9D1D9"]," ",["\"comms_sender_01h9krwprkeee8fzqspvwy6nq7\"","#A5D6FF"],"\n ",["},","#C9D1D9"],"\n ",["{","#C9D1D9"],"\n ",["\"senderId\"","#7EE787"],[":","#C9D1D9"]," ",["\"comms_sender_01h9krwprkeee8fzqspvwy6nq6\"","#A5D6FF"],"\n ",["}","#C9D1D9"],"\n",["]","#C9D1D9"]],"annotations":[],"themeName":"github-dark","style":{"color":"#c9d1d9","background":"#0d1117"}}}},"encodingType":"application/json","conditionalParameterMap":{}}
```
### Responses
Add Senders to a SenderPool
```ts
import { TwilioClient } from "twilio-comms";
async function main() {
const client = new TwilioClient({
accountId: "TWILIO_ACCOUNT_SID",
authToken: "TWILIO_AUTH_TOKEN",
});
await client.senderPools.addSender("comms_senderpool_01h9krwprkeee8fzqspvwy6nq8", [
{
senderId: "comms_sender_01h9krwprkeee8fzqspvwy6nq8",
},
]);
}
main();
```
```py
from twilio_comms import TwilioComms
client = TwilioComms(
account_id="TWILIO_ACCOUNT_SID",
auth_token="TWILIO_AUTH_TOKEN",
)
client.sender_pools.add_sender(
sender_pool_id="comms_senderpool_01h9krwprkeee8fzqspvwy6nq8",
request=[
{
"sender_id": "comms_sender_01h9krwprkeee8fzqspvwy6nq8"
}
],
)
```
```cs
using Twilio.Comms;
using System.Threading.Tasks;
using System.Collections.Generic;
public partial class Examples
{
public async Task Example() {
var client = new TwilioComms(
accountId: "TWILIO_ACCOUNT_SID",
authToken: "TWILIO_AUTH_TOKEN"
);
await client.SenderPools.AddSenderAsync(
"comms_senderpool_01h9krwprkeee8fzqspvwy6nq8",
new List(){
new SenderPoolsAddSenderRequestItem {
SenderId = "comms_sender_01h9krwprkeee8fzqspvwy6nq8"
},
}
);
}
}
```
```java
package com.example.usage;
import com.twilio.sdk.TwilioComms;
import com.twilio.sdk.resources.senderpools.types.SenderPoolsAddSenderRequestItem;
import java.util.Arrays;
public class Example {
public static void main(String[] args) {
TwilioComms client = TwilioComms
.builder()
.credentials("TWILIO_ACCOUNT_SID", "TWILIO_AUTH_TOKEN")
.build();
client.senderPools().addSender(
"comms_senderpool_01h9krwprkeee8fzqspvwy6nq8",
Arrays.asList(
SenderPoolsAddSenderRequestItem
.builder()
.senderId("comms_sender_01h9krwprkeee8fzqspvwy6nq8")
.build()
)
);
}
}
```
```go
package example
import (
context "context"
twiliocomms "github.com/twilio/twilio-comms-go/twilio"
client "github.com/twilio/twilio-comms-go/twilio/client"
option "github.com/twilio/twilio-comms-go/twilio/option"
)
func do() {
client := client.NewWithOptions(
option.WithBasicAuth(
"TWILIO_ACCOUNT_SID",
"TWILIO_AUTH_TOKEN",
),
)
request := []*twiliocomms.SenderPoolsAddSenderRequestItem{
&twiliocomms.SenderPoolsAddSenderRequestItem{
SenderId: "comms_sender_01h9krwprkeee8fzqspvwy6nq8",
},
}
client.SenderPools.AddSender(
context.TODO(),
"comms_senderpool_01h9krwprkeee8fzqspvwy6nq8",
request,
)
}
```
```php
senderPools->addSender(
'comms_senderpool_01h9krwprkeee8fzqspvwy6nq8',
[
new SenderPoolsAddSenderRequestItem([
'senderId' => 'comms_sender_01h9krwprkeee8fzqspvwy6nq8',
]),
],
);
```
```rb
require "twiliocomms"
client = TwilioComms::Client.new(
account_id: "TWILIO_ACCOUNT_SID",
auth_token: "TWILIO_AUTH_TOKEN"
)
client.sender_pools.add_sender(
sender_pool_id: "comms_senderpool_01h9krwprkeee8fzqspvwy6nq8",
request: [{
sender_id: "comms_sender_01h9krwprkeee8fzqspvwy6nq8"
}]
)
```
```bash
curl -X POST "https://comms.twilio.com/v1/SenderPools/comms_senderpool_01h9krwprkeee8fzqspvwy6nq8/Senders" \
--header "Content-Type: application/json" \
--data "[
{
"senderId": "your_sender_id"
}
]" \
-u $TWILIO_ACCOUNT_SID:$TWILIO_AUTH_TOKEN
```
## List Senders in a SenderPool
`GET https://comms.twilio.com/v1/SenderPools/{senderPoolId}/Senders`
Retrieve a list of Senders assigned to a specific SenderPool.
### Path parameters
```json
[{"schema":{"x-twilio-version":1,"description":"A reference to a SenderPool.","title":"SenderPoolId","type":"string","pattern":"^comms_senderpool_[0-7][a-hjkmnpqrstv-z0-9]{25,34}","example":"comms_senderpool_01h9krwprkeee8fzqspvwy6nq8","refName":"SenderPoolId","modelName":""},"name":"senderPoolId","in":"path","required":true,"x-twilio-version":1}]
```
### Query parameters
```json
[{"in":"query","name":"channel","description":"Filter to Senders that match a specific channel.","x-twilio-version":1,"schema":{"x-twilio-version":1,"description":"The medium which a unit of communication is transmitted through.\nThese are differentiated by a mix of transmission protocol, network controller/owner, endpoint and address model,\nas well as the model for content of the atomic unit of communication itself.","title":"SenderCommunicationChannel","type":"string","enum":["SMS","RCS","EMAIL","WHATSAPP","PUSH"],"refName":"SenderCommunicationChannel","modelName":"SenderCommunicationChannel"}},{"in":"query","name":"status","description":"Filter to Senders with the specified status.","x-twilio-version":1,"schema":{"title":"SenderStatus","description":"The status of a Sender.\nIf a Sender is `activated`, it is available to send and receive communications.\nIf a Sender is `deactivated`, it is not available to send or receive communications.","x-twilio-version":1,"type":"string","enum":["ACTIVATED","DEACTIVATED"],"refName":"SenderStatus","modelName":"SenderStatus"}},{"in":"query","name":"startDate","description":"Filter to Senders created after the specified date and time in ISO 8601 format.","x-twilio-version":1,"schema":{"type":"string","format":"date-time"}},{"in":"query","name":"endDate","description":"Filter to Senders created before the specified date and time in ISO 8601 format.","x-twilio-version":1,"schema":{"type":"string","format":"date-time"}},{"in":"query","name":"pageToken","description":"A page token that represents the start Sender of a page","x-twilio-version":1,"schema":{"type":"string"}},{"in":"query","name":"pageSize","x-twilio-version":1,"schema":{"x-twilio-version":1,"description":"Total number of items returned in a single page, the minimum is 1 and maximum is 1000. Default is 50.","title":"PageSize","type":"integer","minimum":1,"maximum":1000,"default":50,"example":50,"refName":"PageSize","modelName":""}}]
```
### Responses
List Senders in a SenderPool
```ts
import { TwilioClient } from "twilio-comms";
async function main() {
const client = new TwilioClient({
accountId: "TWILIO_ACCOUNT_SID",
authToken: "TWILIO_AUTH_TOKEN",
});
await client.senderPools.listSenders("comms_senderpool_01h9krwprkeee8fzqspvwy6nq8", {
channel: "SMS",
status: "ACTIVATED",
startDate: new Date("2024-01-15T09:30:00Z"),
endDate: new Date("2024-01-15T09:30:00Z"),
pageToken: "pageToken",
pageSize: 50,
});
}
main();
```
```py
from twilio_comms import TwilioComms
import datetime
client = TwilioComms(
account_id="TWILIO_ACCOUNT_SID",
auth_token="TWILIO_AUTH_TOKEN",
)
client.sender_pools.list_senders(
sender_pool_id="comms_senderpool_01h9krwprkeee8fzqspvwy6nq8",
channel="SMS",
status="ACTIVATED",
start_date=datetime.datetime.fromisoformat("2024-01-15T09:30:00+00:00"),
end_date=datetime.datetime.fromisoformat("2024-01-15T09:30:00+00:00"),
page_token="pageToken",
page_size=50,
)
```
```cs
using Twilio.Comms;
using System.Threading.Tasks;
using System;
using System.Globalization;
public partial class Examples
{
public async Task Example() {
var client = new TwilioComms(
accountId: "TWILIO_ACCOUNT_SID",
authToken: "TWILIO_AUTH_TOKEN"
);
await client.SenderPools.ListSendersAsync(
"comms_senderpool_01h9krwprkeee8fzqspvwy6nq8",
new SenderPoolsListSendersRequest {
Channel = SenderCommunicationChannel.Sms,
Status = SenderStatus.Activated,
StartDate = DateTime.Parse("2024-01-15T09:30:00Z", null, DateTimeStyles.AdjustToUniversal),
EndDate = DateTime.Parse("2024-01-15T09:30:00Z", null, DateTimeStyles.AdjustToUniversal),
PageToken = "pageToken",
PageSize = 50
}
);
}
}
```
```java
package com.example.usage;
import com.twilio.sdk.TwilioComms;
import com.twilio.sdk.resources.senderpools.requests.SenderPoolsListSendersRequest;
import com.twilio.sdk.types.SenderCommunicationChannel;
import com.twilio.sdk.types.SenderStatus;
import java.time.OffsetDateTime;
public class Example {
public static void main(String[] args) {
TwilioComms client = TwilioComms
.builder()
.credentials("TWILIO_ACCOUNT_SID", "TWILIO_AUTH_TOKEN")
.build();
client.senderPools().listSenders(
"comms_senderpool_01h9krwprkeee8fzqspvwy6nq8",
SenderPoolsListSendersRequest
.builder()
.channel(SenderCommunicationChannel.SMS)
.status(SenderStatus.ACTIVATED)
.startDate(OffsetDateTime.parse("2024-01-15T09:30:00Z"))
.endDate(OffsetDateTime.parse("2024-01-15T09:30:00Z"))
.pageToken("pageToken")
.pageSize(50)
.build()
);
}
}
```
```go
package example
import (
context "context"
twiliocomms "github.com/twilio/twilio-comms-go/twilio"
client "github.com/twilio/twilio-comms-go/twilio/client"
option "github.com/twilio/twilio-comms-go/twilio/option"
)
func do() {
client := client.NewWithOptions(
option.WithBasicAuth(
"TWILIO_ACCOUNT_SID",
"TWILIO_AUTH_TOKEN",
),
)
request := &twiliocomms.SenderPoolsListSendersRequest{
Channel: twiliocomms.SenderCommunicationChannelSms.Ptr(),
Status: twiliocomms.SenderStatusActivated.Ptr(),
StartDate: twiliocomms.Time(
twiliocomms.MustParseDateTime(
"2024-01-15T09:30:00Z",
),
),
EndDate: twiliocomms.Time(
twiliocomms.MustParseDateTime(
"2024-01-15T09:30:00Z",
),
),
PageToken: twiliocomms.String(
"pageToken",
),
PageSize: twiliocomms.Int(
50,
),
}
client.SenderPools.ListSenders(
context.TODO(),
"comms_senderpool_01h9krwprkeee8fzqspvwy6nq8",
request,
)
}
```
```php
senderPools->listSenders(
'comms_senderpool_01h9krwprkeee8fzqspvwy6nq8',
new SenderPoolsListSendersRequest([
'channel' => SenderCommunicationChannel::Sms->value,
'status' => SenderStatus::Activated->value,
'startDate' => new DateTime('2024-01-15T09:30:00Z'),
'endDate' => new DateTime('2024-01-15T09:30:00Z'),
'pageToken' => 'pageToken',
'pageSize' => 50,
]),
);
```
```rb
require "twiliocomms"
client = TwilioComms::Client.new(
account_id: "TWILIO_ACCOUNT_SID",
auth_token: "TWILIO_AUTH_TOKEN"
)
client.sender_pools.list_senders(
sender_pool_id: "comms_senderpool_01h9krwprkeee8fzqspvwy6nq8",
channel: "SMS",
status: "ACTIVATED",
start_date: "2024-01-15T09:30:00Z",
end_date: "2024-01-15T09:30:00Z",
page_token: "pageToken",
page_size: 50
)
```
```bash
curl -X GET "https://comms.twilio.com/v1/SenderPools/comms_senderpool_01h9krwprkeee8fzqspvwy6nq8/Senders?channel=SMS&status=ACTIVATED&startDate=2024-01-15&endDate=2024-01-15&pageToken=pageToken&pageSize=50" \
-u $TWILIO_ACCOUNT_SID:$TWILIO_AUTH_TOKEN
```
## Remove a Sender from a SenderPool
`DELETE https://comms.twilio.com/v1/SenderPools/{senderPoolId}/Senders/{senderId}`
Remove a specific Sender from a SenderPool.
### Path parameters
```json
[{"schema":{"x-twilio-version":1,"description":"A reference to a SenderPool.","title":"SenderPoolId","type":"string","pattern":"^comms_senderpool_[0-7][a-hjkmnpqrstv-z0-9]{25,34}","example":"comms_senderpool_01h9krwprkeee8fzqspvwy6nq8","refName":"SenderPoolId","modelName":""},"name":"senderPoolId","in":"path","required":true,"x-twilio-version":1},{"schema":{"x-twilio-version":1,"description":"A reference to a Sender.","title":"SenderId","type":"string","pattern":"^comms_sender_[0-7][a-hjkmnpqrstv-z0-9]{25,34}","example":"comms_sender_01h9krwprkeee8fzqspvwy6nq8","refName":"SenderId","modelName":""},"name":"senderId","in":"path","required":true,"x-twilio-version":1}]
```
### Responses
Remove a Sender from a SenderPool
```ts
import { TwilioClient } from "twilio-comms";
async function main() {
const client = new TwilioClient({
accountId: "TWILIO_ACCOUNT_SID",
authToken: "TWILIO_AUTH_TOKEN",
});
await client.senderPools.removeSender("comms_senderpool_01h9krwprkeee8fzqspvwy6nq8", "comms_sender_01h9krwprkeee8fzqspvwy6nq8");
}
main();
```
```py
from twilio_comms import TwilioComms
client = TwilioComms(
account_id="TWILIO_ACCOUNT_SID",
auth_token="TWILIO_AUTH_TOKEN",
)
client.sender_pools.remove_sender(
sender_pool_id="comms_senderpool_01h9krwprkeee8fzqspvwy6nq8",
sender_id="comms_sender_01h9krwprkeee8fzqspvwy6nq8",
)
```
```cs
using Twilio.Comms;
using System.Threading.Tasks;
public partial class Examples
{
public async Task Example() {
var client = new TwilioComms(
accountId: "TWILIO_ACCOUNT_SID",
authToken: "TWILIO_AUTH_TOKEN"
);
await client.SenderPools.RemoveSenderAsync(
"comms_senderpool_01h9krwprkeee8fzqspvwy6nq8",
"comms_sender_01h9krwprkeee8fzqspvwy6nq8"
);
}
}
```
```java
package com.example.usage;
import com.twilio.sdk.TwilioComms;
public class Example {
public static void main(String[] args) {
TwilioComms client = TwilioComms
.builder()
.credentials("TWILIO_ACCOUNT_SID", "TWILIO_AUTH_TOKEN")
.build();
client.senderPools().removeSender("comms_senderpool_01h9krwprkeee8fzqspvwy6nq8", "comms_sender_01h9krwprkeee8fzqspvwy6nq8");
}
}
```
```go
package example
import (
context "context"
client "github.com/twilio/twilio-comms-go/twilio/client"
option "github.com/twilio/twilio-comms-go/twilio/option"
)
func do() {
client := client.NewWithOptions(
option.WithBasicAuth(
"TWILIO_ACCOUNT_SID",
"TWILIO_AUTH_TOKEN",
),
)
client.SenderPools.RemoveSender(
context.TODO(),
"comms_senderpool_01h9krwprkeee8fzqspvwy6nq8",
"comms_sender_01h9krwprkeee8fzqspvwy6nq8",
)
}
```
```php
senderPools->removeSender(
'comms_senderpool_01h9krwprkeee8fzqspvwy6nq8',
'comms_sender_01h9krwprkeee8fzqspvwy6nq8',
);
```
```rb
require "twiliocomms"
client = TwilioComms::Client.new(
account_id: "TWILIO_ACCOUNT_SID",
auth_token: "TWILIO_AUTH_TOKEN"
)
client.sender_pools.remove_sender(
sender_pool_id: "comms_senderpool_01h9krwprkeee8fzqspvwy6nq8",
sender_id: "comms_sender_01h9krwprkeee8fzqspvwy6nq8"
)
```
```bash
curl -X DELETE "https://comms.twilio.com/v1/SenderPools/comms_senderpool_01h9krwprkeee8fzqspvwy6nq8/Senders/comms_sender_01h9krwprkeee8fzqspvwy6nq8" \
-u $TWILIO_ACCOUNT_SID:$TWILIO_AUTH_TOKEN
```