How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

SendHub Thread API

View and manage inbox threads.

SendHub Thread API is one of 6 APIs that SendHub publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 3 operations across 2 paths, and defines 58 schemas. It is described by OpenAPI 3.0.3, at version v1.

Requests are made against a single base URL, https://api.sendhub.com.

3 operations 2 paths 58 schemas 1 DELETE2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
v1
Base URL
https://api.sendhub.com
Authentication
API Key, API Key, HTTP Basic
License
Terms of Service
Resource Areas
1

Authentication & Security 3

SendHub Thread API declares 3 security schemes for authenticating requests. An API key is passed in the query as username (username). An API key is passed in the query as api_key (api_key). It accepts HTTP basic authentication (basic_auth). By default, every request must be authenticated.

  • username — Your SendHub line's username (can be found in your My Settings page)
  • api_key — Your SendHub line's API key (can be found in your My Settings page)
  • basic_auth — Use your SendHub line's password or API key as the password with HTTP Basic Authentication (Your username and API key can be found in your My Settings page)

Paths & Operations 3

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

Thread 3

View and manage inbox threads.

GET
/v1/inbox
List Threads
listThreads 2 params → 200401420429
GET
/v1/threads/{thread_id}
Get thread
getThread 1 param → 200401404420429
DELETE
/v1/threads/{thread_id}
Delete thread
deleteThread 1 param → 200401404420429

Schemas 58

The contract defines 58 schemas that model the data the API accepts and returns. The most detailed are inboxThread (16 properties), threadNestedContact (10 properties), threadNestedGroup (9 properties), outboundAttachment (8 properties). Each schema is shown below with its type and property counts.

errorObject
object
2 properties
attachmentSize
number
Size of attachment in bytes
textToSubscribe
boolean
Whether to enable text-to-join functionality for this group
messageUnread
boolean
Whether or not the message is marked as unread Changing this will mark the corresponding thread as read or unread
rateLimitingResponse
object
6 properties
attachments
array
List of attachments
attachmentFilename
string
nullableString
string
scheduledAtWithoutTimezone
string
The date & time in UTC the message was scheduled to be sent at.
next
string
threadNestedGroup
object
9 properties
groupId
string
The group ID
threadUnread
boolean
Whether or not the thread is marked as unread
messageText
string
The text content of the message Note: Be sure you understand SMS segmenting ((learn more here)[https://sendhub.force.com/support/s/article/how-am-i-billed-for-…
messageHash
string
This is used internally and may be expanded upon or removed in the future
deleted
boolean
groupName
string
The group's name
ttjResponse
string
A custom response sent when someone texts-to-join this group
idStr
string
Same as id but always a string
contactKeyword
string
The keyword must be unique and is generated by the contact's name by default. [Learn more about how contact keywords are used here.](https://sendhub.force.com/…
attachmentType
string
Mimetype of the attachment
inboxThread
object
16 properties
isOwned
boolean
This is used internally and may be expanded upon or removed in the future
listOfGroupNames
array
List of group names
id
string
groupMediums
groupSlug
string
The "keyword" used to text-to-join Defaults to the group name lowercased, without any spaces and not duplicate by appending an incrementing number if needed
limit
integer
attachmentIsWriteable
boolean
contactNumber
string
The contact's phone number
timestamp
string
A UTC timestamp 2021-08-01T03:48:55.350453 equals August 1st, 2021 at 3:48 and 55.350453 seconds AM (UTC)
directionToFrom
string
The direction of the message; to or from the contact
attachmentKey
string
offset
integer
inboundAttachment
object
Inbound attachment
7 properties
blocked
boolean
Opt-out status (eg. if they texted Stop, Cancel, Block, Quit or End - [more info](https://sendhub.force.com/support/s/article/SendHub-Number-FAQ))
threadNestedContact
object
10 properties
contactName
string
The contact's name
sent
The date & time in UTC the message was sent at.
previous
string
thread
object
2 properties
threadMeta
contactIdInt
integer
The contact ID
groupCheckAll
boolean
This is used internally and may be expanded upon or removed in the future
meta
object
4 properties
attachmentUrl
string
shortlink
string
A short link generated by SendHub when you send a message with an attachment or with forceshortlinkcreation set to true
scheduledAt
string
The date & time in UTC to schedule the message to be sent at. Note: it must be exactly 24-characters long and in this format: 2022-04-13T15:29:40+0000
threadId
The thread ID
attachmentContainer
string
customField
string
Custom field(s) There's no limit to the number or size of custom fields (this may be subject to change in the future) except for a total limit of 65,535 bytes…
screened
boolean
Whether the contact has been blocked by you
listThreads200Response
object
2 properties
messageType
string
The type of the message (if on the thread object, then the type of the last message in the thread)
outboundAttachment
object
Outbound attachment
8 properties
attachmentMimetype
string
Mimetype of the attachment
nullableTimestamp
messageResourceUri
string
Resource URI for this message

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

sendhub-thread-api-openapi.yml Raw ↑

Other APIs SendHub publishes across the network.

SendHub Authentication API
SendHub Contact API
SendHub Group API
SendHub Message API
SendHub Profile API
Where this information came from

This is an independent, third-party profile of SendHub Thread API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.