Custom Fields

• Create Custom Field POST /custom-fields

• Get Custom Field GET /custom-fields/{customFieldId}

• Update Custom Field PATCH /custom-fields/{customFieldId}

• Delete Custom Field DELETE /custom-fields/{customFieldId}

• List Custom Fields GET /custom-fields

• Bulk Create Custom Fields POST /custom-fields/bulk-create

Create Custom Field

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

namestringRequired

typestring · enumOptionalPossible values:

hiddenbooleanOptional

optionsstring[]Optional

formatstring · enumOptionalPossible values:

Responses

200

Success

application/json

400

BadRequestError

application/json

401

UnauthorizedError

application/json

403

ForbiddenError

application/json

500

InternalServerError

application/json

post

/custom-fields

HTTPcURLJavaScriptPython

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": "2026-01-12T22:21:53.278Z"
  }
}

Get Custom Field

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

customFieldIdstringRequired

Responses

200

Success

application/json

400

BadRequestError

application/json

401

UnauthorizedError

application/json

403

ForbiddenError

application/json

500

InternalServerError

application/json

get

/custom-fields/{customFieldId}

HTTPcURLJavaScriptPython

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": "2026-01-12T22:21:53.278Z"
  }
}

Update Custom Field

patch

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

customFieldIdstringRequired

Body

application/json

namestringOptional

typestring · enumOptionalPossible values:

optionsstring[]Optional

formatstring · enumOptionalPossible values:

Responses

200

Success

application/json

400

BadRequestError

application/json

401

UnauthorizedError

application/json

403

ForbiddenError

application/json

500

InternalServerError

application/json

patch

/custom-fields/{customFieldId}

HTTPcURLJavaScriptPython

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": "2026-01-12T22:21:53.278Z"
  }
}

Delete Custom Field

delete

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

customFieldIdstringRequired

Responses

200

Success

application/json

400

BadRequestError

application/json

401

UnauthorizedError

application/json

403

ForbiddenError

application/json

500

InternalServerError

application/json

delete

/custom-fields/{customFieldId}

HTTPcURLJavaScriptPython

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

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

Responses

200

Success

application/json

400

BadRequestError

application/json

401

UnauthorizedError

application/json

403

ForbiddenError

application/json

429

RateLimitError

application/json

500

InternalServerError

application/json

get

/custom-fields

HTTPcURLJavaScriptPython

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": "2026-01-12T22:21:53.278Z"
      }
    ],
    "page": 1,
    "pageSize": 1,
    "total": 1
  }
}

Bulk Create Custom Fields

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Success

application/json

400

BadRequestError

application/json

401

UnauthorizedError

application/json

403

ForbiddenError

application/json

500

InternalServerError

application/json

post

/custom-fields/bulk-create

HTTPcURLJavaScriptPython

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
}