Sent.dm API

https://docs.sent.dm/
Admin
A modern messaging API that simplifies multi-channel communication (SMS, WhatsApp, iMessage, RCS)...
Tokens:495,251
Snippets:4,903
Trust Score:8.9
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install Sent Go SDK

Source: https://docs.sent.dm/sdks/go

Commands to install the library via go get.

```bash
go get github.com/sentdm/sent-dm-go
```

```bash
go get github.com/sentdm/sent-dm-go@<version>
```

--------------------------------

### Expose local server with ngrok

Source: https://docs.sent.dm/start/webhooks/local-development

Commands to install ngrok, start a local server, and create a public tunnel to localhost.

```bash
# Install ngrok (if not already installed)
npm install -g @ngrok/ngrok

# Start your local server
npm run dev  # Running on http://localhost:5000

# In another terminal, create tunnel
ngrok http 5000
```

--------------------------------

### Start Sinatra Application

Source: https://docs.sent.dm/llms-full.txt

Command to start the local development server.

```bash
bundle exec rackup
```

--------------------------------

### Example Responses

Source: https://docs.sent.dm/llms-full.txt

JSON examples for successful completion and in-progress status.

```json
{
  "success": true,
  "data": {
    "status": "completed",
    "message": "Profile is already completed"
  },
  "error": null,
  "meta": {
    "request_id": "req_7X9zKp2jDw",
    "timestamp": "2026-08-03T12:01:05.5812174+00:00",
    "version": "v3"
  }
}
```

```json
{
  "success": true,
  "data": {
    "message": "Profile completion in progress"
  },
  "error": null,
  "meta": {
    "request_id": "req_7X9zKp2jDw",
    "timestamp": "2026-08-03T12:01:05.5812443+00:00",
    "version": "v3"
  }
}
```

--------------------------------

### 404 Not Found Example

Source: https://docs.sent.dm/llms-full.txt

Example response when the requested template does not exist.

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "RESOURCE_002",
    "message": "Template not found",
    "details": null,
    "doc_url": "https://docs.sent.dm/reference/api/error-catalog"
  },
  "meta": {
    "request_id": "req_7X9zKp2jDw",
    "timestamp": "2026-08-03T12:01:05.3701459+00:00",
    "version": "v3"
  }
}
```

--------------------------------

### Verify profile status

Source: https://docs.sent.dm/start/advanced/sub-account-profiles-api

Retrieve the current setup state of a profile using a GET request.

```bash
curl "https://api.sent.dm/v3/profiles/$PROFILE_ID" \
  -H "x-api-key: $ORG_API_KEY"
```

--------------------------------

### Example Per-Article File Structure

Source: https://docs.sent.dm/llms-full.txt

The expected format for individual plain-text documentation files, starting with a canonical URL.

```text
URL: https://docs.sent.dm/llms/start/guides/sending-messages.txt

