Skip to content
  • Auto
  • Light
  • Dark
Get Started

API Reference

Libraries

npm install sendblue

API Overview

Contacts

Get contact count
get/api/v2/contacts/count
Create a contact
post/api/v2/contacts
Delete a contact
delete/api/v2/contacts/{phone_number}
Get contacts
get/api/v2/contacts
Get a contact
get/api/v2/contacts/{phone_number}
Update a contact
put/api/v2/contacts/{phone_number}
Verify a contact
post/api/v2/contacts/verify

ContactsBulk

Create multiple contacts
post/api/v2/contacts/bulk
Delete multiple contacts
delete/api/v2/contacts

Groups

Modify a group
post/api/modify-group
Send a group message
post/api/send-group-message

Lookups

Lookup a phone number
get/api/evaluate-service

Media Objects

Upload a media object
post/api/upload-media-object

Messages

Get message status
get/api/status
Get messages
get/api/v2/messages
Get a specific message
get/api/v2/messages/{message_id}
Send a message
post/api/send-message

Typing Indicators

Send a typing indicator
post/api/send-typing-indicator