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/segments

list (segments)

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

MCP: list_segments

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/segments

create (segments)

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

MCP: create_segment

Request body: `application/json`

Field	Required	Type / constraints
`name`	Yes	JSON
`description`	No / conditional	JSON
`type`	No / conditional	JSON
`condition`	No / conditional	JSON
`trackMembership`	No / conditional	JSON

Complete request JSON Schema

{
  "type": "object",
  "properties": {
    "name": {},
    "description": {},
    "type": {},
    "condition": {},
    "trackMembership": {}
  },
  "required": [
    "name"
  ],
  "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/segments/:id

get (segments)

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

MCP: get_segment

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/segments/:id

update (segments)

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

MCP: segments_update

Parameter	Location	Required	Type
`id`	path	Yes	string

Request body: `application/json`

Field	Required	Type / constraints
`name`	No / conditional	JSON
`description`	No / conditional	JSON
`condition`	No / conditional	JSON
`trackMembership`	No / conditional	JSON

Complete request JSON Schema

{
  "type": "object",
  "properties": {
    "name": {},
    "description": {},
    "condition": {},
    "trackMembership": {}
  },
  "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/segments/:id

delete (segments)

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

MCP: delete_segment

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.

GET/segments/:id/contacts

get Contacts (segments)

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

MCP: segments_get_contacts

Parameter	Location	Required	Type
`id`	path	Yes	string
`page`	query	No	string
`pageSize`	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/segments/:id/members

add Members (segments)

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

MCP: segments_add_members

Parameter	Location	Required	Type
`id`	path	Yes	string

Request body: `application/json`

Field	Required	Type / constraints
`emails`	No / conditional	JSON
`createMissing`	No / conditional	JSON
`subscribed`	No / conditional	JSON

Complete request JSON Schema

{
  "type": "object",
  "properties": {
    "emails": {},
    "createMissing": {},
    "subscribed": {}
  },
  "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/segments/:id/members

remove Members (segments)

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

MCP: segments_remove_members

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/segments/:id/compute

compute (segments)

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

MCP: segments_compute

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/segments/:id/refresh

refresh (segments)

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

MCP: segments_refresh

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.

Segments

Request body: application/json

Request body: application/json

Request body: application/json

Request body: `application/json`

Request body: `application/json`

Request body: `application/json`