Smart Assign (1.0.0)

API endpoints for managing default sender settings in a user's account. The Smart Assign Service API automatically selects a compliant SenderID for each country you send to, with an option to set your own default. It also lets you retrieve a list of compliant SenderIDs per country, providing transparency, control, and confidence in SMS delivery.

Create Default Sender

Creates a new default sender configuration to automate the selection of compliant SenderIDs. By configuring a default sender you no longer need to define the sender_id string when sending SMS messages. The default sender will be picked up automatically.

For more information on Sender IDs, please refer to What is a Sender ID or Sender Number?

Request
header Parameters
Content-Type
string
Example: application/json
Request Body schema: application/json
country_code
required
string

The country code of the recipient. Must be a valid ISO 3166-1 alpha-2 country code.

product_type
required
string

The type of product for the assignment. Support for additional types coming soon.

Value: "SMS"
required
Array of objects = 1 items

Array detailing sender strategies. Must contain exactly 1 element. Multiple strategies support coming soon.

Responses
200

Successful response

400

Successful response

post/v3/senders/default-senders
Request samples
application/json
{
  • "country_code": "AU",
  • "product_type": "SMS",
  • "default_sender_strategies": [
    ]
}
Response samples
application/json
{
  • "http_code": 200,
  • "response_code": "SUCCESS",
  • "response_msg": "Operation completed successfully",
  • "data": {
    }
}

Get List of Default Senders

Retrieve a list of default senders for the current user

Request
query Parameters
offset
string

Page (offset) to be used for pagination

per_page
integer [ 1 .. 500 ]
Default: 10

Size of the page in pagination

sort_by
string
Default: "created_timestamp"

Parameter to sort the results by

sort_direction
string
Default: "desc"

Direction of sorting

Enum: "asc" "desc"
header Parameters
Content-Type
string
Example: application/json
Responses
200

Successful response

get/v3/senders/default-senders
Request samples 
curl --include \
     --request GET \
     --header "Content-Type: application/json" \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA==" \
'https://rest.clicksend.com/v3/senders/default-senders?offset=f99872cc-11a6-48ba-a9f2-bcfb6dd1e3d4%238fa5ebc2-777b-45db-a448-ec76a40d4384&per_page=1&sort_by=created_timestamp&sort_direction=asc'
Response samples
application/json
{}

Update Default Sender

Updates the details of an existing default sender configuration.

For more information on Sender IDs, please refer to What is a Sender ID or Sender Number?

Request
path Parameters
default_sender_id
required
string

The ID of the default sender to update

header Parameters
Content-Type
string
Example: application/json
Request Body schema: application/json
required
Array of objects = 1 items

Array detailing sender strategies. Must contain exactly 1 element. Multiple strategies support coming soon.

Responses
200

Successful response

400

Bad request

patch/v3/senders/default-senders/{default_sender_id}
Request samples
application/json
{
  • "default_sender_strategies": [
    ]
}
Response samples
application/json
{
  • "http_code": 200,
  • "response_code": "SUCCESS",
  • "response_msg": "Operation completed successfully",
  • "data": {
    }
}

Get Default Sender Details

Retrieve detailed information about a specific default sender configuration

Request
path Parameters
default_sender_id
required
string

The ID of the default sender to retrieve

header Parameters
Content-Type
string
Example: application/json
Responses
200

Successful response

get/v3/senders/default-senders/{default_sender_id}
Request samples 
curl --include \
     --request GET \
     --header "Content-Type: application/json" \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA==" \
'https://rest.clicksend.com/v3/senders/default-senders/{default_sender_id}'
Response samples
application/json
{
  • "http_code": 200,
  • "response_code": "SUCCESS",
  • "response_msg": "Operation completed successfully",
  • "data": {
    }
}

Delete Default Sender

Removes a specified default sender setting. If you don't configure a default sender and leave the sender_id string blank when sending an SMS, Smart Assign will pick the best suitable, compliant, available SenderID for you.

Request
path Parameters
default_sender_id
required
string

The ID of the default sender to delete

header Parameters
Content-Type
string
Example: application/json
Responses
204

Successful response (No Content)

delete/v3/senders/default-senders/{default_sender_id}
Request samples 
curl --include \
     --request DELETE \
     --header "Content-Type: application/json" \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA==" \
'https://rest.clicksend.com/v3/senders/default-senders/{default_sender_id}'

List Compliant Sender Types

Retrieves the list of compliant sender types for specific countries

Request
query Parameters
filter[product_type]
required
string

Type of the product

Value: "SMS"
Example: filter[product_type]=SMS
filter[country_code][{index}]
Array of strings <= 98 items

Array of recipient country codes (ISO 3166-1 alpha-2). If not specified, will get all compliant sender types for all countries. Replace {index} with the appropriate index value.

Example: filter[country_code][0]=US&filter[country_code][1]=AU

Responses
200

Successful response

get/v3/senders/compliant-sender-types
Request samples 
curl --include \
     --request GET \
     --header "Content-Type: application/json" \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA==" \
'https://rest.clicksend.com/v3/senders/compliant-sender-types?filter[product_type]=SMS&filter[country_code][0]=AU&filter[country_code][1]=US'
Response samples
application/json
{
  • "http_code": 200,
  • "response_code": "SUCCESS",
  • "response_msg": "Compliant sender types retrieved successfully",
  • "data": {
    }
}
Copyright © ClickSend 2025. All right reserved.