# Custom Subscriber Attributes

Subscriber data is stored with predefined subscriber attributes such as First Name, Last Name, Email, etc. You can create your own fields to store any additional types of data for your subscribers. These Custom Subscriber Attributes can help you organize subscribers to create send lists, build groups, and more.

You can add/update/delete your account's Custom Subscriber Attributes in the [platform dashboard](https://platform.mobile-text-alerts.com/subscribers/attributes) or with the [Mobile Text Alerts API Custom Fields endpoints](https://developers.mobile-text-alerts.com/api-reference/custom-fields).

The image below shows how custom attributes appear in the platform dashboard. See [#manage-custom-subscriber-attributes-in-the-dashboard](https://developers.mobile-text-alerts.com/manage-subscribers/assign-custom-subscriber-attributes#manage-custom-subscriber-attributes-in-the-dashboard "mention") to learn more.

<figure><img src="https://879775583-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FM0P3gHFFZE4c6PMaPvHm%2Fuploads%2FAEyxLl5F3dOH3uQanmGD%2FPlatformManageAttributes.png?alt=media&#x26;token=5154404a-4253-4b7b-aefa-755cb3d26df9" alt=""><figcaption></figcaption></figure>

## Manage Custom Subscriber Attributes with the API

In the Mobile Text Alerts API, all endpoints for Custom Subscriber Attributes are located under `/custom-fields`. Custom Fields is the previous name for what is now called Custom Subscriber Attributes.

**Available API actions:**

* [#create-a-new-custom-subscriber-attribute](#create-a-new-custom-subscriber-attribute "mention")
* [#list-all-custom-subscriber-attributes](#list-all-custom-subscriber-attributes "mention")
* [#update-a-custom-subscriber-attribute](#update-a-custom-subscriber-attribute "mention")
* [#delete-a-custom-subscriber-attribute](#delete-a-custom-subscriber-attribute "mention")
* [#get-a-custom-subscriber-attribute](#get-a-custom-subscriber-attribute "mention")

### Create a new Custom Subscriber Attribute

A new Custom Subscriber Attribute can be created for your account by calling the [#post-custom-fields](https://developers.mobile-text-alerts.com/api-reference/custom-fields#post-custom-fields "mention") endpoint.

**Request Body**

<table><thead><tr><th width="142">Name</th><th width="129.5">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>name</code> </td><td><code>string</code></td><td>The name of the attribute.</td></tr><tr><td><code>type</code></td><td><code>string enum</code></td><td><p>The data type of the attribute, one of the following:</p><ul><li><code>string</code> </li><li><code>number</code></li><li><code>date</code> (the date format must be specified in the <code>format</code> field)</li><li><code>boolean</code> (used for check boxes)</li><li><code>select</code> (you will need to list the options in the <code>options[]</code> field)</li><li><code>address</code></li><li><code>multi-select</code> (you will need to list the options in the <code>options[]</code> field)</li></ul></td></tr><tr><td><code>options[]</code></td><td><code>string[]</code></td><td>For <code>select</code> or <code>multi-select</code> , the list of possible <code>string</code> values are listed here.</td></tr><tr><td><code>format</code></td><td><code>string enum</code></td><td><p>Determines the format of the <code>date</code> .</p><p>One of the following:</p><p><code>Month D, YYYY</code> , <code>MM/DD/YYYY</code>, <code>DD/MM/YYYY</code></p></td></tr></tbody></table>

### List all Custom Subscriber Attributes

See all Custom Subscriber Attributes that have been created on your account by calling the [#get-custom-fields](https://developers.mobile-text-alerts.com/api-reference/custom-fields#get-custom-fields "mention") endpoint.

{% hint style="info" %}
This endpoint returns an `id` field for each attribute. Use it as the `customFieldId` in other requests to `/custom-fields` endpoints.
{% endhint %}

**Rate Limit**

This endpoint overrides the [general rate limit](https://developers.mobile-text-alerts.com/api-basics/rate-limits#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 per `15` seconds.

#### **Example Request**

```bash
curl --location 'https://api.mobile-text-alerts.com/v3/custom-fields' \
  --header 'Authorization: Bearer <APIKey>'
```

### Update a Custom Subscriber Attribute

You can make changes to existing Custom Subscriber Attributes that have been created on your account by calling the [#patch-custom-fields-customfieldid](https://developers.mobile-text-alerts.com/api-reference/custom-fields#patch-custom-fields-customfieldid "mention") endpoint with the identifying `{customFieldId}` of the attribute to be updated as a path parameter.

**Request Body**

<table><thead><tr><th width="142">Name</th><th width="129.5">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>name</code> </td><td><code>string</code></td><td>The name of the attribute.</td></tr><tr><td><code>type</code></td><td><code>string enum</code></td><td><p>The data type of the attribute, one of the following:</p><ul><li><code>string</code> </li><li><code>number</code></li><li><code>date</code> (the date format must be specified in the <code>format</code> field)</li><li><code>boolean</code> (used for check boxes)</li><li><code>select</code> (you will need to list the options in the <code>options[]</code> field)</li><li><code>address</code></li><li><code>multi-select</code> (you will need to list the options in the <code>options[]</code> field)</li></ul></td></tr><tr><td><code>options[]</code></td><td><code>string[]</code></td><td>For <code>select</code> or <code>multi-select</code> , the list of possible <code>string</code> values are listed here.</td></tr><tr><td><code>format</code></td><td><code>string enum</code></td><td><p>Determines the format of the <code>date</code> .</p><p>One of the following:</p><p><code>Month D, YYYY</code> , <code>MM/DD/YYYY</code>, <code>DD/MM/YYYY</code></p></td></tr></tbody></table>

#### Example Request

In the below example, update `customFieldId`: `7769` with a new name.

```bash
curl -L \
  --request PATCH \
  --url 'https://api.mobile-text-alerts.com/v3/custom-fields/7769' \
  --header 'Authorization: Bearer <APIKey>' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "New Name"
  }'
```

### Delete a Custom Subscriber Attribute

Custom Subscriber Attributes can be deleted  by calling the [#delete-custom-fields-customfieldid](https://developers.mobile-text-alerts.com/api-reference/custom-fields#delete-custom-fields-customfieldid "mention") endpoint. This request does not require a request body. Simply include the `{customFieldId}` of the attribute to be deleted as a path parameter with your request.

#### Example Request

In the below example, deleting attribute with `id: 7769`:

```bash
curl --request DELETE --location 'https://api.mobile-text-alerts.com/v3/custom-fields/7769' \
  --header 'Authorization: Bearer <APIKey>'
```

### Get a Custom Subscriber Attribute

List data for a specific Custom Subscriber Attribute with the [#get-custom-fields-customfieldid](https://developers.mobile-text-alerts.com/api-reference/custom-fields#get-custom-fields-customfieldid "mention") endpoint. Include the `{customFieldId}` of the attribute to be retrieved as a path parameter.

#### Example Request

```bash
curl --location 'https://api.mobile-text-alerts.com/v3/custom-fields/7769' \
  --header 'Authorization: Bearer <APIKey>'
```

**Example Response** (for a `date` type attribute)

{% code overflow="wrap" %}

```json
{
  "data": {
    "id": 7769,
    "accountId": 1195226,
    "name": "Birthday",
    "type": "date",
    "options": [],
    "format": "MM/DD/YYYY",
    "created": "2025-07-17T20:51:34.000Z"
  }
}
```

{% endcode %}

## Use Custom Subscriber Attributes

Once you have created Custom Subscriber Attributes on your account, you can start adding custom data to your subscribers. See [assign-custom-subscriber-attributes](https://developers.mobile-text-alerts.com/tutorials/manage-subscribers/assign-custom-subscriber-attributes "mention") to learn how to add and edit these attributes for your individual subscribers.

After you have these attributes assigned to your subscribers, you can use Custom Subscriber Attributes as a condition attribute for your [adaptive-groups](https://developers.mobile-text-alerts.com/tutorials/manage-subscribers/group-subscribers/adaptive-groups "mention").


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://developers.mobile-text-alerts.com/tutorials/custom-subscriber-attributes.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.