Sendbound API Reference

Canonical request fields, permissions, and MCP coverage generated from the Sendbound API.

This page uses the same generated contract as the OpenAPI download and remote MCP server. Project API keys never grant access to another project's resources. See the inbound guide for receiving setup, webhook payloads, signatures, retries, and attachments.

This reference is generated from the API’s routes and request validators. Download the OpenAPI specification. JSON bodies go directly to the API; MCP tools use a body object and a query object.

Generated request examples contain placeholders. Replace addresses, URLs, resource IDs and other placeholder values before sending. Conditional rules and refinements are enforced by the API at runtime.

GET/templates

list (templates)

Authentication: Secret project API key. Resources are scoped to that project.

MCP: list_templates

Parameter	Location	Required	Type
`page`	query	No	string
`pageSize`	query	No	string
`search`	query	No	string
`type`	query	No	string
`sort`	query	No	string
`dir`	query	No	string

Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.

Response codes: 200, 400, 401, 403, 404, 429, 500, 503. Errors do not imply that an uncertain send is safe to repeat. A successful sending response confirms API acceptance, not inbox delivery.

POST/templates

create (templates)

Authentication: Secret project API key. Resources are scoped to that project.

MCP: create_template

Request body: `application/json`

Field	Required	Type / constraints
`name`	Yes	JSON
`description`	No / conditional	JSON
`subject`	Yes	JSON
`body`	Yes	JSON
`from`	Yes	JSON
`fromName`	No / conditional	JSON
`replyTo`	No / conditional	JSON
`type`	No / conditional	JSON

Complete request JSON Schema

{
  "type": "object",
  "properties": {
    "name": {},
    "description": {},
    "subject": {},
    "body": {},
    "from": {},
    "fromName": {},
    "replyTo": {},
    "type": {}
  },
  "required": [
    "name",
    "subject",
    "body",
    "from"
  ],
  "additionalProperties": true
}

Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.

Response codes: 201, 400, 401, 403, 404, 429, 500, 503. Errors do not imply that an uncertain send is safe to repeat. A successful sending response confirms API acceptance, not inbox delivery.

GET/templates/:id

get (templates)

Authentication: Secret project API key. Resources are scoped to that project.

MCP: get_template

Parameter	Location	Required	Type
`id`	path	Yes	string

Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.

Response codes: 200, 400, 401, 403, 404, 429, 500, 503. Errors do not imply that an uncertain send is safe to repeat. A successful sending response confirms API acceptance, not inbox delivery.

PATCH/templates/:id

update (templates)

Authentication: Secret project API key. Resources are scoped to that project.

MCP: update_template

Parameter	Location	Required	Type
`id`	path	Yes	string

Request body: `application/json`

Field	Required	Type / constraints
`name`	No / conditional	JSON
`description`	No / conditional	JSON
`subject`	No / conditional	JSON
`body`	No / conditional	JSON
`from`	No / conditional	JSON
`fromName`	No / conditional	JSON
`replyTo`	No / conditional	JSON
`type`	No / conditional	JSON

Complete request JSON Schema

{
  "type": "object",
  "properties": {
    "name": {},
    "description": {},
    "subject": {},
    "body": {},
    "from": {},
    "fromName": {},
    "replyTo": {},
    "type": {}
  },
  "additionalProperties": true
}

Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.

Response codes: 200, 400, 401, 403, 404, 429, 500, 503. Errors do not imply that an uncertain send is safe to repeat. A successful sending response confirms API acceptance, not inbox delivery.

DELETE/templates/:id

delete (templates)

Authentication: Secret project API key. Resources are scoped to that project.

MCP: delete_template

Parameter	Location	Required	Type
`id`	path	Yes	string

Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.

Response codes: 204, 400, 401, 403, 404, 429, 500, 503. Errors do not imply that an uncertain send is safe to repeat. A successful sending response confirms API acceptance, not inbox delivery.

POST/templates/bulk-update

bulk Update (templates)

Authentication: Secret project API key. Resources are scoped to that project.

MCP: templates_bulk_update

Request body: `application/json`

Field	Required	Type / constraints
`ids`	Yes	array
`delete`	No / conditional	boolean

Complete request JSON Schema

{
  "type": "object",
  "properties": {
    "ids": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "minItems": 1,
      "maxItems": 1000
    },
    "delete": {
      "type": "boolean"
    }
  },
  "required": [
    "ids"
  ],
  "additionalProperties": false
}

Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.

Response codes: 200, 400, 401, 403, 404, 429, 500, 503. Errors do not imply that an uncertain send is safe to repeat. A successful sending response confirms API acceptance, not inbox delivery.

POST/templates/:id/duplicate

duplicate (templates)

Authentication: Secret project API key. Resources are scoped to that project.

MCP: templates_duplicate

Parameter	Location	Required	Type
`id`	path	Yes	string

Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.

Response codes: 201, 400, 401, 403, 404, 429, 500, 503. Errors do not imply that an uncertain send is safe to repeat. A successful sending response confirms API acceptance, not inbox delivery.

GET/templates/:id/usage

get Usage (templates)

Authentication: Secret project API key. Resources are scoped to that project.

MCP: templates_get_usage

Parameter	Location	Required	Type
`id`	path	Yes	string

Project-scoped customer operation. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.

Response codes: 200, 400, 401, 403, 404, 429, 500, 503. Errors do not imply that an uncertain send is safe to repeat. A successful sending response confirms API acceptance, not inbox delivery.

POST/templates/convert

convert (templates)

Authentication: Public/application-specific authentication; see the flow-specific guide.

MCP: Not exposed through remote MCP; account administration, credentials, browser tracking, and dashboard aliases retain their own authorization.

Request body: `application/json`

Field	Required	Type / constraints
`format`	No / conditional	JSON
`content`	No / conditional	JSON

Complete request JSON Schema

{
  "type": "object",
  "properties": {
    "format": {},
    "content": {}
  },
  "additionalProperties": true
}

Public/token-authenticated application flow. Server enforces project ownership and additional cross-field validation. IDs are UUIDs, not prefixed placeholders.

Response codes: 200, 400, 401, 403, 404, 429, 500, 503. Errors do not imply that an uncertain send is safe to repeat. A successful sending response confirms API acceptance, not inbox delivery.

Templates

Request body: application/json

Request body: application/json

Request body: application/json

Request body: application/json

Request body: `application/json`

Request body: `application/json`

Request body: `application/json`

Request body: `application/json`