属性管理
属性作成
URL
https://email.api.engagelab.cc/v1/marketing/lists/fields
https://email.api.engagelab.cc/v1/marketing/lists/fields
このコードブロックはフローティングウィンドウ内に表示されます
HTTPリクエストメソッド
POST
POST
このコードブロックはフローティングウィンドウ内に表示されます
Content-Type
application/json; charset=utf-8
application/json; charset=utf-8
このコードブロックはフローティングウィンドウ内に表示されます
リクエストヘッダー
| ヘッダー | タイプ | 必須 | 説明 |
|---|---|---|---|
| Authorization | string | true | Basic base64(api_user:api_key) |
ボディパラメータ
| パラメータ | タイプ | 必須 | 説明 |
|---|---|---|---|
| field_name | string | true | フィールド名（最大64文字、a-z、A-Z、0-9、_のみで構成され、システム定義の属性文字列（大文字小文字を区別しない）ではない必要があります。システムフィールドEmail、Name、Phoneを含む合計50の属性フィールドを作成可能） |
| field_type | integer | true | フィールドタイプ（0: テキスト、1: 数値、2: 日付、3: 誕生日、4: ドロップダウン） |
| visible | boolean | true | 表示可否（trueまたはfalse） |
| format | string | false | データフォーマット： 0または.0または.00（field_type=1の場合）； MM/DD/YYYYまたはDD/MM/YYYY（field_type=2の場合）； MM/DDまたはDD/MM（field_type=3の場合） |
| options | string[] | false | ドロップダウンタイプのリスト項目、field_typeがドロップダウンの場合は空にできず、最大10項目まで |
注意事項:
- システム属性: Email、Name、Phone、tag、campaign、segment、domain、createTime、updateTime、unsubscribeTime
- field_nameはシステム属性ではない必要があり、文字の大文字小文字を変更しても作成は許可されません
リクエスト例
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/fields --data '{
"field_name": "xiao",
"field_type": 3,
"visible": true,
"format": "MM/DD"
}'
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/fields --data '{
"field_name": "xiao",
"field_type": 3,
"visible": true,
"format": "MM/DD"
}'
このコードブロックはフローティングウィンドウ内に表示されます
レスポンス例 Response-Success
HttpStatus: 200
{
"result": {
"field_id": 11,
"field_name": "xiao",
"field_type": 3,
"visible": true,
"format": "MM/DD"
}
}
{
"result": {
"field_id": 11,
"field_name": "xiao",
"field_type": 3,
"visible": true,
"format": "MM/DD"
}
}
このコードブロックはフローティングウィンドウ内に表示されます
Response-Error
HTTP Status :401
{
"code": 30000,
"message": "Authentication failed"
}
{
"code": 30000,
"message": "Authentication failed"
}
このコードブロックはフローティングウィンドウ内に表示されます
属性削除
URL
https://email.api.engagelab.cc/v1/marketing/lists/fields/{field_id}
https://email.api.engagelab.cc/v1/marketing/lists/fields/{field_id}
このコードブロックはフローティングウィンドウ内に表示されます
HTTPリクエストメソッド
DELETE
DELETE
このコードブロックはフローティングウィンドウ内に表示されます
Content-Type
application/x-www-form-urlencoded;charset=utf-8
application/x-www-form-urlencoded;charset=utf-8
このコードブロックはフローティングウィンドウ内に表示されます
リクエストヘッダー
| ヘッダー | タイプ | 必須 | 説明 |
|---|---|---|---|
| Authorization | string | true | Basic base64(api_user:api_key) |
リクエスト例
curl -X DELETE -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/fields/569
curl -X DELETE -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/fields/569
このコードブロックはフローティングウィンドウ内に表示されます
レスポンス例
Response-Success
HttpStatus: 200
{
"count": 1
}
{
"count": 1
}
このコードブロックはフローティングウィンドウ内に表示されます
Response-Error
{
"code": 30037,
"message": "delete failure"
}
{
"code": 30037,
"message": "delete failure"
}
このコードブロックはフローティングウィンドウ内に表示されます
属性更新
URL
https://email.api.engagelab.cc/v1/marketing/lists/fields/{field_id}
https://email.api.engagelab.cc/v1/marketing/lists/fields/{field_id}
このコードブロックはフローティングウィンドウ内に表示されます
HTTPリクエストメソッド
PUT
PUT
このコードブロックはフローティングウィンドウ内に表示されます
Content-Type
application/json; charset=utf-8
application/json; charset=utf-8
このコードブロックはフローティングウィンドウ内に表示されます
リクエストヘッダー
| ヘッダー | タイプ | 必須 | 説明 |
|---|---|---|---|
| Authorization | string | true | Basic base64(api_user:api_key) |
ボディパラメータ
| パラメータ | タイプ | 必須 | 説明 |
|---|---|---|---|
| field_name | string | true | フィールド名（最大64文字、a-z、A-Z、0-9、_のみで構成され、システム定義の属性文字列（大文字小文字を区別しない）ではない必要があります。システムフィールドEmail、Name、Phoneを含む合計50の属性フィールドを作成可能） |
| field_type | integer | true | フィールドタイプ（0: テキスト、1: 数値、2: 日付、3: 誕生日、4: ドロップダウン） |
| visible | boolean | true | 表示可否（trueまたはfalse） |
| format | string | false | データフォーマット： 0または.0または.00（fieldType=1の場合）； MM/DD/YYYYまたはDD/MM/YYYY（fieldType=2の場合）； MM/DDまたはDD/MM（fieldType=3の場合） |
| options | string[] | false | ドロップダウンタイプのリスト項目、field_typeがドロップダウンの場合は空にできず、最大10項目まで |
注意事項:
- システム属性: Email、Name、Phone、tag、campaign、segment、domain、createTime、updateTime、unsubscribeTime
リクエスト例
curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/fields/839 --data '{
"field_name": "xiao",
"field_type": 3,
"visible": true,
"format": "MM/DD"
}'
curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/fields/839 --data '{
"field_name": "xiao",
"field_type": 3,
"visible": true,
"format": "MM/DD"
}'
このコードブロックはフローティングウィンドウ内に表示されます
レスポンス例
Response-Success
HttpStatus: 200
{
"count": 1
}
{
"count": 1
}
このコードブロックはフローティングウィンドウ内に表示されます
Response-Error
{
"code": 30036,
"message": "not found"
}
{
"code": 30036,
"message": "not found"
}
このコードブロックはフローティングウィンドウ内に表示されます
属性リスト
URL
https://email.api.engagelab.cc/v1/marketing/lists/fields
https://email.api.engagelab.cc/v1/marketing/lists/fields
このコードブロックはフローティングウィンドウ内に表示されます
HTTPリクエストメソッド
GET
GET
このコードブロックはフローティングウィンドウ内に表示されます
Content-Type
application/x-www-form-urlencoded;charset=utf-8
application/x-www-form-urlencoded;charset=utf-8
このコードブロックはフローティングウィンドウ内に表示されます
リクエストヘッダー
| ヘッダー | タイプ | 必須 | 説明 |
|---|---|---|---|
| Authorization | string | true | Basic base64(api_user:api_key) |
クエリパラメータ
| パラメータ | タイプ | 必須 | 説明 |
|---|---|---|---|
| field_name | string | false | フィールド名、あいまい検索 |
リクエスト例
curl -X GET -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/fields?field_name=Age
curl -X GET -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/fields?field_name=Age
このコードブロックはフローティングウィンドウ内に表示されます
レスポンス説明
| パラメータ | タイプ | 説明 |
|---|---|---|
| result | array[object] | 属性リスト |
| field_name | string | フィールド名（最大64文字、a-z、A-Z、0-9、_のみで構成され、システム定義の属性文字列（大文字小文字を区別しない）ではない必要があります。システムフィールドEmail、Name、Phoneを含む合計50の属性フィールドを作成可能） |
| field_type | integer | フィールドタイプ（0: テキスト、1: 数値、2: 日付、3: 誕生日、4: ドロップダウン） |
| visible | boolean | 表示可否（trueまたはfalse） |
| format | string | データフォーマット： 0または.0または.00（fieldType=1の場合）； MM/DD/YYYYまたはDD/MM/YYYY（field_type=2の場合）； MM/DDまたはDD/MM（field_type=3の場合） |
| options | string[] | ドロップダウンタイプのリスト項目、field_typeがドロップダウンの場合は空にできず、最大10項目まで |
| field_id | integer | 属性の対応するidx、-1はシステム属性を示します |
| total | integer | クエリに一致するレコードの総数 |
| count | integer | クエリに一致するレコード数 |
レスポンス例
Response-Success
HttpStatus: 200
{
"result": [
{
"field_name": "Email",
"field_type": 0,
"visible": true,
"format": null,
"options": null,
"field_id": -1
},
{
"field_name": "Name",
"field_type": 0,
"visible": true,
"format": null,
"options": null,
"field_id": -1
},
{
"field_name": "Phone",
"field_type": 0,
"visible": true,
"format": null,
"options": null,
"field_id": -1
},
{
"field_name": "Gender",
"field_type": 0,
"visible": true,
"format": null,
"options": null,
"field_id": 0
},
{
"field_name": "Birthday",
"field_type": 3,
"visible": true,
"format": "MM/DD",
"options": null,
"field_id": 1
},
{
"field_name": "Age",
"field_type": 1,
"visible": true,
"format": "0",
"options": null,
"field_id": 2
},
{
"field_name": "remark",
"field_type": 0,
"visible": true,
"format": null,
"options": null,
"field_id": 3
}
],
"total": 7,
"count": 7
}
{
"result": [
{
"field_name": "Email",
"field_type": 0,
"visible": true,
"format": null,
"options": null,
"field_id": -1
},
{
"field_name": "Name",
"field_type": 0,
"visible": true,
"format": null,
"options": null,
"field_id": -1
},
{
"field_name": "Phone",
"field_type": 0,
"visible": true,
"format": null,
"options": null,
"field_id": -1
},
{
"field_name": "Gender",
"field_type": 0,
"visible": true,
"format": null,
"options": null,
"field_id": 0
},
{
"field_name": "Birthday",
"field_type": 3,
"visible": true,
"format": "MM/DD",
"options": null,
"field_id": 1
},
{
"field_name": "Age",
"field_type": 1,
"visible": true,
"format": "0",
"options": null,
"field_id": 2
},
{
"field_name": "remark",
"field_type": 0,
"visible": true,
"format": null,
"options": null,
"field_id": 3
}
],
"total": 7,
"count": 7
}
このコードブロックはフローティングウィンドウ内に表示されます
Response-Error
HTTP Status :401
{
"code": 30000,
"message": "Authentication failed"
}
{
"code": 30000,
"message": "Authentication failed"
}
このコードブロックはフローティングウィンドウ内に表示されます
