API docs by Redocly

Coachify Public API (1.0.0)

Download OpenAPI specification:

CoachifyのPublic API

メールマガジンコンテンツ一覧取得

テナントに関連するメールマガジンコンテンツの一覧を取得します

Authorizations:
ApiKeyAuth
query Parameters
page
integer
Default: 1

ページ番号

page_size
integer <= 20
Default: 10

1ページあたりの表示件数（最大20）

Responses

Response samples

Content type
application/json
{
  • "total_pages": 0,
  • "current_page": 0,
  • "has_next": true,
  • "has_previous": true,
  • "results": [
    ]
}

メールマガジンコンテンツ作成

新しいメールマガジンコンテンツを作成します

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
subject
required
string

メールの件名

price
required
integer >= 110

価格（110円以上）

html_body
required
string

HTMLフォーマットのメール本文

text_body
required
string

テキストフォーマットのメール本文

delivery_date
required
string <date-time>

配信予定日時（現在より未来の日時、e.g. 2025-04-25T09:00:00.00+08:00 形式でタイムゾーン情報を含める）

is_active
boolean
Default: true

有効/無効フラグ

Responses

Request samples

Content type
application/json
{
  • "subject": "string",
  • "price": 110,
  • "html_body": "<h1>Hello, World</h1><p></p><p>Hello, World</p>",
  • "text_body": "Hello, World\\n\\nHello, World",
  • "delivery_date": "2025-04-25T09:00:00.00+08:00",
  • "is_active": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "subject": "string",
  • "delivery_date": "2025-04-25T09:00:00.00+08:00",
  • "price": 0,
  • "is_delivered": true,
  • "is_processing": true,
  • "is_active": true,
  • "delivery_started_date": "2025-04-25T09:00:00.00+08:00",
  • "created_at": "2025-04-25T09:00:00.00+08:00",
  • "updated_at": "2025-04-25T09:00:00.00+08:00",
  • "html_body": "<h1>Hello, World</h1><p></p><p>Hello, World</p>",
  • "text_body": "Hello, World\\n\\nHello, World"
}

メールマガジンコンテンツ詳細取得

特定のメールマガジンコンテンツの詳細情報を取得します

Authorizations:
ApiKeyAuth
path Parameters
content_id
required
integer

メールマガジンコンテンツID

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "subject": "string",
  • "delivery_date": "2025-04-25T09:00:00.00+08:00",
  • "price": 0,
  • "is_delivered": true,
  • "is_processing": true,
  • "is_active": true,
  • "delivery_started_date": "2025-04-25T09:00:00.00+08:00",
  • "created_at": "2025-04-25T09:00:00.00+08:00",
  • "updated_at": "2025-04-25T09:00:00.00+08:00",
  • "html_body": "<h1>Hello, World</h1><p></p><p>Hello, World</p>",
  • "text_body": "Hello, World\\n\\nHello, World"
}

メールマガジンコンテンツ更新

特定のメールマガジンコンテンツを更新します（配信済み・配信中は更新不可）

Authorizations:
ApiKeyAuth
path Parameters
content_id
required
integer

メールマガジンコンテンツID

Request Body schema: application/json
subject
string

メールの件名

price
integer >= 110

価格（110円以上）

html_body
string

HTMLフォーマットのメール本文

text_body
string

テキストフォーマットのメール本文

delivery_date
string <date-time>

配信予定日時（現在より未来の日時、e.g. 2025-04-25T09:00:00.00+08:00 形式でタイムゾーン情報を含める）

is_active
boolean

有効/無効フラグ

Responses

Request samples

Content type
application/json
{
  • "subject": "string",
  • "price": 110,
  • "html_body": "<h1>Hello, World</h1><p></p><p>Hello, World</p>",
  • "text_body": "Hello, World\\n\\nHello, World",
  • "delivery_date": "2025-04-25T09:00:00.00+08:00",
  • "is_active": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "subject": "string",
  • "delivery_date": "2025-04-25T09:00:00.00+08:00",
  • "price": 0,
  • "is_delivered": true,
  • "is_processing": true,
  • "is_active": true,
  • "delivery_started_date": "2025-04-25T09:00:00.00+08:00",
  • "created_at": "2025-04-25T09:00:00.00+08:00",
  • "updated_at": "2025-04-25T09:00:00.00+08:00",
  • "html_body": "<h1>Hello, World</h1><p></p><p>Hello, World</p>",
  • "text_body": "Hello, World\\n\\nHello, World"
}

メールマガジンコンテンツ削除

特定のメールマガジンコンテンツを削除します（配信済み・配信中は削除不可）

Authorizations:
ApiKeyAuth
path Parameters
content_id
required
integer

メールマガジンコンテンツID

Responses

Response samples

Content type
application/json
{
  • "error": "string"
}