SendGrid · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Twilio SendGrid Legacy Marketing Campaigns Contacts…
16 actions
16 updates
phrasing
extends
openapi/sendgrid-recipients-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for SendGrid's API. It is a proposal applied on top of the contract, not a document SendGrid publishes.
What the actions change
x-apievangelist-phrasing
Targets 16
$.info
$.paths['/v3/contactdb/recipients'].get
$.paths['/v3/contactdb/recipients'].post
$.paths['/v3/contactdb/recipients'].delete
$.paths['/v3/contactdb/recipients'].patch
$.paths['/v3/contactdb/recipients/{recipient_id}'].get
$.paths['/v3/contactdb/recipients/{recipient_id}'].delete
$.paths['/v3/contactdb/recipients/{recipient_id}/lists'].get
$.paths['/v3/contactdb/recipients/billable_count'].get
$.paths['/v3/contactdb/recipients/count'].get
$.paths['/v3/contactdb/recipients/search'].get
$.paths['/v3/contactdb/recipients/search'].post
$.paths['/v3/contactdb/status'].get
$.paths['/v3/contactdb/exports'].get
$.paths['/v3/contactdb/exports'].post
$.paths['/v3/contactdb/exports/{id}'].get
OpenAPI Overlay
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Twilio SendGrid Legacy Marketing Campaigns Contacts…
version: 1.0.0
extends: openapi/sendgrid-recipients-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-24'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 15
- target: $.paths['/v3/contactdb/recipients'].get
update:
x-apievangelist-phrasing:
intent: List legacy contact database recipients
effect: read
questions:
- How do I page through all my legacy Marketing Campaigns recipients?
- Why might I get an empty page of recipients before reaching the end?
instructions:
- text: List my recipients, page {page} with {page_size} per page.
slots:
page: query.page
page_size: query.page_size
- text: Show all recipients in my legacy contact database.
method: generated
generated: '2026-09-24'
- target: $.paths['/v3/contactdb/recipients'].post
update:
x-apievangelist-phrasing:
intent: Add recipients to the contact database
effect: write
questions:
- Can I add new recipients with custom field data to the legacy contact database?
- What is the rate limit when adding recipients?
instructions:
- text: Add a new recipient to my legacy contact database.
- text: Create recipients with their custom field values in the contactdb.
method: generated
generated: '2026-09-24'
- target: $.paths['/v3/contactdb/recipients'].delete
update:
x-apievangelist-phrasing:
intent: Delete several recipients at once
effect: destructive
questions:
- Can I bulk delete recipients by sending an array of their IDs?
- What does the request need to remove many recipients in one call?
instructions:
- text: Bulk delete a batch of recipients by their IDs.
- text: Remove multiple recipients from my contact database in one request.
method: generated
generated: '2026-09-24'
- target: $.paths['/v3/contactdb/recipients'].patch
update:
x-apievangelist-phrasing:
intent: Update one or more recipients
effect: write
questions:
- How can I change custom field data on existing recipients?
- Can I update several recipients in the same request?
instructions:
- text: Update the custom fields on these existing recipients.
- text: Patch a batch of recipient records with new details.
method: generated
generated: '2026-09-24'
- target: $.paths['/v3/contactdb/recipients/{recipient_id}'].get
update:
x-apievangelist-phrasing:
intent: Get a single recipient
effect: read
questions:
- What details are stored for one recipient in my contact database?
- Can I pull up a specific recipient by their ID?
instructions:
- text: Get recipient {recipient_id}.
slots:
recipient_id: path.recipient_id
- text: Show the stored details for recipient ID {recipient_id}.
slots:
recipient_id: path.recipient_id
method: generated
generated: '2026-09-24'
- target: $.paths['/v3/contactdb/recipients/{recipient_id}'].delete
update:
x-apievangelist-phrasing:
intent: Permanently delete one recipient
effect: destructive
questions:
- How do I permanently remove one person from all lists and segments, for example for a privacy request?
- Does deleting a single recipient also take them off every segment?
instructions:
- text: Permanently delete recipient {recipient_id}.
slots:
recipient_id: path.recipient_id
- text: Remove recipient {recipient_id} from all my lists and segments.
slots:
recipient_id: path.recipient_id
method: generated
generated: '2026-09-24'
- target: $.paths['/v3/contactdb/recipients/{recipient_id}/lists'].get
update:
x-apievangelist-phrasing:
intent: See which lists a recipient belongs to
effect: read
questions:
- Which lists is a particular recipient on?
- Can one recipient be on many lists, and how do I see them all?
instructions:
- text: Show the lists that recipient {recipient_id} has been added to.
slots:
recipient_id: path.recipient_id
- text: List every contact list containing recipient {recipient_id}.
slots:
recipient_id: path.recipient_id
method: generated
generated: '2026-09-24'
- target: $.paths['/v3/contactdb/recipients/billable_count'].get
update:
x-apievangelist-phrasing:
intent: Get the billable recipient count
effect: read
questions:
- How many Marketing Campaigns recipients am I being billed for?
- Is billing based on my highest recipient count at one time?
instructions:
- text: Get my billable recipient count.
- text: Tell me how many recipients count toward my Marketing Campaigns bill.
method: generated
generated: '2026-09-24'
- target: $.paths['/v3/contactdb/recipients/count'].get
update:
x-apievangelist-phrasing:
intent: Count all recipients
effect: read
questions:
- What is the total number of recipients in my legacy contact database?
- How many recipients do I currently have overall?
instructions:
- text: Count all of my Marketing Campaigns recipients.
- text: Give me the total recipient count.
method: generated
generated: '2026-09-24'
- target: $.paths['/v3/contactdb/recipients/search'].get
update:
x-apievangelist-phrasing:
intent: Search recipients by a field value
effect: read
questions:
- Can I find recipients by the value of a custom field like first_name or a date field?
- Which kinds of recipient fields can I search with a simple query string?
instructions:
- text: Find recipients whose field value is {field_name}.
slots:
field_name: query.{field_name}
- text: Search recipients where a custom field equals {field_name} using the query-string search.
slots:
field_name: query.{field_name}
method: generated
generated: '2026-09-24'
- target: $.paths['/v3/contactdb/recipients/search'].post
update:
x-apievangelist-phrasing:
intent: Search recipients with segment conditions
effect: read
questions:
- Can I test segment conditions against recipients without creating a segment?
- Which operators can I use in recipient search conditions?
instructions:
- text: Search list {list_id} for recipients matching conditions {conditions}.
slots:
list_id: requestBody.list_id
conditions: requestBody.conditions
- text: Run segment conditions {conditions} against list {list_id} without saving a segment.
slots:
conditions: requestBody.conditions
list_id: requestBody.list_id
method: generated
generated: '2026-09-24'
- target: $.paths['/v3/contactdb/status'].get
update:
x-apievangelist-phrasing:
intent: Check recipient upload status
effect: read
questions:
- Are my recipient uploads still processing?
- Where do I check the upload status for Marketing Campaigns recipients?
instructions:
- text: Check my recipient upload status.
- text: Tell me whether recipient uploads have finished processing.
method: generated
generated: '2026-09-24'
- target: $.paths['/v3/contactdb/exports'].get
update:
x-apievangelist-phrasing:
intent: List recipient export jobs
effect: read
questions:
- Which recipient exports are running or recently completed?
- Can I see the export type and status of every recipient export job?
instructions:
- text: List all of my recipient export jobs.
- text: Show recipient exports that are in flight or recently done.
method: generated
generated: '2026-09-24'
- target: $.paths['/v3/contactdb/exports'].post
update:
x-apievangelist-phrasing:
intent: Export recipients from lists or segments
effect: write
questions:
- How do I export recipients from a list or segment to a file?
- Can I be emailed a link when a recipient export is ready?
instructions:
- text: Export recipients in lists {list_ids} as {file_type}.
slots:
list_ids: requestBody.list_ids
file_type: requestBody.file_type
- text: Start a recipient export for segments {segment_ids} capped at {max_file_size} MB per file.
slots:
segment_ids: requestBody.segment_ids
max_file_size: requestBody.max_file_size
method: generated
generated: '2026-09-24'
- target: $.paths['/v3/contactdb/exports/{id}'].get
update:
x-apievangelist-phrasing:
intent: Check a recipient export's status
effect: read
questions:
- Has my recipient export finished, and where do I download it?
- What is the current status of one recipient export job?
instructions:
- text: Check the status of recipient export {id}.
slots:
id: path.id
- text: Get the download URLs for recipient export {id}.
slots:
id: path.id
method: generated
generated: '2026-09-24'