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

Create and manage groups.

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

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

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

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

7 operations 3 paths 53 schemas 1 DELETE3 GET2 POST1 PUT

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 Group 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 7

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

Group 7

Create and manage groups.

GET
/v1/groups
List Groups
listGroups 2 params → 200401420429
POST
/v1/groups
Create Group
createGroup body → 201400401420429
GET
/v1/groups/{group_id}
Get Group
getGroup 1 param → 200401404420429
PUT
/v1/groups/{group_id}
Update Group
updateGroup 1 param body → 200400401404420429
DELETE
/v1/groups/{group_id}
Delete Group
deleteGroup 1 param → 204401404420429
GET
/v1/groups/{group_id}/contacts
List Group's Contacts
listGroupContacts 8 params → 200401404420429
POST
/v1/groups/{group_id}/contacts
Add/Remove Group's Contacts
addRemoveGroupContacts 1 param body → 202401404420429

Schemas 53

The contract defines 53 schemas that model the data the API accepts and returns. The most detailed are contact (16 properties), group (16 properties), createGroupRequest (7 properties), rateLimitingResponse (6 properties). Each schema is shown below with its type and property counts.

nullableInteger
integer
next
string
deleted
boolean
groupSize
integer
The number of contacts that are a memeber of this group
groupMediums
localGateway
boolean
True if the contact is a SendHub line
contactIdBoth
string
addRemoveGroupContacts202ResponseAdd
object
1 property
offset
integer
nameErrorObject
object
1 property
listOfGroupResourceUris
array
List of group resource URIs
contactName
string
The contact's name
listContacts200Response
object
2 properties
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…
landlineOverride
boolean
TODO:
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/…
errorObject
object
2 properties
groupResourceUri
string
Resource URI for this group
nullableString
string
landline
boolean
Whether SendHub has determined the contact's number is a landline number
idStr
string
Same as id but always a string
id
string
addRemoveGroupContactsRequest
object
timestamp
string
A UTC timestamp 2021-08-01T03:48:55.350453 equals August 1st, 2021 at 3:48 and 55.350453 seconds AM (UTC)
addRemoveGroupContacts202Response
object
3 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))
previous
string
groupWithMediums
addRemoveGroupContacts202ResponseRemove
object
1 property
addRemoveGroupContactsRequestRemove
object
1 property 1 required
groupPermissions
contactResourceUri
string
Resource URI for this contact
isShared
boolean
Whether the group is shared between the lines
ttjResponse
string
A custom response sent when someone texts-to-join this group
groupName
string
The group's name
addRemoveGroupContactsRequestBoth
object
2 properties 2 required
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
createGroupRequest
object
7 properties 1 required
addRemoveGroupContactsRequestAdd
object
1 property 1 required
textToSubscribe
boolean
Whether to enable text-to-join functionality for this group
rateLimitingResponse
object
6 properties
updateGroupRequest
2 required
groupId
string
The group ID
isOwned
boolean
This is used internally and may be expanded upon or removed in the future
contactNumber
string
The contact's phone number
contact
object
16 properties 2 required
group
object
16 properties
contactIdInt
integer
The contact ID
contactId
The contact ID
meta
object
4 properties
screened
boolean
Whether the contact has been blocked by you
listGroups200Response
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

sendhub-group-api-openapi.yml Raw ↑

Other APIs SendHub publishes across the network.

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

This is an independent, third-party profile of SendHub Group 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.