Classic/VPC環境で利用できます。
メールテンプレートを分類するカテゴリを作成します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
| メソッド | URI |
|---|---|
| POST | /category |
リクエストヘッダ
Cloud Outbound Mailer APIで共通して使用されるヘッダの詳細は、Cloud Outbound Mailerのリクエストヘッダをご参照ください。
リクエストボディ
リクエストボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
categoryName |
String | Required | 作成するカテゴリの名前
|
parentSid |
Integer | Optional | 親カテゴリの SID
|
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request POST 'https://mail.apigw.ntruss.com/api/v1/category' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
"categoryName": "testCategory",
"parentSid": -1
}'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
sid |
Integer | - | 作成したカテゴリの SID |
parentSid |
Integer | - | 親カテゴリの SID |
name |
String | - | 作成したカテゴリの名前 |
レスポンスステータスコード
Cloud Outbound Mailer APIで共通して使用されるレスポンスステータスコードの詳細は、Cloud Outbound Mailerのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"sid": 252,
"parentSid": -1,
"name": "testCategory"
}