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

Create and manage contacts.

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

Tagged areas include Contact. 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 43 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 43 schemas 1 DELETE3 GET1 PATCH1 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 Contact 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, 1 PATCH, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Contact 7

Create and manage contacts.

GET
/v1/contacts
List Contacts
listContacts 7 params → 200400401403420429
POST
/v1/contacts
Create/Update Contact
upsertContact body → 201400401420429
PATCH
/v1/contacts
Creates, updates, or deletes multiple contacts in one request
bulkUpsertContacts body → 202
GET
/v1/contacts/{contact_id}
Get Contact
getContact 1 param → 200401404420429
PUT
/v1/contacts/{contact_id}
Update Contact
updateContact 1 param body → 200400401404420429
DELETE
/v1/contacts/{contact_id}
Delete Contact
deleteContact 1 param → 204401404420429
GET
/v1/groups/{group_id}/contacts
List Group's Contacts
listGroupContacts 8 params → 200401404420429

Schemas 43

The contract defines 43 schemas that model the data the API accepts and returns. The most detailed are contact (16 properties), upsertContactRequestWithoutId (8 properties), rateLimitingResponse (6 properties), meta (4 properties). Each schema is shown below with its type and property counts.

bulkUpsertContactRequest
object
1 property
contactWithContactId
next
string
deleted
boolean
localGateway
boolean
True if the contact is a SendHub line
contactIdBoth
string
offset
integer
nameErrorObject
object
1 property
upsertContactRequestWithId
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:
upsertContactRequestWithoutId
object
8 properties 2 required
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
updateContactRequest
groupResourceUri
string
Resource URI for this group
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
timestamp
string
A UTC timestamp 2021-08-01T03:48:55.350453 equals August 1st, 2021 at 3:48 and 55.350453 seconds AM (UTC)
updateContactResponse
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
contactResourceUri
string
Resource URI for this contact
limit
integer
listOfGroupIds
array
List of group resource URIs and/or IDs
groupIdInt
integer
The group ID
rateLimitingResponse
object
6 properties
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
numberErrorObject
object
1 property
contactIdInt
integer
The contact ID
contactId
The contact ID
meta
object
4 properties
upsertContactResponse
upsertContactRequest
screened
boolean
Whether the contact has been blocked by you
nameOrNumberError

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

sendhub-contact-api-openapi.yml Raw ↑

Other APIs SendHub publishes across the network.

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

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