Skip to contentSkip to navigationSkip to topbar
Twilio Docs
Page tools
On this page
Looking for more inspiration?Visit the

SenderPools resource

A SenderPool resource represents a group of senders that can be used together for messaging. Use SenderPools to organize and manage senders for different messaging use cases.

SenderPool Properties

senderpool-properties page anchor
Property nameTypeRequiredPIIDescriptionChild properties
idstring
required
Not PII

A reference to a SenderPool.

Example: comms_senderpool_01h9krwprkeee8fzqspvwy6nq8Pattern: ^comms_senderpool_[0-7][a-hjkmnpqrstv-z0-9]{25,34}
namestring
required
Not PII
tagsTags
required
Not PII

Custom metadata in the form of key-value pairs. Maximum size of a tag key is 128 characters. Maximum size of a tag value is 256 characters. There can be a maximum of 10 key-value pairs.

This field can be templated with Liquid(link takes you to an external page). Specify variables with each recipient for personalization.

Max properties: 10
createdAtstring<date-time>
required
Not PII
updatedAtstring<date-time>
required
Not PII

Create a SenderPool

create-a-senderpool page anchor

POST https://comms.twilio.com/v1/SenderPools

Create a new SenderPool.

Request body parameters

request-body-parameters page anchor
Encoding type:application/json
SchemaExample
Property nameTypeRequiredPIIDescriptionChild properties
namestring

Optional

Not PII

The friendly name of the SenderPool.

sendersarray[CreateSenderPoolRequestSender]

Optional

Not PII

The list of Senders to add to the SenderPool.

Min items: 0Max items: 10000
tagsTags

Optional

Not PII

Custom metadata in the form of key-value pairs. Maximum size of a tag key is 128 characters. Maximum size of a tag value is 256 characters. There can be a maximum of 10 key-value pairs.

This field can be templated with Liquid(link takes you to an external page). Specify variables with each recipient for personalization.

Max properties: 10

Responses

responses page anchor
202400409429500503

The request was accepted and an Operation was created to track its progress. The response body contains the ID and link to the Operation resource.

SchemaExample
Property nameTypeRequiredDescriptionChild properties
operationIdstring

Optional

The Operation ID is an identifier that can be used to correlate all of the resources created in a request.

Issue a GET request to the resource list location, using the Operation ID as a query parameter to retrieve the resources that correlate with the Operation.

Example: comms_operation_01h9krwprkeee8fzqspvwy6nq8Pattern: ^comms_operation_[0-7][a-hjkmnpqrstv-z0-9]{25,34}
operationLocationstring<uri>

Optional

The location (uri) of the Operation resource identified by operationId.

Create a SenderPoolLink to code sample: Create a SenderPool
1
import { TwilioClient } from "twilio-comms";

2


3
async function main() {

4
    const client = new TwilioClient({

5
        accountId: "TWILIO_ACCOUNT_SID",

6
        authToken: "TWILIO_AUTH_TOKEN",

7
    });

8
    await client.senderPools.create({

9
        name: "Sales Leads - APAC",

10
        tags: {

11
            "region": "APAC",

12
        },

13
    });

14
}

15
main();

Fetch a SenderPool

fetch-a-senderpool page anchor

GET https://comms.twilio.com/v1/SenderPools/{senderPoolId}

Retrieve a SenderPool by its ID.

Path parameters

path-parameters page anchor
Property nameTypeRequiredPIIDescription
senderPoolIdstring
required
Not PII
Example: comms_senderpool_01h9krwprkeee8fzqspvwy6nq8Pattern: ^comms_senderpool_[0-7][a-hjkmnpqrstv-z0-9]{25,34}

Responses

responses-1 page anchor
200400404409429500503

OK

SchemaExample
Property nameTypeRequiredDescriptionChild properties
idstring

Optional

A reference to a SenderPool.

Example: comms_senderpool_01h9krwprkeee8fzqspvwy6nq8Pattern: ^comms_senderpool_[0-7][a-hjkmnpqrstv-z0-9]{25,34}
namestring

Optional

tagsTags

Optional

Custom metadata in the form of key-value pairs. Maximum size of a tag key is 128 characters. Maximum size of a tag value is 256 characters. There can be a maximum of 10 key-value pairs.

This field can be templated with Liquid(link takes you to an external page). Specify variables with each recipient for personalization.

Max properties: 10
createdAtstring<date-time>

Optional

updatedAtstring<date-time>

Optional

Fetch a SenderPoolLink to code sample: Fetch a SenderPool
1
import { TwilioClient } from "twilio-comms";

2


3
async function main() {

4
    const client = new TwilioClient({

5
        accountId: "TWILIO_ACCOUNT_SID",

6
        authToken: "TWILIO_AUTH_TOKEN",

7
    });

8
    await client.senderPools.fetch("comms_senderpool_01h9krwprkeee8fzqspvwy6nq8");

9
}

10
main();

List SenderPools

list-senderpools page anchor

GET https://comms.twilio.com/v1/SenderPools

Retrieve a list of all SenderPools.

Query parameters

query-parameters page anchor
Property nameTypeRequiredPIIDescription
startDatestring<date-time>

Optional

Not PII

