Last 7 days, UTC

Average Latency
23ms

Average Uptime
100.0%

Current Status
Online

  • No information
  • Outage
  • Disruption
  • Normal
Average latency determined from Mashape to API Response time
Query Authentication
 

username and api_key used for authentication


Authentication
Description
Parameter
String

is the 10 digit phone number you used to signup - not the number SendHub gave you

username

Required

String

is your api key which can be found on the settings page

api_key

Required

Endpoints

HTTP 200 : Add and Remove Request POST/groups/{id}/contacts/
						{
  "add": [
    22081
  ],
  "remove": [
    22411,
    22412
  ]
}						
Adding and Removing Contacts

Test console
Description
Parameter
string

id

Required

Request Body

HTTP 200 : Add and Remove Request GET/groups/{id}/contacts/
						{
  "add": [
    22081
  ],
  "remove": [
    22411,
    22412
  ]
}						
Collect a Group’s Contacts

Test console
Description
Parameter
string

ID - is the group’s id. This can be obtained from the id or resource_uri field.

id

Required

HTTP 200 : string DELETE/groups/{id}/
Delete Group

Test console
Description
Parameter
string

ID - is the group’s id. This can be obtained from the id or resource_uri field.

id

Required

HTTP 200 : Editing a Group Request PUT/groups/{id}/
						{
   "id": "1220",
   "name": "Best Customers",
   "slug": "regulars"
   "text_to_subscribe": true
}						
Edit Group

Test console
Description
Parameter
string

id

Required

Request Body

Contacts

HTTP 200 : Add Contact Request POST/contacts/
						{
  "name": "John Doe",
  "number": "6501234567"
}						
Add Contact

Request Body

HTTP 200 : Collecting Contacts Data Model GET/contacts/
						{
  "meta": {
    "limit": 20,
    "next": null,
    "offset": 0,
    "previous": null,
    "total_count": 3
  },
  "objects": [
    {
      "blocked": false,
      "date_created": "2013-05-02T19:42:03.733058",
      "date_modified": "2013-05-02T19:42:03.733089",
      "deleted": false,
      "email": "chris@mashape.com",
      "groups": [],
      "id": 6515727,
      "id_str": "6515727",
      "is_owned": true,
      "keyword": "chris",
      "local_gateway": false,
      "name": "Chris Ismael",
      "number": "+14154259743",
      "resource_uri": "/v1/contacts/6515727/",
      "screened": false
    },
    {
      "blocked": false,
      "date_created": "2013-05-02T19:42:08.696570",
      "date_modified": "2013-05-02T19:42:08.696604",
      "deleted": false,
      "extra_info": "",
      "groups": [],
      "id": 6515729,
      "id_str": "6515729",
      "is_owned": true,
      "keyword": "sendhubsupport",
      "local_gateway": true,
      "name": "SendHub Support",
      "number": "+16508305662",
      "resource_uri": "/v1/contacts/6515729/",
      "screened": false
    },
    {
      "blocked": false,
      "date_created": "2013-05-02T19:42:08.221835",
      "date_modified": "2013-05-02T19:42:08.221869",
      "deleted": false,
      "extra_info": "",
      "groups": [],
      "id": 6515728,
      "id_str": "6515728",
      "is_owned": true,
      "keyword": "sendhub",
      "local_gateway": false,
      "name": "SendHub Test Service",
      "number": "+16506003357",
      "resource_uri": "/v1/contacts/6515728/",
      "screened": false
    }
  ]
}						
Collect Contacts Data

HTTP 200 : string DELETE/contacts/{contact_id}/
Delete Contact

Test console
Description
Parameter
string

Example: 6515727

contact_id

Required

HTTP 200 : Edit Contact Request PUT/contacts/{contact_id}/
						{
  "id": "6515727",
  "name": "Jesse Doe",
  "number": "6501234567"
}						
Edit Contact

Test console
Description
Parameter
string

Example: 6515727

contact_id

Required

Request Body

Groups

HTTP 200 : Add Group Request POST/groups/
						{
  "name": "Regulars",
  "slug": "regulars",
  "text_to_subscribe": true
}						
Add Group

Request Body

HTTP 200 : Add and Remove Request GET/groups/
						{
  "add": [
    22081
  ],
  "remove": [
    22411,
    22412
  ]
}						
Collect Groups List

HTTP 200 : Add and Remove Request GET/groups/{id}/
						{
  "add": [
    22081
  ],
  "remove": [
    22411,
    22412
  ]
}						
Collect a Single Group’s Data

Test console
Description
Parameter
string

ID - is the group’s id. This can be obtained from the id or resource_uri field.

id

Required

Inbox

HTTP 200 : string GET/inbox/
Collect Inbox

Messages

HTTP 200 : string PUT/messages/{id}/
Edit Message

The only non-readonly parameter in the edit message resource is the unread field.


Test console
Description
Parameter
string

id

Required

Request Body

HTTP 200 : Message GET/messages/{id}/
						{
  "acknowledgment": "Message scheduled for delivery at 2011-02-17 22:30:00.",
  "contacts": [
    21399
  ],
  "created_at": "2012-02-17T13:06:58.859847",
  "direction": "to",
  "groups": null,
  "id": "30",
  "resource_uri": "/api/v1/messages/30/",
  "scheduled_at": "2011-02-17T22:30:00",
  "sent": null,
  "text": "Testing",
  "unread": null
}						
Get Message

Test console
Description
Parameter
string

id

Required

HTTP 201 : Message POST/messages/
						{
  "acknowledgment": "Message scheduled for delivery at 2011-02-17 22:30:00.",
  "contacts": [
    21399
  ],
  "created_at": "2012-02-17T13:06:58.859847",
  "direction": "to",
  "groups": null,
  "id": "30",
  "resource_uri": "/api/v1/messages/30/",
  "scheduled_at": "2011-02-17T22:30:00",
  "sent": null,
  "text": "Testing",
  "unread": null
}						
Send Messages

Send message (text) to contact id


Request Body

Profile

HTTP 200 : string GET/profile/
Collecting the Profile

Threads

HTTP 200 : string GET/threads/{threadid}/
View Threads

Test console
Description
Parameter
string

Where THREADID (and the full path) is obtained from the ‘resource_uri’ value in the Inbox response.

threadid

Required

Consume this API completely for free!


By joining the mashape API marketplace you can start using SendHub API today!

Login to your account or signup: Create Account

or
   Signup with GitHub

By signing up you agree to our terms of service.