Many API endpoints allow you to submit the Entity ID for a table. The Entity ID is a unique, system-generated identifier for every table in your database. This value is not displayed within the application user interface anywhere, so to get the Entity ID for a table, you must retrieve it by means of the Table API endpoint.
To retrieve the Entity ID for a Messaging table:
Submit a request to the Table API endpoint. The simplest method is to use the version of the Table endpoint that allows you to retrieve table information based on the Table Name (see How to Find the Table Name if you need help finding the Table Name).
Within the API response message, the system provides the Entity ID for this table.
Sample Response:
{
"viewId": 1002,
"entityId": 100,
"displayName": "create_date",
"propId": 1030,
"columnName": "create_date"
}
To retrieve the Entity ID for an EDP table, you can also use the Table API endpoint. Use the method that returns all table information; this endpoint will return both Messaging and EDP tables. However, the response message doesn't explicity indicate which tables are from Messaging, and which are from EDP. If your tables have descriptive names, like "EDP Members," then this response message can be useful for identifying the Entity ID for an EDP table.
[
{
"viewId": 2444,
"viewName": "Order",
"entityId": 551,
"tableName": "order"
},
{
"viewId": 2445,
"viewName": "EDP Members",
"entityId": 552,
"tableName": "edp_members"
},
{
"viewId": 2380,
"viewName": "Recipient",
"entityId": 489,
"tableName": "recipient"
}
]
As another option for looking up the Entity ID for an EDP table, submit a GET request to the Email Campaign endpoint, and reference an existing EDP Campaign. The GET response will contain the Entity ID of the EDP table.