Alpha Tags (1.0.0)

API endpoints for managing alpha tags as sender IDs for messaging services.

Request Alpha Tag

Request to register an alpha tag. After requested, the alpha tag will be reviewed by ClickSend and either approved or rejected.

Properties

Name Type Required Restrictions Description
alpha_tag string true yes The alpha tag name. Length must be between 3 - 11 characters, can only contain a-z A-Z 0-9 + and must contain at least one non numeric.
reason string false none Must be one of the following: Sole Trader Name, Company Name, Partnership Name, Registered Trust Name, Co-Operative Name, Indigenous Corporation Name, Registered Organisation Name, Personal Name, Trademark, Government Agency or Entity, Product or Service Name, Acronym/Initialism, Contraction of Name, Third Party. In case of Third Party, we will contact you to collect the relevant information.

Refer to Status Codes for definitions of HTTP status code responses.

 This endpoint requires authentication, more info...

Request
header Parameters
Content-Type
string
Example: application/json
Request Body schema: application/json
object
Responses
200

Successful response

post/v3/alpha-tags
Request samples
application/json
{
  • "alpha_tag": "Abc123+",
  • "reason": "Sole Trader Name"
}
Response samples
application/json
{
  • "id": "db630385-cb76-457d-8f16-76df1b394257",
  • "account_id": "85edb794-ee6d-4a38-9f63-c5fa8acf0d79",
  • "workspace_id": "85edb794-ee6d-4a38-9f63-c5fa8acf0d79",
  • "user_id": "85edb794-ee6d-4a38-9f63-c5fa8acf0d79",
  • "alpha_tag": "Abc123",
  • "status": "PENDING",
  • "reason": "Sole Trader Name",
  • "created_timestamp": "2021-05-11T01:00:00.123Z",
  • "updated_timestamp": "2021-05-11T01:05:00.123Z"
}

List Alpha Tags

Responses
200

Successful response

get/v3/alpha-tags
Request samples 
curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \
'https://rest.clicksend.com/v3/alpha-tags'
Response samples
application/json
{}

Get Alpha Tag

Get a specific alpha tag.

Parameters

Parameter In Type Required Description
alpha_tag_id path uuid true ID of the alpha tag

Refer to Status Codes for definitions of HTTP status code responses.

 This endpoint requires authentication, more info...

Request
path Parameters
alpha_tag_id
required
string
header Parameters
Content-Type
string
Example: application/json
Responses
200

Successful response

get/v3/alpha-tags/{alpha_tag_id}
Request samples 
curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \
'https://rest.clicksend.com/v3/alpha-tags/db630385-cb76-457d-8f16-76df1b394257'
Response samples
application/json
{
  • "id": "db630385-cb76-457d-8f16-76df1b394257",
  • "account_id": "85edb794-ee6d-4a38-9f63-c5fa8acf0d79",
  • "workspace_id": "85edb794-ee6d-4a38-9f63-c5fa8acf0d79",
  • "user_id": "85edb794-ee6d-4a38-9f63-c5fa8acf0d79",
  • "alpha_tag": "Abc123",
  • "status": "PENDING",
  • "reason": "Sole Trader Name",
  • "created_timestamp": "2021-05-11T01:00:00.123Z",
  • "updated_timestamp": "2021-05-11T01:05:00.123Z"
}

Delete Alpha Tag

Delete a specific alpha tag.

Parameters

Parameter In Type Required Description
alpha_tag_id path uuid true ID of the alpha tag

Refer to Status Codes for definitions of HTTP status code responses.

This endpoint requires authentication, more info...

Request
path Parameters
alpha_tag_id
required
string
header Parameters
Content-Type
string
Example: application/json
Responses
200

Successful response

delete/v3/alpha-tags/{alpha_tag_id}
Request samples 
curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \
     --request DELETE \
'https://rest.clicksend.com/v3/alpha-tags/db630385-cb76-457d-8f16-76df1b394257'
Copyright © ClickSend 2024. All right reserved.