# Sending Messages
...
```

--------------------------------

### Install aiohttp Backend

Source: https://docs.sent.dm/sdks/python

Optional installation for using aiohttp as the HTTP backend.

```bash
pip install sentdm[aiohttp]
```

--------------------------------

### 201 Created Example

Source: https://docs.sent.dm/llms-full.txt

A successful response example for a created template.

```json
{
  "success": true,
  "data": {
    "id": "7ba7b820-9dad-11d1-80b4-00c04fd430c8",
    "name": "Welcome Message",
    "category": "MARKETING",
    "language": "en_US",
    "status": "DRAFT",
    "channels": [
      "sms",
      "whatsapp"
    ],
    "variables": [
      "name",
      "company"
    ],
    "created_at": "2026-08-03T12:01:05.3683756+00:00",
    "updated_at": "2026-08-03T12:01:05.3683918+00:00",
    "is_published": false
  },
  "error": null,
  "meta": {
    "request_id": "req_7X9zKp2jDw",
    "timestamp": "2026-08-03T12:01:05.3684208+00:00",
    "version": "v3"
  }
}
```

--------------------------------

### Install Sent SDK

Source: https://docs.sent.dm/sdks/typescript

Install the package using your preferred package manager.

```bash
npm install @sentdm/sentdm
```

```bash
yarn add @sentdm/sentdm
```

```bash
pnpm add @sentdm/sentdm
```

```bash
bun add @sentdm/sentdm
```

--------------------------------

### Install Sent PHP SDK

Source: https://docs.sent.dm/sdks/php

Use Composer to install the SDK package.

```bash
composer require sentdm/sent-dm-php
```

```bash
composer require "sentdm/sent-dm-php 0.26.0"
```

--------------------------------

### Install Sent SDK

Source: https://docs.sent.dm/sdks/python

Installation commands for various Python package managers.

```bash
pip install sentdm
```

```bash
poetry add sentdm
```

```bash
uv pip install sentdm
```

--------------------------------

### Example ngrok tunnel output

Source: https://docs.sent.dm/llms-full.txt

The public URL generated by ngrok that maps to the local server.

```text
https://abc123.ngrok.io -> http://localhost:5000
```

--------------------------------

### GET /v3/messages/{message_id}

Source: https://docs.sent.dm/llms-full.txt

Retrieves the status and template variables of a message, including those sent in sandbox mode.

```APIDOC
## GET /v3/messages/{message_id}

### Description
Retrieves the status and details of a specific message, including template variables used. This endpoint is useful for verifying content in sandbox mode.

### Method
GET

### Endpoint
/v3/messages/{message_id}

### Parameters
#### Path Parameters
- **message_id** (string) - Required - The unique identifier of the message.
```

--------------------------------

### Start the development server

Source: https://docs.sent.dm/sdks/typescript/integrations/nextjs

Run the application with credentials loaded to begin testing.

```bash
npm run dev
```

--------------------------------

### Initialize the project and install dependencies

Source: https://docs.sent.dm/sdks/typescript/first-integration

Commands to create a new directory, initialize npm, and install the Sent SDK, Express, and tsx.

```bash
mkdir sent-first-integration
cd sent-first-integration
npm init -y
npm install @sentdm/sentdm express
npm install -D tsx
```

--------------------------------

### Get User by ID cURL Request

Source: https://docs.sent.dm/reference/api/users/SentDmServicesEndpointsCustomerAPIv3UsersGetUserEndpoint

Example of how to perform the GET request using cURL.

```bash
curl -X GET "https://api.sent.dm/v3/users/string" \
  -H "x-api-key: "
```

--------------------------------

### Start the service

Source: https://docs.sent.dm/sdks/go/integrations/gin

Run the application with credentials loaded to begin the integration verification.

```bash
go run ./cmd/api
```

--------------------------------

### Opt-in Autoresponse Example

Source: https://docs.sent.dm/start/advanced/10dlc-registration

Required confirmation message triggered by START keywords.

```text
[Brand]: Welcome! Please reply HELP for help. Message frequency may vary.
Msg & data rates may apply. Reply STOP to opt out.
```

--------------------------------

### Run the Application

Source: https://docs.sent.dm/sdks/csharp/integrations/aspnet-core

Start the application with credentials loaded to begin verification.

```bash
dotnet run
```

--------------------------------

### GET /v3/profiles/{profileId}

Source: https://docs.sent.dm/llms-full.txt

Verify the outcome of a profile setup by retrieving its current status.

```APIDOC
## GET /v3/profiles/{profileId}

### Description
Confirm the outcome of a profile setup process.

### Method
GET

### Endpoint
https://api.sent.dm/v3/profiles/{profileId}

### Parameters
#### Path Parameters
- **profileId** (string) - Required - The UUID of the profile to verify.
```

--------------------------------

### Start Symfony Server

Source: https://docs.sent.dm/sdks/php/integrations/symfony

Launch the local development server with environment credentials loaded.

```bash
symfony server:start
```

--------------------------------

### Configure the client

Source: https://docs.sent.dm/llms-full.txt

Demonstrates initializing the client using environment variables, explicit API keys, or a combination of both.

```csharp
using Sentdm;

