Logo

Getting Started

IntroductionAuthentication

OTP

POSTRequest OTPPOSTVerify OTPDELETERevoke OTPGETGet TokenGETGet OTP by Recipient

Lists

GETGet contact listGETGet rowPOSTCreate rowPATCHUpdate rowDELETEDelete row
Logo
DocumentationAPI ReferenceChangelog

Getting Started

Authentication

Simpu authenticates your API requests using your account's API keys. If a request doesn't include a valid key, Simpu returns an invalid request error. If a request includes a deleted or expired key, Simpu returns an authentication error.

Base URL

Simpu's API is built on REST principles and is served over HTTPS. To ensure data privacy, unencrypted HTTP is not supported.

The Base URL for all API endpoints is: https://api.v1.simpu.co

Response Codes

The API returns standard HTTP response codes to indicate the success or failure of an API request. Here are a few examples:

CodeDescription
200The request was successful.
204The request found no content.
400A request error found.
401The request requires user authentication.
403The server understood the request, but refuses to authorize it.
404The requested resource could not be found.
410Not Authorized.
500The server encountered an unexpected error.

Built with Chakra UI

On this page
Response Codes