Filter to SenderPools created after the specified date and time in ISO 8601 format.

endDatestring<date-time>

Optional

Not PII

Filter to SenderPools created before the specified date and time in ISO 8601 format.

operationIdstring

Optional

Not PII

Filter to SenderPools by SenderPool Operation ID.

Example: comms_operation_01h9krwprkeee8fzqspvwy6nq8Pattern: ^comms_operation_[0-7][a-hjkmnpqrstv-z0-9]{25,34}
pageTokenstring

Optional

Not PII

A page token that represents the start SenderPool of a page

pageSizeinteger

Optional

Not PII
Default: 50Example: 50Minimum: 1Maximum: 1000

Responses

responses-2 page anchor
200400409429500503

OK

Schema
Property nameTypeRequiredDescriptionChild properties
senderPoolsarray[SenderPool]

Optional

A list of SenderPools.

paginationPaginationMetadata

Optional

Metadata for paginated results. This object contains two tokens to navigate through paginated results.

  • Use next to retrieve the 'next' page in the result list.
  • Use self to retrieve the same page of the result list again.
  • Supply the token in the pageToken query param.
List SenderPoolsLink to code sample: List SenderPools
1
import { TwilioClient } from "twilio-comms";

2


3
async function main() {

4
    const client = new TwilioClient({

5
        accountId: "TWILIO_ACCOUNT_SID",

6
        authToken: "TWILIO_AUTH_TOKEN",

7
    });

8
    await client.senderPools.list({

9
        startDate: new Date("2024-01-15T09:30:00Z"),

10
        endDate: new Date("2024-01-15T09:30:00Z"),

11
        operationId: "comms_operation_01h9krwprkeee8fzqspvwy6nq8",

12
        pageToken: "pageToken",

13
        pageSize: 50,

14
    });

15
}

16
main();

Update a SenderPool

update-a-senderpool page anchor

PATCH https://comms.twilio.com/v1/SenderPools/{senderPoolId}

Update an existing SenderPool.

Path parameters

path-parameters-1 page anchor
Property nameTypeRequiredPIIDescription
senderPoolIdstring
required
Not PII
Example: comms_senderpool_01h9krwprkeee8fzqspvwy6nq8Pattern: ^comms_senderpool_[0-7][a-hjkmnpqrstv-z0-9]{25,34}

Request body parameters

request-body-parameters-1 page anchor
Encoding type:application/json
SchemaExample
Property nameTypeRequiredPIIDescriptionChild properties
namestring

Optional

Not PII

The friendly name of the SenderPool

tagsTags

Optional

Not PII

Custom metadata in the form of key-value pairs. Maximum size of a tag key is 128 characters. Maximum size of a tag value is 256 characters. There can be a maximum of 10 key-value pairs.

This field can be templated with Liquid(link takes you to an external page). Specify variables with each recipient for personalization.

Max properties: 10

Responses

responses-3 page anchor
202400404409429500503

The request was accepted and a resource ID is available to check the result. The response body contains the resource ID and link to the resource.

SchemaExample
Property nameTypeRequiredDescriptionChild properties
resourceIdstring

Optional

The Resource ID is an identifier for the resource that was created or updated in response to the request.

resourceLocationstring<uri>

Optional

The location (uri) of the resource identified by Resource-Id.

Update a SenderPoolLink to code sample: Update a SenderPool
1
import { TwilioClient } from "twilio-comms";

2


3
async function main() {

4
    const client = new TwilioClient({

5
        accountId: "TWILIO_ACCOUNT_SID",

6
        authToken: "TWILIO_AUTH_TOKEN",

7
    });

8
    await client.senderPools.update("comms_senderpool_01h9krwprkeee8fzqspvwy6nq8", {

9
        name: "Customer Support Senders - Tier 1",

10
        tags: {

11
            "tier": "1",

12
        },

13
    });

14
}

15
main();

Delete a SenderPool

delete-a-senderpool page anchor

DELETE https://comms.twilio.com/v1/SenderPools/{senderPoolId}

Delete a SenderPool by its ID.

Path parameters

path-parameters-2 page anchor
Property nameTypeRequiredPIIDescription
senderPoolIdstring
required
Not PII
Example: comms_senderpool_01h9krwprkeee8fzqspvwy6nq8Pattern: ^comms_senderpool_[0-7][a-hjkmnpqrstv-z0-9]{25,34}

Responses

responses-4 page anchor
202400404409429500503

The request was accepted and a resource ID is available to check the result. The response body contains the resource ID and link to the resource.

SchemaExample
Property nameTypeRequiredDescriptionChild properties
resourceIdstring

Optional

The Resource ID is an identifier for the resource that was created or updated in response to the request.

resourceLocationstring<uri>

Optional

The location (uri) of the resource identified by Resource-Id.

Delete a SenderPoolLink to code sample: Delete a SenderPool
1
import { TwilioClient } from "twilio-comms";

2


3
async function main() {

4
    const client = new TwilioClient({

5
        accountId: "TWILIO_ACCOUNT_SID",

6
        authToken: "TWILIO_AUTH_TOKEN",

7
    });

8
    await client.senderPools.delete("comms_senderpool_01h9krwprkeee8fzqspvwy6nq8");

9
}

10
main();