// Using environment variables
SentClient client = new();

// Or explicit configuration
SentClient client = new()
{
    ApiKey = "your_api_key",
};

// Or a combination
SentClient client = new()
{
    ApiKey = "your_api_key",  // Explicit
    // Other settings from environment
};
```

--------------------------------

### Retrieve template by ID via cURL

Source: https://docs.sent.dm/reference/api/templates/SentDmServicesEndpointsCustomerAPIv3TemplatesGetTemplateEndpoint

Example request to fetch a specific template using the GET method.

```bash
curl -X GET "https://api.sent.dm/v3/templates/7ba7b820-9dad-11d1-80b4-00c04fd430c8" \
  -H "x-api-key: "
```

--------------------------------

### Start the application

Source: https://docs.sent.dm/llms-full.txt

Run the application locally using uvicorn.

```bash
uvicorn app.main:app --reload
```

--------------------------------

### Start Django Development Server

Source: https://docs.sent.dm/sdks/python/integrations/django

Run the development server with credentials loaded to begin testing the integration.

```bash
python manage.py runserver
```

--------------------------------

### Start Laravel Development Server

Source: https://docs.sent.dm/sdks/php/integrations/laravel

Launch the local development server to begin testing the integration.

```bash
php artisan serve
```

--------------------------------

### Start Sinatra Application

Source: https://docs.sent.dm/sdks/ruby/integrations/sinatra

Launch the application with the necessary environment variables configured.

```bash
bundle exec rackup
```

--------------------------------

### 404 Not Found Example

Source: https://docs.sent.dm/llms-full.txt

Example response when the specified user ID does not exist.

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "RESOURCE_006",
    "message": "User not found",
    "details": null,
    "doc_url": "https://docs.sent.dm/reference/api/error-catalog"
  },
  "meta": {
    "request_id": "req_7X9zKp2jDw",
    "timestamp": "2026-08-03T12:01:05.3609945+00:00",
    "version": "v3"
  }
}
```

--------------------------------

### Success Response Example

Source: https://docs.sent.dm/llms-full.txt

JSON example of a successful template retrieval.

```json
{
  "success": true,
  "data": {
    "id": "7ba7b820-9dad-11d1-80b4-00c04fd430c8",
    "name": "Welcome Message",
    "category": "MARKETING",
    "language": "en_US",
    "status": "APPROVED",
    "channels": [
      "sms",
      "whatsapp"
    ],
    "variables": [
      "name",
      "company"
    ],
    "created_at": "2026-07-04T12:01:05.3724518+00:00",
    "updated_at": "2026-07-19T12:01:05.3724522+00:00",
    "is_published": true
  },
  "error": null,
  "meta": {
    "request_id": "req_7X9zKp2jDw",
    "timestamp": "2026-08-03T12:01:05.3724525+00:00",
    "version": "v3"
  }
}
```

--------------------------------

### Start Flask Application

Source: https://docs.sent.dm/sdks/python/integrations/flask

Command to launch the Flask development server with environment credentials loaded.

```bash
flask run
```

--------------------------------

### 404 Not Found Error Example

Source: https://docs.sent.dm/llms-full.txt

Example response when a requested organization cannot be found.

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "RESOURCE_005",
    "message": "Organization not found",
    "details": null,
    "doc_url": "https://docs.sent.dm/reference/api/error-catalog"
  },
  "meta": {
    "request_id": "req_7X9zKp2jDw",
    "timestamp": "2026-08-03T12:01:05.5857176+00:00",
    "version": "v3"
  }
}
```

--------------------------------

### Initialize the Sent client

Source: https://docs.sent.dm/sdks/go/integrations/gin

Create a shared client instance at application startup.

```go
// main.go (excerpt)
client := sentdm.NewClient(
    option.WithAPIKey(os.Getenv("SENT_DM_API_KEY")),
)
```

--------------------------------

### Validation Error Example

Source: https://docs.sent.dm/llms-full.txt

Example of a 400 Bad Request response.

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "VALIDATION_001",
    "message": "Phone number is required",
    "details": null,
    "doc_url": "https://docs.sent.dm/reference/api/error-catalog"
  },
  "meta": {
    "request_id": "req_7X9zKp2jDw",
    "timestamp": "2026-08-03T12:01:05.7479895+00:00",
    "version": "v3"
  }
}
```

