Recipients
The SendGrid table Recipients.
Table Specific Information
SendGrid has the ability to categorize Recipients with filters defined by the user. Accordingly, you can execute statements to the Recipients table to search by and insert these filters. However, these filters are reported as attributes of the Custom Fields table.
Select
The following query retrieves only the default fields of the Recipients table, not the Custom Fields that you have created. To retrieve the values of the Custom Fields of a Recipient, query the Custom Fields table.
You can also retrieve all Recipients inside a certain List or a Segment, but it is not possible to filter by both. Use multiple queries instead:
SELECT * FROM Recipients WHERE SegmentId = '1' SELECT * FROM Recipients WHERE ListId = '2'
You can build criteria depending on a Custom Field. When querying use quotations regardless of type.This kind of filtering is done client side. In this case Age is a CustomField created by the user.
SELECT * FROM Recipients WHERE Age = '30'
Insert
To insert into Recipients Email is required.
You can insert Custom Fields into the Recipients table. See the CustomFields section for more information about how to create custom fields.
INSERT INTO Recipients (Email, FirstName, LastName, Age, Department ... Other Custom Fields as necessary) VALUES ('[email protected]', 'name', 'surname', '30', 'Education' ... Other Custom Field values)
Update
You can only update from this table by specifying an Id. Additionally, the Email column cannot be updated.
UPDATE Recipients SET Age = '12' WHERE Id = '1'
Delete
You can only delete from this table by specifying an Id.
DELETE FROM Recipients WHERE Id = '1'
Columns
Name | Type | ReadOnly | References | Description |
Id [KEY] | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
SegmentId | Int32 | False |
This column is dynamic and maps to the corresponding field in the API. | |
ListId | Int32 | False |
This column is dynamic and maps to the corresponding field in the API. | |
String | False |
This column is dynamic and maps to the corresponding field in the API. | ||
FirstName | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
LastName | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
CreatedAt | Datetime | True |
This column is dynamic and maps to the corresponding field in the API. | |
LastClicked | Datetime | True |
This column is dynamic and maps to the corresponding field in the API. | |
LastEmailed | Datetime | False |
This column is dynamic and maps to the corresponding field in the API. | |
LastOpened | Datetime | True |
This column is dynamic and maps to the corresponding field in the API. | |
UpdatedAt | Datetime | True |
This column is dynamic and maps to the corresponding field in the API. | |
Age | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
Department | String | False |
This column is dynamic and maps to the corresponding field in the API. | |
University | String | False |
This column is dynamic and maps to the corresponding field in the API. |