Messaging
/
Sender IDs
/
Alpha Tags

Alpha Tags

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

Download OpenAPI description
alpha-tags.json
alpha-tags.yaml
Languages
Servers

https://rest.clicksend.com/

Request Alpha Tag

Request

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

Properties

NameTypeRequiredRestrictionsDescription
alpha_tagstringtrueyesThe 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.
reasonstringfalsenoneMust 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...

Headers
Content-Typestring
Example: application/json
Bodyapplication/json
alpha_tagstring
Example: "Abc123+"
reasonstring
Example: "Sole Trader Name"
curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \
     --request POST \
     --header "Content-Type: application/json" \
     --data-binary "    {
        \"alpha_tag\": \"Abc123+\",
        \"reason\": \"Sole Trader Name\"
    }" \
'https://rest.clicksend.com/v3/alpha-tags'

Responses

Successful response

Bodyapplication/json
idstring

The unique identifier for the record.

Example: "db630385-cb76-457d-8f16-76df1b394257"
account_idstring

The unique identifier for the account.

Example: "85edb794-ee6d-4a38-9f63-c5fa8acf0d79"
workspace_idstring

The unique identifier for the workspace.

Example: "85edb794-ee6d-4a38-9f63-c5fa8acf0d79"
user_idstring

The unique identifier for the user.

Example: "85edb794-ee6d-4a38-9f63-c5fa8acf0d79"
alpha_tagstring

The alpha tag.

Example: "Abc123"
statusstring

The status of the record.

Example: "PENDING"
reasonstring

The reason for the status.

Example: "Sole Trader Name"
created_timestampstring(date-time)

The timestamp when the record was created.

Example: "2021-05-11T01:00:00.123Z"
updated_timestampstring(date-time)

The timestamp when the record was last updated.

Example: "2021-05-11T01:05:00.123Z"
Response
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

Request

curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \
'https://rest.clicksend.com/v3/alpha-tags'

Responses

Successful response

Bodyapplication/json
alpha_tagsArray of objects(alpha_tag)

The list of alpha tags.

_metadataobject

The metadata.

Response
application/json
{
  "alpha_tags": [
    { … }
  ],
  "_metadata": {
    "pagination": { … }
  }
}

Get Alpha Tag

Request

Get a specific alpha tag.

Parameters

ParameterInTypeRequiredDescription
alpha_tag_idpathuuidtrueID of the alpha tag

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

This endpoint requires authentication, more info...

Path
alpha_tag_idstringrequired
Headers
Content-Typestring
Example: application/json
curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \
'https://rest.clicksend.com/v3/alpha-tags/db630385-cb76-457d-8f16-76df1b394257'

Responses

Successful response

Bodyapplication/json
idstring

The unique identifier for the record.

Example: "db630385-cb76-457d-8f16-76df1b394257"
account_idstring

The unique identifier for the account.

Example: "85edb794-ee6d-4a38-9f63-c5fa8acf0d79"
workspace_idstring

The unique identifier for the workspace.

Example: "85edb794-ee6d-4a38-9f63-c5fa8acf0d79"
user_idstring

The unique identifier for the user.

Example: "85edb794-ee6d-4a38-9f63-c5fa8acf0d79"
alpha_tagstring

The alpha tag.

Example: "Abc123"
statusstring

The status of the record.

Example: "PENDING"
reasonstring

The reason for the status.

Example: "Sole Trader Name"
created_timestampstring(date-time)

The timestamp when the record was created.

Example: "2021-05-11T01:00:00.123Z"
updated_timestampstring(date-time)

The timestamp when the record was last updated.

Example: "2021-05-11T01:05:00.123Z"
Response
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

Request

Delete a specific alpha tag.

Parameters

ParameterInTypeRequiredDescription
alpha_tag_idpathuuidtrueID of the alpha tag

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

This endpoint requires authentication, more info...

Path
alpha_tag_idstringrequired
Headers
Content-Typestring
Example: application/json
curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \
     --request DELETE \
'https://rest.clicksend.com/v3/alpha-tags/db630385-cb76-457d-8f16-76df1b394257'

Responses

Successful response

Bodyapplication/json
Response
application/json
null