--------------------------------

### Start Rails Server

Source: https://docs.sent.dm/sdks/ruby/integrations/rails

Launch the Rails application with the necessary credentials loaded.

```bash
bin/rails server
```

--------------------------------

### Verify SDK installation

Source: https://docs.sent.dm/sdks/typescript/first-integration

Check the installed version of the Sent SDK.

```bash
npm ls @sentdm/sentdm
```

--------------------------------

### Start the API service

Source: https://docs.sent.dm/llms-full.txt

Run the local API service with credentials loaded.

```bash
go run ./cmd/api
```

--------------------------------

### Forbidden Error Example

Source: https://docs.sent.dm/llms-full.txt

JSON example for a 403 Forbidden error response.

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "AUTH_004",
    "message": "You do not have access to this organization or profile",
    "details": null,
    "doc_url": "https://docs.sent.dm/reference/api/authentication"
  },
  "meta": {
    "request_id": "req_7X9zKp2jDw",
    "timestamp": "2026-08-03T12:01:05.3461415+00:00",
    "version": "v3"
  }
}
```

--------------------------------

### Run Spring Boot Application

Source: https://docs.sent.dm/sdks/java/integrations/spring-boot

Start the application with the necessary credentials loaded.

```bash
./mvnw spring-boot:run
```

--------------------------------

### Successful Update Example

Source: https://docs.sent.dm/llms-full.txt

Example response body for a successful contact update.

```json
{
  "success": true,
  "data": {
    "id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
    "phone_number": "+1234567890",
    "format_e164": "+1234567890",
    "format_international": "+1 234-567-890",
    "format_national": "(234) 567-890",
    "format_rfc": "tel:+1-234-567-890",
    "country_code": "1",
    "region_code": "US",
    "available_channels": "sms,whatsapp",
    "default_channel": "whatsapp",
    "opt_out": false,
    "is_inherited": false,
    "created_at": "2026-07-04T12:01:05.7647214+00:00",
    "updated_at": "2026-08-03T12:01:05.7647221+00:00"
  },
  "error": null,
  "meta": {
    "request_id": "req_7X9zKp2jDw",
    "timestamp": "2026-08-03T12:01:05.7647226+00:00",
    "version": "v3"
  }
}
```

--------------------------------

### Install the Ruby SDK

Source: https://docs.sent.dm/llms-full.txt

Add the gem to your Gemfile or install it directly via command line.

```ruby
gem "sentdm"
```

```bash
bundle install
```

```bash
gem install sentdm
```

--------------------------------

### Resource Not Found Error Example

Source: https://docs.sent.dm/llms-full.txt

JSON example of a 404 error response.

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "RESOURCE_009",
    "message": "Brand not found for this profile",
    "details": null,
    "doc_url": "https://docs.sent.dm/reference/api/error-catalog"
  },
  "meta": {
    "request_id": "req_7X9zKp2jDw",
    "timestamp": "2026-08-03T12:01:05.7750091+00:00",
    "version": "v3"
  }
}
```

--------------------------------

### 404 Not Found error example

Source: https://docs.sent.dm/llms-full.txt

Example response when the campaign cannot be found for the specified profile.

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "RESOURCE_010",
    "message": "Campaign not found for this profile",
    "details": null,
    "doc_url": "https://docs.sent.dm/reference/api/error-catalog"
  },
  "meta": {
    "request_id": "req_7X9zKp2jDw",
    "timestamp": "2026-08-03T12:01:05.7733184+00:00",
    "version": "v3"
  }
}
```

--------------------------------

### Unauthorized Error Example

Source: https://docs.sent.dm/llms-full.txt

JSON example of a 401 Unauthorized error response.

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "AUTH_001",
    "message": "Invalid or missing API key. Ensure the x-api-key header is set with a valid key.",
    "details": null,
    "doc_url": "https://docs.sent.dm/reference/api/authentication"
  },
  "meta": {
    "request_id": "req_7X9zKp2jDw",
    "timestamp": "2026-08-03T12:01:05.7798371+00:00",
    "version": "v3"
  }
}
```

