Download OpenAPI specification:Download
{- "version": "string",
- "customFields": [
- {
- "key": "string",
- "type": "NUMBER",
- "description": "string",
- "lastSeenDateTime": "string"
}
]
}Create Custom Field
k1_integration_api) | key | string |
| type | string (CustomFieldType.CustomFieldType) Enum: "NUMBER" "BOOLEAN" "STRING" "DATE" |
| description | string |
{- "key": "string",
- "type": "NUMBER",
- "description": "string"
}{- "version": "string",
- "customField": {
- "key": "string"
}
}Get Custom Field
k1_integration_api) | key required | string |
{- "version": "string",
- "customField": {
- "key": "string",
- "type": "NUMBER",
- "description": "string",
- "lastSeenDateTime": "string"
}
}Delete Custom Field
k1_integration_api) | key required | string |
{- "version": "string",
- "customField": {
- "key": "string"
}
}{- "version": "string",
- "lists": [
- {
- "id": "string",
- "type": "DEVICE_ID",
- "name": "string",
- "description": "string"
}
]
}Create List
k1_integration_api) | type | string (ListType.ListType) Enum: "DEVICE_ID" "USER_IP_ADDRESS" "PAYMENT_TOKEN" "PHYSICAL_ADDRESS" "DEVICE_COUNTRY" "TEXT" |
| name | string |
| description | string |
{- "type": "DEVICE_ID",
- "name": "string",
- "description": "string"
}{- "version": "string",
- "list": {
- "id": "string"
}
}Delete List
k1_integration_api) | id required | string |
{- "version": "string",
- "list": {
- "id": "string"
}
}Create Entry
k1_integration_api) | listId required | string |
| note | string |
| deviceCountry | string |
| deviceId | string |
| paymentToken | string |
object (k360_policy_manager.v1.PhysicalAddress) | |
| text | string |
| userIpAddress | string |
{- "note": "string",
- "deviceCountry": "string",
- "deviceId": "string",
- "paymentToken": "string",
- "physicalAddress": {
- "line1": "string",
- "line2": "string",
- "city": "string",
- "region": "string",
- "postalCode": "string",
- "countryCode": "string",
- "addressType": "BILLING_ADDRESS"
}, - "text": "string",
- "userIpAddress": "string"
}{- "version": "string",
- "entry": {
- "id": "string"
}
}List Entries
k1_integration_api) | listId required | string |
| pageSize | integer <int32> |
| pageToken | string |
{- "version": "string",
- "list": {
- "id": "string",
- "type": "DEVICE_ID",
- "name": "string",
- "description": "string",
- "entries": [
- {
- "id": "string",
- "note": "string",
- "author": {
- "id": "string",
- "name": "string"
}, - "addedDateTime": "string",
- "deviceCountry": "string",
- "deviceId": "string",
- "paymentToken": "string",
- "physicalAddress": {
- "line1": "string",
- "line2": "string",
- "city": "string",
- "region": "string",
- "postalCode": "string",
- "countryCode": "string",
- "addressType": "BILLING_ADDRESS"
}, - "text": "string",
- "userIpAddress": "string"
}
]
}, - "nextPageToken": "string"
}Get Entry
k1_integration_api) | listId required | string |
| id required | string |
{- "version": "string",
- "entry": {
- "id": "string",
- "note": "string",
- "author": {
- "id": "string",
- "name": "string"
}, - "addedDateTime": "string",
- "deviceCountry": "string",
- "deviceId": "string",
- "paymentToken": "string",
- "physicalAddress": {
- "line1": "string",
- "line2": "string",
- "city": "string",
- "region": "string",
- "postalCode": "string",
- "countryCode": "string",
- "addressType": "BILLING_ADDRESS"
}, - "text": "string",
- "userIpAddress": "string"
}
}Delete Entry
k1_integration_api) | listId required | string |
| id required | string |
{- "version": "string",
- "entry": {
- "id": "string"
}
}Batch Create Entries
k1_integration_api) | listId required | string |
Array of objects (BatchCreateEntriesRequest.CreateEntryInput) |
{- "entries": [
- {
- "note": "string",
- "deviceCountry": "string",
- "deviceId": "string",
- "paymentToken": "string",
- "physicalAddress": {
- "line1": "string",
- "line2": "string",
- "city": "string",
- "region": "string",
- "postalCode": "string",
- "countryCode": "string",
- "addressType": "BILLING_ADDRESS"
}, - "text": "string",
- "userIpAddress": "string"
}
]
}{- "version": "string",
- "results": [
- {
- "id": "string",
- "status": 0,
- "message": "string",
- "errorCode": "string",
- "entry": {
- "note": "string",
- "deviceCountry": "string",
- "deviceId": "string",
- "paymentToken": "string",
- "physicalAddress": {
- "line1": "string",
- "line2": "string",
- "city": "string",
- "region": "string",
- "postalCode": "string",
- "countryCode": "string",
- "addressType": "BILLING_ADDRESS"
}, - "text": "string",
- "userIpAddress": "string"
}
}
], - "summary": {
- "totalProcessed": 0,
- "successCount": 0,
- "failureCount": 0
}
}Batch Delete Entries
k1_integration_api) | listId required | string |
| entryIds | Array of strings |
Array of objects (k360_policy_manager.v1.EntryValue) |
{- "entryIds": [
- "string"
], - "entryValues": [
- {
- "deviceCountry": "string",
- "deviceId": "string",
- "paymentToken": "string",
- "physicalAddress": {
- "line1": "string",
- "line2": "string",
- "city": "string",
- "region": "string",
- "postalCode": "string",
- "countryCode": "string",
- "addressType": "BILLING_ADDRESS"
}, - "text": "string",
- "userIpAddress": "string"
}
]
}{- "version": "string",
- "results": [
- {
- "id": "string",
- "status": 0,
- "message": "string",
- "errorCode": "string"
}
], - "summary": {
- "totalProcessed": 0,
- "successCount": 0,
- "failureCount": 0
}
}Batch Create Entries
k1_integration_api) | listId required | string |
Array of objects (BatchCreateEntriesRequest.CreateEntryInput) |
{- "entries": [
- {
- "note": "string",
- "deviceCountry": "string",
- "deviceId": "string",
- "paymentToken": "string",
- "physicalAddress": {
- "line1": "string",
- "line2": "string",
- "city": "string",
- "region": "string",
- "postalCode": "string",
- "countryCode": "string",
- "addressType": "BILLING_ADDRESS"
}, - "text": "string",
- "userIpAddress": "string"
}
]
}{- "version": "string",
- "results": [
- {
- "id": "string",
- "status": 0,
- "message": "string",
- "errorCode": "string",
- "entry": {
- "note": "string",
- "deviceCountry": "string",
- "deviceId": "string",
- "paymentToken": "string",
- "physicalAddress": {
- "line1": "string",
- "line2": "string",
- "city": "string",
- "region": "string",
- "postalCode": "string",
- "countryCode": "string",
- "addressType": "BILLING_ADDRESS"
}, - "text": "string",
- "userIpAddress": "string"
}
}
], - "summary": {
- "totalProcessed": 0,
- "successCount": 0,
- "failureCount": 0
}
}Batch Delete Entries
k1_integration_api) | listId required | string |
| entryIds | Array of strings |
Array of objects (k360_policy_manager.v1.EntryValue) |
{- "entryIds": [
- "string"
], - "entryValues": [
- {
- "deviceCountry": "string",
- "deviceId": "string",
- "paymentToken": "string",
- "physicalAddress": {
- "line1": "string",
- "line2": "string",
- "city": "string",
- "region": "string",
- "postalCode": "string",
- "countryCode": "string",
- "addressType": "BILLING_ADDRESS"
}, - "text": "string",
- "userIpAddress": "string"
}
]
}{- "version": "string",
- "results": [
- {
- "id": "string",
- "status": 0,
- "message": "string",
- "errorCode": "string"
}
], - "summary": {
- "totalProcessed": 0,
- "successCount": 0,
- "failureCount": 0
}
}