Versions

それぞれのテンプレートは複数のバージョンを持つことができます。各バージョンで異なる件名とコンテンツを持つことができます。

テンプレート内の全てのバージョンを取得するためには、TemplatesのGETメソッドを呼び出します。VersionはTemplateリソースのネストされたリソースとして返されます。

あるバージョンをアクティブにする場合、VersionsのPATCHメソッドを使用してactiveフィールドを1に設定します。

各アカウントは全テンプレートを通じて300バージョンまで登録することができます。


POST

Create a new version for a template.

URI引数 必須 条件 説明
name Yes 100文字以下の文字列 新しいバージョンの名前
subject Yes <%subject%> タグが必要です 新しいバージョンの件名
html_content Yes コンテンツ内に <%body%> タグが必要です。最大1,048,576バイト 新しいバージョンのHTMLコンテンツ
plain_content Yes コンテンツ内に <%body%> タグが必要です。最大1,048,576バイト 新しいバージョンのtext/plainコンテンツ
active No 0 インアクティブ、1 アクティブ テンプレート内でアクティブなバージョンを設定します。テンプレート内で1つのバージョンのみアクティブにすることができます。最初に作成したバージョンは自動的にアクティブになります。

Request

1
POST https://api.sendgrid.com/v3/templates/:template_id/versions HTTP/1.1

Response

1
2
3
4
5
6
7
8
9
10
11
12
HTTP/1.1 201 OK

{
  "id": "8aefe0ee-f12b-4575-b5b7-c97e21cb36f3",
  "template_id": "ddb96bbc-9b92-425e-8979-99464621b543",
  "active": 1,
  "name": "example_version_name",
  "html_content": "<%body%>",
  "plain_content": "<%body%>",
  "subject": "<%subject%>",
  "updated_at": "2014-03-19 18:56:33"
}

POST

バージョンを有効化します。

Request

1
POST https://api.sendgrid.com/v3/templates/:template_id/versions/:version_id/activate HTTP/1.1

Response

1
2
3
4
5
6
7
8
9
10
11
12
HTTP/1.1 200 OK

{
  "id": "8aefe0ee-f12b-4575-b5b7-c97e21cb36f3",
  "template_id": "e3a61852-1acb-4b32-a1bc-b44b3814ab78",
  "active": 1,
  "name": "example_version_name",
  "html_content": "<%body%>",
  "plain_content": "<%body%>",
  "subject": "<%subject%>",
  "updated_at": "2014-06-12 11:33:00"
}

GET

特定のバージョンを取得します。

Request

1
GET https://api.sendgrid.com/v3/templates/:template_id/versions/:version_id HTTP/1.1

Response

1
2
3
4
5
6
7
8
9
10
11
12
HTTP/1.1 200 OK

{
  "id": "5997fcf6-2b9f-484d-acd5-7e9a99f0dc1f",
  "template_id": "d51480ca-ca3f-465c-bc3e-ceb71d73c38d"
  "active": 1
  "name": "version 1 name",
  "html_content": "<%body%>",
  "plain_content": "<%body%>",
  "subject": "<%subject%>",
  "updated_at": "2014-03-19 18:56:33"
}

PATCH

バージョンを編集します。

URI引数 必須 条件 説明
name No 100文字以下の文字列 バージョンの名前
subject No <%subject%> タグが必要です バージョンの件名
html_content No コンテンツ内に <%body%> タグが必要です。最大1,048,576バイト バージョンのHTMLコンテンツ
plain_content No コンテンツ内に <%body%> タグが必要です。最大1,048,576バイト バージョンのtext/plainコンテンツ
active No 0 インアクティブ、 1 アクティブ テンプレート内でアクティブなバージョンを設定します。テンプレート内で1つのバージョンのみアクティブにすることができます。

Request

1
PATCH https://api.sendgrid.com/v3/templates/:template_id/versions/:version_id HTTP/1.1

Response

1
2
3
4
5
6
7
8
9
10
11
12
HTTP/1.1 200 OK

{
  "id": "8aefe0ee-f12b-4575-b5b7-c97e21cb36f3",
  "template_id": "ddb96bbc-9b92-425e-8979-99464621b543",
  "active": 1,
  "name": "updated_example_name",
  "html_content": "<%body%>",
  "plain_content": "<%body%>",
  "subject": "<%subject%>",
  "updated_at": "2014-03-19 18:56:33"
}

DELETE

バージョンを削除します。

Request

1
DELETE https://api.sendgrid.com/v3/templates/:template_id/versions/:version_id HTTP/1.1

Response

1
HTTP/1.1 204 NO CONTENT (OK)