Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Textmagic Lists API

Manage contact lists.

Textmagic Lists API is one of 11 APIs that Textmagic publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Lists. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 8 operations across 3 paths, and defines 9 schemas. It is described by OpenAPI 3.0.1, at version 2.0.

Requests are made against a single base URL, https://rest.textmagic.com/api/v2.

8 operations 3 paths 9 schemas 2 DELETE3 GET1 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
2.0
Base URL
https://rest.textmagic.com/api/v2
Authentication
API Key, API Key
Terms of Service
Resource Areas
1

Authentication & Security 2

Textmagic Lists API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-TM-Username (TmUsername). An API key is passed in the header as X-TM-Key (TmKey). By default, every request must be authenticated.

  • TmUsername — Your Textmagic account username.
  • TmKey — Your Textmagic API key, generated in the account settings.

Paths & Operations 8

Across 3 paths, the API surfaces 8 operations — 2 DELETE, 3 GET, 1 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Lists 8

Manage contact lists.

GET
/lists
Get all lists
getLists 2 params → 200
POST
/lists
Create a new list
createList body → 201
GET
/lists/{id}
Get the details of a specific list
getList 1 param → 200404
PUT
/lists/{id}
Edit a list
updateList 1 param body → 200
DELETE
/lists/{id}
Delete a list
deleteList 1 param → 204
GET
/lists/{id}/contacts
Get all contacts in a list
getListContacts 3 params → 200
PUT
/lists/{id}/contacts
Assign contacts to a list
assignContactsToList 1 param body → 204
DELETE
/lists/{id}/contacts
Unassign contacts from a list
unassignContactsFromList 1 param → 204

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are Contact (9 properties), ContactListEntity (5 properties), ContactListList (4 properties), ContactList (4 properties). Each schema is shown below with its type and property counts.

Contact
object
9 properties
Country
object
2 properties
ContactListList
object
4 properties
ResourceLink
object
2 properties
ListRequest
object
3 properties 1 required
ContactList
object
4 properties
ContactListEntity
object
5 properties
ListContactsRequest
object
1 property 1 required
Error
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

textmagic-lists-api-openapi.yml Raw ↑

Other APIs Textmagic publishes across the network.

Textmagic Bulk API
Textmagic Chats API
Textmagic Contacts API
Textmagic Messages API
Textmagic Numbers API
Textmagic Replies API
Textmagic Schedules API
Textmagic Sender IDs API
Textmagic Stats API
Textmagic Templates API