Create Free API Account

Custom Fields

Create Custom Field

post
Authorizations
Body
namestringRequired
typestring · enumOptionalPossible values:
hiddenbooleanOptional
optionsstring[]Optional
formatstring · enumOptionalPossible values:
Responses
200

Success

application/json
Responseall of
post
POST /v3/custom-fields HTTP/1.1
Host: api.mobile-text-alerts.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 87

{
  "name": "text",
  "type": "string",
  "hidden": true,
  "options": [
    "text"
  ],
  "format": "MMM D, YYYY"
}
{
  "success": true,
  "error": "text",
  "message": "text",
  "data": {
    "id": 1,
    "name": "text",
    "type": null,
    "hidden": true,
    "options": [
      "text"
    ],
    "format": null,
    "created": "2025-10-13T15:43:03.594Z"
  }
}

Get Custom Field

get
Authorizations
Path parameters
customFieldIdstringRequired
Responses
200

Success

application/json
Responseall of
get
GET /v3/custom-fields/{customFieldId} HTTP/1.1
Host: api.mobile-text-alerts.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "error": "text",
  "message": "text",
  "data": {
    "id": 1,
    "name": "text",
    "type": null,
    "hidden": true,
    "options": [
      "text"
    ],
    "format": null,
    "created": "2025-10-13T15:43:03.594Z"
  }
}

Update Custom Field

patch
Authorizations
Path parameters
customFieldIdstringRequired
Body
namestringOptional
typestring · enumOptionalPossible values:
optionsstring[]Optional
formatstring · enumOptionalPossible values:
Responses
200

Success

application/json
Responseall of
patch
PATCH /v3/custom-fields/{customFieldId} HTTP/1.1
Host: api.mobile-text-alerts.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 73

{
  "name": "text",
  "type": "string",
  "options": [
    "text"
  ],
  "format": "MMM D, YYYY"
}
{
  "success": true,
  "error": "text",
  "message": "text",
  "data": {
    "id": 1,
    "name": "text",
    "type": null,
    "hidden": true,
    "options": [
      "text"
    ],
    "format": null,
    "created": "2025-10-13T15:43:03.594Z"
  }
}

Delete Custom Field

delete
Authorizations
Path parameters
customFieldIdstringRequired
Responses
200

Success

application/json
delete
DELETE /v3/custom-fields/{customFieldId} HTTP/1.1
Host: api.mobile-text-alerts.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "error": "text",
  "message": "text",
  "data": null
}

List Custom Fields

get

Rate Limiting

This endpoint overrides the general rate limit with an account rate limit. Requests are limited by the authenticated account instead of the IP address. This endpoint is limited to 15 requests every 15 seconds

Authorizations
Query parameters
Responses
200

Success

application/json
Responseall of
get
GET /v3/custom-fields HTTP/1.1
Host: api.mobile-text-alerts.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "error": "text",
  "message": "text",
  "data": {
    "rows": [
      {
        "id": 1,
        "name": "text",
        "type": null,
        "hidden": true,
        "options": [
          "text"
        ],
        "format": null,
        "created": "2025-10-13T15:43:03.594Z"
      }
    ],
    "page": 1,
    "pageSize": 1,
    "total": 1
  }
}

Bulk Create Custom Fields

post
Authorizations
Body
Responses
200

Success

application/json
post
POST /v3/custom-fields/bulk-create HTTP/1.1
Host: api.mobile-text-alerts.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 106

{
  "customFields": [
    {
      "name": "text",
      "type": "string",
      "hidden": true,
      "options": [
        "text"
      ],
      "format": "MMM D, YYYY"
    }
  ]
}
{
  "success": true,
  "error": "text",
  "message": "text",
  "data": null
}
PreviousControlled TemplatesNextDedicated Numbers

Last updated

Was this helpful?