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 Contacts API

Manage contacts in the address book.

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

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

This API exposes 6 operations across 5 paths, and defines 7 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.

6 operations 5 paths 7 schemas 1 DELETE3 GET1 POST1 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 Contacts 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 6

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

Contacts 6

Manage contacts in the address book.

GET
/contacts
Get all contacts
getContacts 2 params → 200
POST
/contacts/normalized
Add a new contact
createContact body → 201400
GET
/contacts/{id}
Get the details of a specific contact
getContact 1 param → 200404
DELETE
/contacts/{id}
Delete a contact
deleteContact 1 param → 204
PUT
/contacts/{id}/normalized
Edit a contact
updateContact 1 param body → 200
GET
/contacts/search
Find contacts by given criteria
searchContacts 3 params → 200

Schemas 7

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

Contact
object
9 properties
Country
object
2 properties
ContactRequest
object
6 properties 2 required
ResourceLink
object
2 properties
ContactList
object
4 properties
ContactListEntity
object
5 properties
Error
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

textmagic-contacts-api-openapi.yml Raw ↑

Other APIs Textmagic publishes across the network.

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