API Reference

Github

Help Center

Sent Docs & API Ref

SDKs

Home

Support

Returns detailed information about a specific customer including their messaging channel configurations and credentials.

Retrieve a customer by ID

ApiKey

BearerAuth

Represents a customer account within the Sent platform, including messaging channel configurations and credentials

Fetches detailed contact information including available messaging channels and verification status. Use this endpoint when you need to look up a specific contact using their unique identifier.

Retrieve a contact by ID

Looks up contact information using a phone number. This endpoint is useful when you need to find a contact's details but only have their phone number. It returns the same detailed information as the ID-based lookup.

Retrieve a contact by phone number

Sends a templated message to a specific contact. The platform automatically determines the optimal channel (SMS or WhatsApp) based on the contact's preferences and availability. Messages are sent using pre-defined templates to ensure consistent formatting and compliance across channels.

Send a message to a contact using a template

Sends a templated message directly to a phone number without requiring a pre-existing contact. The system will attempt to determine the best channel for delivery and create a contact record if one doesn't exist.

Send a message to a phone number using a template

Returns a list of all message templates associated with the specified customer ID. Templates are returned in descending order by creation date.

Retrieve all templates for a customer

Creates a new message template that can be used for sending standardized messages across different channels. Templates ensure consistent messaging and support variable substitution.

Create a new message template

Returns a paginated list of all customers. Use page and pageSize parameters to control the number of results returned. Results are sorted by creation date in descending order.

Retrieve all customers with pagination

Creates a new customer account in the Sent platform. This endpoint initializes a new customer profile with basic information and returns the created customer details including generated IDs and credentials for various messaging channels.

Create a new customer account

Updates an existing customer's information including messaging channel configurations. All fields in the request body will override existing values.

Update customer information

Permanently deletes a customer and all associated data. This action cannot be undone. All active services for this customer will be terminated.

Delete a customer

Fetches or creates SMS contact information for a given phone number. This endpoint validates the phone number, determines SMS capabilities, and returns detailed formatting information needed for message delivery. Use this before sending messages to ensure proper SMS channel availability.

Retrieve SMS contact information and capabilities

Fetches or creates WhatsApp contact information for a given phone number. This endpoint validates WhatsApp availability and returns detailed contact metadata including business account status and profile information.

Contact

Messages

Templates

Customers

SMS

Whatsapp

Retrieve a customer by ID

Authorizations

Path Parameters

Response