メールタグ検索

POST

/api_v1_master_mailtag/search

curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxxxxx&refresh_token=xxxxxx&wait_flag=1&'fields=mail_tag_id,mail_tag_month,mail_tag_name,mail_tag_note,mail_tag_message1,mail_tag_message2,mail_tag_message3,mail_tag_message4,mail_tag_message5,mail_tag_message6,mail_tag_deleted_flag,mail_tag_creation_date,mail_tag_last_modified_date,mail_tag_last_modified_null_safe_date,mail_tag_creator_id,mail_tag_creator_name,mail_tag_last_modified_by_id,mail_tag_last_modified_by_null_safe_id,mail_tag_last_modified_by_name,mail_tag_last_modified_by_null_safe_name'&mail_tag_id-like='MyMailTag'&mail_tag_month-eq=2&offset=0&limit=2' https://api.next-engine.org/api_v1_master_mailtag/search

// POST /api_v1_master_mailtag/search - メールタグ検索
const params = new URLSearchParams({
  access_token: '<access_token>',
  fields: 'field1,field2',
  offset: '0',
  limit: '50',
})
const res = await fetch('https://api.next-engine.org/api_v1_master_mailtag/search', {
  method: 'POST',
  headers: { 'content-type': 'application/x-www-form-urlencoded' },
  body: params,
})
const json = await res.json()
if (json.result !== 'success') throw new Error(json.message ?? json.code)
console.log(json.data)

# POST /api_v1_master_mailtag/search - メールタグ検索
import requests

params = {
    'access_token': '<access_token>',
    'fields': 'field1,field2',
    'offset': '0',
    'limit': '50',
}
res = requests.post(
    'https://api.next-engine.org/api_v1_master_mailtag/search',
    data=params,
)
json = res.json()
if json['result'] != 'success':
    raise RuntimeError(json.get('message') or json.get('code'))
print(json.get('data'))

Request Body^required

application/x-www-form-urlencoded

object

access_token

required

OAuth2 アクセストークン (必須)

string

refresh_token

OAuth2 リフレッシュトークン (access_token 期限切れ時の自動更新に使用)

string

wait_flag

同期実行フラグ。“1” 指定で処理完了を待つ

string

Allowed values: 0 1

fields

取得するフィールドをカンマ区切りで指定 (search 系のみ)

string

offset

検索開始位置 (search 系のみ)

integer

limit

取得件数 (search 系のみ)

integer

>= 1

Responses

200

実行結果 (result が success / error / redirect のいずれか)

application/json

object

result

required

実行結果ステータス

string

Allowed values: success error redirect

code

エラー時のエラーコード

string

message

One of:

string
Array<object>

string

access_token

更新後のアクセストークン

string

access_token_end_date

アクセストークン有効期限 (YYYY-MM-DD HH:MM:SS)

string

refresh_token

更新後のリフレッシュトークン

string

refresh_token_end_date

リフレッシュトークン有効期限

string

data

エンドポイント固有のレスポンスデータ

count

Count/search 系のヒット件数 (form-urlencoded レスポンスでは文字列で返ることがある)

integer | string

data

Array<object>

object

mail_tag_id

メールタグ / 文字列型