COcommpeak
Senders

Add sender

Changed on

Create a new alphanumeric sender ID. Both name and value are required. New senders start as WAITING_APPROVE and must be approved before use.

Rejected values. A value that already exists, or that is not 3 to 16 characters long, is returned with HTTP 200 and a { "code", "message" } body instead of the sender; check for id in the response.

Authentication: TextPeak API key in the Authorization header (see Authentication in the API Overview).

post/senders

Request

  • Base URL
    https://api.commpeak.com/textpeak
  • URL
    https://api.commpeak.com/textpeak/senders
  • Auth
    API key in header Authorization

Request body

namestring required

Sender display name.

valuestring required

The alphanumeric sender ID. 3 to 16 characters after -, spaces and + are removed. Created as ALPHANUMERIC with status WAITING_APPROVE and dailyLimit 0.

Example request

{
  "name": "CommPeak",
  "value": "CommPeak"
}

Response

The sender was not created: the value already exists, or is not 3 to 16 characters long.

codeinteger required

1 the value already exists on your account; 2 the value is not 3 to 16 characters long.

messagestring required

Human-readable reason.

Example response

{
  "code": 1,
  "message": "Sender already exist"
}

Changes

  • 5012671cf95dRevision changes
    • breaking

      response property stream list-of-types was widened by adding types null to media type application/json of response 201

    • warning

      the request property's maxLength was set to 255

    • warning

      added the new EMAIL enum value to the response property for the response status

    • warning

      added the new UNKNOWN enum value to the response property for the response status

    • warning

      added the new UNKNOWN enum value to the response property for the response status

    • info

      api operation id addSender removed and replaced with create_sender

    • info

      the endpoint scheme security APIKeyHeader was added to the API

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      added the success response with the status