--------------------------------

### Run webhook server

Source: https://docs.sent.dm/sdks/typescript/first-integration

Starts the webhook server using npx and tsx.

```bash
npx tsx webhook-server.ts
```

--------------------------------

### API Response Examples

Source: https://docs.sent.dm/reference/api/templates/SentDmServicesEndpointsCustomerAPIv3TemplatesCreateTemplateEndpoint

Examples of successful and error responses returned by the API.

```json
{
  "success": true,
  "data": {
    "id": "7ba7b820-9dad-11d1-80b4-00c04fd430c8",
    "name": "Welcome Message",
    "category": "MARKETING",
    "language": "en_US",
    "status": "DRAFT",
    "channels": [
      "sms",
      "whatsapp"
    ],
    "variables": [
      "name",
      "company"
    ],
    "created_at": "2026-08-03T12:01:06.0610207+00:00",
    "updated_at": "2026-08-03T12:01:06.0610496+00:00",
    "is_published": false
  },
  "error": null,
  "meta": {
    "request_id": "req_7X9zKp2jDw",
    "timestamp": "2026-08-03T12:01:06.0610859+00:00",
    "version": "v3"
  }
}
```

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "VALIDATION_001",
    "message": "Template definition is required",
    "details": {
      "definition": [
        "Template definition is required"
      ]
    },
    "doc_url": "https://docs.sent.dm/reference/api/error-catalog"
  },
  "meta": {
    "request_id": "req_7X9zKp2jDw",
    "timestamp": "2026-08-03T12:01:06.0610896+00:00",
    "version": "v3"
  }
}
```

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "INTERNAL_001",
    "message": "An unexpected error occurred while creating the template",
    "details": null,
    "doc_url": "https://docs.sent.dm/reference/api/error-catalog"
  },
  "meta": {
    "request_id": "req_7X9zKp2jDw",
    "timestamp": "2026-08-03T12:01:06.0610901+00:00",
    "version": "v3"
  }
}
```

--------------------------------

### Error Response Examples

Source: https://docs.sent.dm/reference/api/profiles/SentDmServicesEndpointsCustomerAPIv3ProfilesGetProfilesEndpoint

Examples of error responses returned when the request fails.

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "RESOURCE_005",
    "message": "Organization not found",
    "details": null,
    "doc_url": "https://docs.sent.dm/reference/api/error-catalog"
  },
  "meta": {
    "request_id": "req_7X9zKp2jDw",
    "timestamp": "2026-08-03T12:01:06.2625867+00:00",
    "version": "v3"
  }
}
```

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "INTERNAL_001",
    "message": "Failed to retrieve profiles. Please contact support with request ID: req_7X9zKp2jDw",
    "details": null,
    "doc_url": "https://docs.sent.dm/reference/api/error-catalog"
  },
  "meta": {
    "request_id": "req_7X9zKp2jDw",
    "timestamp": "2026-08-03T12:01:06.2625873+00:00",
    "version": "v3"
  }
}
```

--------------------------------

### Install Sent SDK

Source: https://docs.sent.dm/llms-full.txt

Install the required package in the environment where workers execute.

```bash
pip install sentdm
```

--------------------------------

### Method Naming Conventions by Language

Source: https://docs.sent.dm/sdks/best-practices

Examples of idiomatic method naming styles across different SDK languages.

```typescript
client.messages.send()
```

```python
client.messages.send()
```

```go
client.Messages.Send()
```

```java
client.messages().send()
```

```csharp
client.Messages.Send()
```

```php
$client->messages->send()
```

```ruby
client.messages.send_
```
Tokens:
Raw