SendGrid Marketing Campaigns Custom Fields API is a SendGrid API connector for creating and managing custom contact fields for email segmentation and personalization.
Provided free and as is, without warranty of any kind — including merchantability, fitness for a particular purpose, and the accuracy or completeness of any result. See the licence. You are responsible for checking what this produces before relying on it.
emailmarketing-emailsendgrid
Sendgrid Mc Custom Fields V3
SendGrid Marketing Campaigns Custom Fields API is a SendGrid API connector for creating and managing custom contact fields for email segmentation and personalization.
Base URL: https://api.sendgrid.com
Auth: bearer (pass your key via the apiKey input)
Operations
listfielddefinition — GET /v3/marketing/field_definitions — Get All Field Definitions
createfielddefinition — POST /v3/marketing/field_definitions — Create Custom Field Definition
deletefielddefinition — DELETE /v3/marketing/field_definitions/{custom_field_id} — Delete Custom Field Definition
updatefielddefinition — PATCH /v3/marketing/field_definitions/{custom_field_id} — Update Custom Field Definition
Inputs
apiKey — your sendgrid-mc-custom-fields-v3 API key
operation — one of the operations above
path parameters when an operation's path contains {...}
query — optional JSON object of query params
body — JSON object for create/update ops
Example
operation: listfielddefinition
apiKey: <your key>
Publishes
The keys a later task may reference as {{taskName.key}}. Referencing anything not listed here resolves to nothing at run time.
error
operation
result
status
Input Properties
Every property this tool accepts, from its own tool.iml.
Property
Type
Required
Default
Description
apiKey
string
yes
—
DEPRECATED — bind an API Key credential to the task with credentialName instead. A key pasted here is stored in the workflow definition in clear and appears in every export of it. Still honoured for workflows built before the change.
operation
string
yes
—
One of: listfielddefinition, createfielddefinition, deletefielddefinition, updatefielddefinition
custom_field_id
string
no
—
Path parameter custom_field_id (required by some operations).
body
string
no
—
Request body as a JSON object string (for create/update operations).
query
string
no
—
Query-string parameters as a JSON object string, e.g. {"limit": 50}. Parsed and url-encoded onto the request.