sms

Embed

<a href="https://hermeticor.com/docs/ref-sms"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/9005a6e7-ead4-47c5-8f24-45fd392fda3a/social-card.svg?v=3e7ae33eec8b" alt="sms" width="600" height="315"></a>

PATCHhttps://hermeticor.com/v1/sms/registrations/{id}

Parameters

idstringpathrequired

Request body

application/json

payloadobjectrequired

{
  "payload": {}
}

Code samples

cURL

curl -X PATCH "https://hermeticor.com/v1/sms/registrations/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"payload":{}}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "id": "string",
  "kind": "tendlc_brand",
  "connectionId": "string",
  "status": "draft",
  "parentId": "string",
  "externalId": "string",
  "payload": {},
  "errorCode": "string",
  "errorMessage": "string",
  "guidance": "string",
  "submittedAt": "2024-01-01T00:00:00Z",
  "lastPolledAt": "2024-01-01T00:00:00Z",
  "history": [
    {
      "at": "string",
      "status": "draft",
      "note": "string",
      "errorCode": "string"
    }
  ],
  "createdAt": "2024-01-01T00:00:00Z"
}

Schema

idstringrequired

kindstringrequired

tendlc_brand | tendlc_campaign | toll_free | short_code

connectionIdstringrequired

statusstringrequired

parentIdstringrequired

externalIdstringrequired

payloadobjectrequired

errorCodestringrequired

errorMessagestringrequired

guidancestringrequired

submittedAtstringrequired

lastPolledAtstringrequired

historyHistoryItem2[]required

Show child parameters

atstringrequired

statusstringrequired

notestring

errorCodestring

createdAtstringrequired

4XX Default Response

Example

{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}

Schema

errorobjectrequired

Show child parameters

codestringrequired

messagestringrequired

detailsobject

5XX Default Response

Same as 4XX · PATCH /v1/sms/registrations/{id}

POSThttps://hermeticor.com/v1/sms/registrations/{id}/submit

Parameters

idstringpathrequired

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/sms/registrations/{id}/submit" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · PATCH /v1/sms/registrations/{id}

4XX Default Response

Same as 4XX · PATCH /v1/sms/registrations/{id}

5XX Default Response

Same as 4XX · PATCH /v1/sms/registrations/{id}

POSThttps://hermeticor.com/v1/sms/registrations/{id}/poll

Parameters

idstringpathrequired

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/sms/registrations/{id}/poll" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · PATCH /v1/sms/registrations/{id}

4XX Default Response

Same as 4XX · PATCH /v1/sms/registrations/{id}

5XX Default Response

Same as 4XX · PATCH /v1/sms/registrations/{id}

POSThttps://hermeticor.com/v1/sms/registrations/{id}/reopen

Parameters

idstringpathrequired

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/sms/registrations/{id}/reopen" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · PATCH /v1/sms/registrations/{id}

4XX Default Response

Same as 4XX · PATCH /v1/sms/registrations/{id}

5XX Default Response

Same as 4XX · PATCH /v1/sms/registrations/{id}

POSThttps://hermeticor.com/v1/sms/registrations/{id}/status

Parameters

idstringpathrequired

Request body

application/json

statusstringrequired

in_review | approved | rejected

notestring

{
  "status": "in_review",
  "note": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/sms/registrations/{id}/status" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"status":"in_review","note":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · PATCH /v1/sms/registrations/{id}

4XX Default Response

Same as 4XX · PATCH /v1/sms/registrations/{id}

5XX Default Response

Same as 4XX · PATCH /v1/sms/registrations/{id}

GEThttps://hermeticor.com/v1/sms/senders

Parameters

limitintegerquery

= 50

cursorstringquery

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/sms/senders" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "connectionId": "string",
      "value": "string",
      "type": "long_code",
      "registrationId": "string",
      "registrationStatus": "string",
      "throughputPerSec": 0,
      "dailyCap": 0,
      "canSend": true
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem121[]required

Show child parameters

idstringrequired

connectionIdstringrequired

valuestringrequired

typestringrequired

long_code | toll_free | short_code | alphanumeric

registrationIdstringrequired

registrationStatusstringrequired

throughputPerSecintegerrequired

dailyCapintegerrequired

canSendbooleanrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · PATCH /v1/sms/registrations/{id}

5XX Default Response

Same as 4XX · PATCH /v1/sms/registrations/{id}

POSThttps://hermeticor.com/v1/sms/senders

Request body

application/json

connectionIdstringrequired

valuestringrequired

typestringrequired

long_code | toll_free | short_code | alphanumeric

registrationIdstring

throughputPerSecinteger

dailyCapinteger

{
  "connectionId": "string",
  "value": "string",
  "type": "long_code",
  "registrationId": "string",
  "throughputPerSec": 0,
  "dailyCap": 0
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/sms/senders" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"connectionId":"string","value":"string","type":"long_code","registrationId":"string","throughputPerSec":0,"dailyCap":0}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "connectionId": "string",
  "value": "string",
  "type": "long_code",
  "registrationId": "string",
  "registrationStatus": "string",
  "throughputPerSec": 0,
  "dailyCap": 0,
  "canSend": true
}

Schema

idstringrequired

connectionIdstringrequired

valuestringrequired

typestringrequired

long_code | toll_free | short_code | alphanumeric

registrationIdstringrequired

registrationStatusstringrequired

throughputPerSecintegerrequired

dailyCapintegerrequired

canSendbooleanrequired

4XX Default Response

Same as 4XX · PATCH /v1/sms/registrations/{id}

5XX Default Response

Same as 4XX · PATCH /v1/sms/registrations/{id}

GEThttps://hermeticor.com/v1/sms/senders/{id}

Parameters

idstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/sms/senders/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/sms/senders

4XX Default Response

Same as 4XX · PATCH /v1/sms/registrations/{id}

5XX Default Response

Same as 4XX · PATCH /v1/sms/registrations/{id}

DELETEhttps://hermeticor.com/v1/sms/senders/{id}

Parameters

idstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/sms/senders/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "ok": true
}

Schema

okbooleanrequired

true

4XX Default Response

Same as 4XX · PATCH /v1/sms/registrations/{id}

5XX Default Response

Same as 4XX · PATCH /v1/sms/registrations/{id}

Next part

Updated Nov 8, 2026

Was this page helpful?