List all subscribers and query for subscribers. Includes all subscribers with query value in either first name, last name, number, email, or custom subscriber fields and with filters values in respective categories.
Rate Limit
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 per 15 seconds.
If given a phone number or email that already exists tied to the same account, this will update the existing subscriber with new information
Rate Limit
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 per 15 seconds.
Headers
Name
Value
Content-Type
application/json
Authorization
Body
Required Fields: email or number
Name
Type
Description
firstName
string
First name of the subscriber.
lastName
string
Last name of the subscriber.
number(required if no email)
number
Phone number of the subscriber.
email (required if no number)
string
Email address of the subscriber.
e164Number
string
E.164 international telephone number of the subscriber. If supplied, will be used over number .
E.164 Format:
[+] [country code] [subscriber number including area code] (max. 15 digits)
groupIds
number[]
List of group ids of the groups the subscriber belongs to.
subscriberFields
dictionary: subscriberFieldIds:string as the keys and data: string corresponding values
A dictionary of key value pairs of additional custom data fields for the subscriber.
{
"httpCode":400,
"message":"Required fields for adding a member are a valid 'number' or 'email'.",
"timestamp":"2025-03-20T14:12:41-05:00",
"type":"missing_field_error",
"name":"MTAMissingFieldError",
"requestId":"cb5e59df-1901-484e-851c-3405f0b93140"
}
Update details of a specific subscriber. If a field isn't specified, then original value is retained, except for groups , where the subscriber will be added as a member to the groups specified and removed from all other groups.
If given a phone number or email that already exists, then this endpoint will return success: false.
Path Variable
When making the request, the Subscriber Id, Phone Number or email must be included as an identifier in the path:
idOrNumber: string
subscriberId: number
Rate Limit
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 per 15 seconds.
Headers
Name
Value
Content-Type
application/json
Authorization
Body (all optional)
Name
Type
Description
firstName
string
First name of the subscriber.
lastName
string
Last name of the subscriber.
number
number
Phone number of the subscriber.
email
string
Email address of the subscriber.
e164Number
string
E.164 international telephone number of the subscriber. If supplied, will be used over number .
E.164 Format:
[+] [country code] [subscriber number including area code] (max. 15 digits)
groupIds
number[]
List of group ids of the groups the subscriber belongs to.
subscriberFields
dictionary: subscriberFieldIds:string as the keys and data: string corresponding values
A dictionary of key value pairs of additional custom data fields for the subscriber.
List the data for just the specified (using the path variable) subscriber.
Path Variable
When making the request, the Subscriber Id or Phone Number must be included as an identifier in the path:
idOrNumber: string
subscriberId: number
Rate Limit
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 per 15 seconds.
Remove the specified (using the path variable) subscriber.
Path Variable
When making the request, the Subscriber Id or Phone Number must be included as an identifier in the path:
idOrNumber: string
subscriberId: number
A 404 response will be returned if this identifier is not found.
Rate Limit
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 per 15 seconds.
