Postgrid
postgridPostGrid provides APIs for automating direct mail and address verification services, enabling businesses to send letters, postcards, and checks, as well as verify and standardize addresses in real-time.
Acciones disponibles (22)
Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.
CREATE_BANK_ACCOUNTPOSTGRID_CREATE_BANK_ACCOUNTAcciónTool to create a new bank account for print & mail service.
POSTGRID_CREATE_BANK_ACCOUNTAcciónTool to create a new bank account for print & mail service.
Parámetros de entrada
bankNamestringObligatorioName of the bank
accountTypestringObligatorioenumType of bank account
checkingsavingscontactEmailstringObligatorioContact email for the account
contactPhonestringContact phone number
accountNumberstringObligatorioBank account number
routingNumberstringObligatorio9-digit bank routing number
signatureTextstringSignature text
signatureImagestringURL or file path for signature image
bankCountryCodestringObligatorioCountry code (ISO 3166-1 alpha-2)
accountHolderNamestringObligatorioName of the bank account holder
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create ContactPOSTGRID_CREATE_CONTACTAcciónTool to create a new contact in postgrid. use after collecting contact's name, address, and optional metadata.
POSTGRID_CREATE_CONTACTAcciónTool to create a new contact in postgrid. use after collecting contact's name, address, and optional metadata.
Parámetros de entrada
citystringObligatorioCity name
emailstringEmail address
lastNamestringObligatorioLast name of the contact
metadataobjectCustom metadata as key-value pairs
firstNamestringObligatorioFirst name of the contact
countryCodestringObligatorioCountry ISO code
phoneNumberstringPhone number in E.164 format
postalOrZipstringObligatorioPostal or ZIP code
addressLine1stringObligatorioStreet address line 1
addressLine2stringStreet address line 2
organizationstringOrganization name
provinceOrStatestringObligatorioProvince or state
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create LetterPOSTGRID_CREATE_LETTERAcciónTool to create and send a letter via postgrid. use when recipient, sender, and content details are ready.
POSTGRID_CREATE_LETTERAcciónTool to create and send a letter via postgrid. use when recipient, sender, and content details are ready.
Parámetros de entrada
toobjectObligatorioRecipient's address details
pdfstringURL to a PDF file for the letter content. Required if html is not provided
htmlstringHTML content of the letter. Required if pdf is not provided
expressbooleanRequest express shipping
metadataobjectCustom metadata associated with the letter
descriptionstringDescription of the letter
from_addressobjectObligatorioSender's address details
mergeVariablesobjectKey-value pairs for merging data into the letter content
perforatedPageintegerPage number to be perforated
returnEnvelopebooleanInclude a return envelope
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create TemplatePOSTGRID_CREATE_TEMPLATEAcciónTool to create a new mail template in postgrid. use when you need to define reusable html content with dynamic placeholders. use after confirming required template details.
POSTGRID_CREATE_TEMPLATEAcciónTool to create a new mail template in postgrid. use when you need to define reusable html content with dynamic placeholders. use after confirming required template details.
Parámetros de entrada
htmlstringObligatorioHTML content of the template (supports Handlebars/Mustache syntax)
namestringObligatorioName of the template
descriptionstringDescription of the template
testRenderModelobjectData model used for testing the template rendering
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create WebhookPOSTGRID_CREATE_WEBHOOKAcciónTool to create a new webhook to receive order event notifications. use after configuring your endpoint to handle webhook payloads.
POSTGRID_CREATE_WEBHOOKAcciónTool to create a new webhook to receive order event notifications. use after configuring your endpoint to handle webhook payloads.
Parámetros de entrada
urlstringObligatorioThe URL where webhook payloads will be sent.
enabledEventsstring[]ObligatorioList of events that trigger the webhook. Possible values include: 'letter.created', 'letter.updated', 'postcard.created', 'postcard.updated', 'cheque.created', 'cheque.updated', 'self_mailer.created', 'self_mailer.updated', 'return_envelope_order.created', 'return_envelope_order.updated'.
payloadFormatstringenumFormat of the webhook payload: 'jwt' (signed) or 'json' (plain JSON). Defaults to 'jwt'.
jwtjson
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Bank AccountPOSTGRID_DELETE_BANK_ACCOUNTAcciónTool to delete a bank account by its id. use when you need to remove a bank account after confirming its identifier.
POSTGRID_DELETE_BANK_ACCOUNTAcciónTool to delete a bank account by its id. use when you need to remove a bank account after confirming its identifier.
Parámetros de entrada
idstringObligatorioUnique identifier of the bank account to delete
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete ContactPOSTGRID_DELETE_CONTACTAcciónTool to delete a contact by its id. use when you need to remove obsolete contacts after confirming their identifier.
POSTGRID_DELETE_CONTACTAcciónTool to delete a contact by its id. use when you need to remove obsolete contacts after confirming their identifier.
Parámetros de entrada
idstringObligatorioUnique identifier of the contact to delete
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete TemplatePOSTGRID_DELETE_TEMPLATEAcciónTool to delete a template by its id. use when you need to remove an existing template after confirming its identifier.
POSTGRID_DELETE_TEMPLATEAcciónTool to delete a template by its id. use when you need to remove an existing template after confirming its identifier.
Parámetros de entrada
idstringObligatorioUnique identifier of the template to delete
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete WebhookPOSTGRID_DELETE_WEBHOOKAcciónTool to delete a webhook subscription. use when you need to remove an existing webhook by its id.
POSTGRID_DELETE_WEBHOOKAcciónTool to delete a webhook subscription. use when you need to remove an existing webhook by its id.
Parámetros de entrada
idstringObligatorioUnique identifier of the webhook to delete
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Bank AccountPOSTGRID_GET_BANK_ACCOUNTAcciónTool to retrieve a bank account. use after obtaining the bank account id to fetch its details.
POSTGRID_GET_BANK_ACCOUNTAcciónTool to retrieve a bank account. use after obtaining the bank account id to fetch its details.
Parámetros de entrada
idstringObligatorioUnique identifier of the bank account to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get ContactPOSTGRID_GET_CONTACTAcciónTool to retrieve a contact. use after obtaining the contact id to fetch its details.
POSTGRID_GET_CONTACTAcciónTool to retrieve a contact. use after obtaining the contact id to fetch its details.
Parámetros de entrada
idstringObligatorioUnique identifier of the contact to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get LetterPOSTGRID_GET_LETTERAcciónTool to retrieve a letter. use after you have the letter id to fetch its details.
POSTGRID_GET_LETTERAcciónTool to retrieve a letter. use after you have the letter id to fetch its details.
Parámetros de entrada
idstringObligatorioUnique identifier of the letter to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get TemplatePOSTGRID_GET_TEMPLATEAcciónTool to retrieve a template. use when you have the template id and need its details.
POSTGRID_GET_TEMPLATEAcciónTool to retrieve a template. use when you have the template id and need its details.
Parámetros de entrada
idstringObligatorioUnique identifier of the template to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get WebhookPOSTGRID_GET_WEBHOOKAcciónTool to retrieve details of a specific webhook by its id. use after creating a webhook to fetch its configuration and status.
POSTGRID_GET_WEBHOOKAcciónTool to retrieve details of a specific webhook by its id. use after creating a webhook to fetch its configuration and status.
Parámetros de entrada
idstringObligatorioUnique identifier of the webhook to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Bank AccountsPOSTGRID_LIST_BANK_ACCOUNTSAcciónTool to list bank accounts. use when retrieving bank accounts with optional status filter and pagination.
POSTGRID_LIST_BANK_ACCOUNTSAcciónTool to list bank accounts. use when retrieving bank accounts with optional status filter and pagination.
Parámetros de entrada
afterstringCursor for pagination to fetch records after a specific ID
limitintegerMaximum number of bank accounts to return (default 10, max 100)
beforestringCursor for pagination to fetch records before a specific ID
statusstringenumFilter bank accounts by status
activeinactive
Parámetros de salida
dataobject[]ObligatorioList of bank account objects.
errorstringError if any occurred during the execution of the action
objectstringObligatorioResponse object type, should be 'list'.
successfulbooleanObligatorioWhether or not the action execution was successful or not
next_cursorstringCursor for the next page of results, if any.
previous_cursorstringCursor for the previous page of results, if any.
List ChequesPOSTGRID_LIST_CHEQUESAcciónTool to list cheques with optional filters and pagination. use when you need to retrieve batches of cheque records for processing or reporting.
POSTGRID_LIST_CHEQUESAcciónTool to list cheques with optional filters and pagination. use when you need to retrieve batches of cheque records for processing or reporting.
Parámetros de entrada
afterstringCursor for pagination. Fetch items after this cursor.
countintegerNumber of items to return per page. Maximum is 100.
statusstringenumFilter by cheque status.
createdmailedfailedto_datestringISO-8601 timestamp. Only return cheques created before this time.
from_datestringISO-8601 timestamp. Only return cheques created after this time.
Parámetros de salida
dataobject[]ObligatorioList of Cheque objects
nextstringCursor for next page of results
errorstringError if any occurred during the execution of the action
objectstringObligatorioResponse object type, should be 'list'
previousstringCursor for previous page of results
successfulbooleanObligatorioWhether or not the action execution was successful or not
List ContactsPOSTGRID_LIST_CONTACTSAcciónTool to list contacts. use when you need to retrieve a paginated list of contacts with optional filters like date range, metadata, name, or email.
POSTGRID_LIST_CONTACTSAcciónTool to list contacts. use when you need to retrieve a paginated list of contacts with optional filters like date range, metadata, name, or email.
Parámetros de entrada
afterstringCursor for pagination to fetch records after this cursor
emailstringFilter by contact email address
limitintegerMaximum number of contacts to return per page (1-100)
to_datestringFilter contacts created on or before this ISO8601 timestamp
metadataobjectFilter by metadata key-value pairs
from_datestringFilter contacts created on or after this ISO8601 timestamp
contact_namestringFilter by contact's full or partial name
Parámetros de salida
dataobject[]ObligatorioList of contact objects
errorstringError if any occurred during the execution of the action
objectstringObligatorioResponse object type, should be 'list'
successfulbooleanObligatorioWhether or not the action execution was successful or not
next_cursorstringCursor for the next page of results
prev_cursorstringCursor for the previous page of results
total_countintegerObligatorioTotal number of contacts matching query
List LettersPOSTGRID_LIST_LETTERSAcciónTool to list letters. use when retrieving letters with optional filters and pagination.
POSTGRID_LIST_LETTERSAcciónTool to list letters. use when retrieving letters with optional filters and pagination.
Parámetros de entrada
afterstringCursor for pagination to fetch records created after a specific ID
limitintegerMaximum number of records to return (default 10, max 100)
beforestringCursor for pagination to fetch records created before a specific ID
statusstringenumFilter letters by status
draftsubmittedprocesseddate_tostringFilter letters created on or before this date (ISO 8601)
date_fromstringFilter letters created on or after this date (ISO 8601)
Parámetros de salida
dataobject[]ObligatorioList of letter objects
errorstringError if any occurred during the execution of the action
objectstringObligatorioResponse object type, should be 'list'
next_urlstringURL to fetch the next set of results
successfulbooleanObligatorioWhether or not the action execution was successful or not
previous_urlstringURL to fetch the previous set of results
List PostcardsPOSTGRID_LIST_POSTCARDSAcciónTool to retrieve a list of postcards with optional filtering and pagination. use when you need to browse or filter postcards list.
POSTGRID_LIST_POSTCARDSAcciónTool to retrieve a list of postcards with optional filtering and pagination. use when you need to browse or filter postcards list.
Parámetros de entrada
skipintegerNumber of records to skip (offset).
limitintegerNumber of records per page (1-100).
statusstringenumFilter by postcard status.
draftqueuedprocessingcompletedfailedto_datestringReturn postcards created before this ISO8601 timestamp.
metadataobjectFilter by custom metadata key-value pairs.
from_datestringReturn postcards created after this ISO8601 timestamp.
contact_idstringFilter by the contact's unique ID.
Parámetros de salida
dataobject[]ObligatorioList of postcard objects.
skipintegerObligatorioNumber of records skipped (offset).
errorstringError if any occurred during the execution of the action
limitintegerObligatorioNumber of records requested per page.
objectstringObligatorioType of the response object, should be 'list'.
next_urlstringURL for the next page of results, if any.
successfulbooleanObligatorioWhether or not the action execution was successful or not
previous_urlstringURL for the previous page of results, if any.
List Self-MailersPOSTGRID_LIST_SELF_MAILERSAcciónTool to list self-mailers. use when you need to fetch self-mailers with filters and pagination.
POSTGRID_LIST_SELF_MAILERSAcciónTool to list self-mailers. use when you need to fetch self-mailers with filters and pagination.
Parámetros de entrada
countintegerLimit number of items returned
offsetintegerNumber of items to skip before starting to collect result set
statusstringFilter by status (e.g., 'draft', 'queued', 'processing')
to_datestringFilter self-mailers created on or before this ISO 8601 timestamp (inclusive)
metadataobjectKey-value metadata pairs to filter self-mailers
from_datestringFilter self-mailers created on or after this ISO 8601 timestamp (inclusive)
Parámetros de salida
urlstringObligatorioAPI endpoint that was called
dataobject[]ObligatorioList of self-mailer objects
countintegerObligatorioNumber of results returned in this call
errorstringError if any occurred during the execution of the action
objectstringObligatorioFixed value: 'list'
offsetintegerObligatorioNumber of resources skipped
next_urlstringURL for the next page of results
successfulbooleanObligatorioWhether or not the action execution was successful or not
total_countintegerObligatorioTotal number of matching resources
previous_urlstringURL for the previous page of results
List TemplatesPOSTGRID_LIST_TEMPLATESAcciónTool to list templates. use when you need to retrieve a paginated list of templates with optional type filtering.
POSTGRID_LIST_TEMPLATESAcciónTool to list templates. use when you need to retrieve a paginated list of templates with optional type filtering.
Parámetros de entrada
pageintegerPage number for pagination, must be >= 1
typestringFilter templates by type (e.g., 'letter', 'postcard')
limitintegerNumber of results per page, must be >= 1
Parámetros de salida
dataobject[]ObligatorioList of template objects
metaobjectObligatorioPagination metadata for the templates
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List WebhooksPOSTGRID_LIST_WEBHOOKSAcciónTool to retrieve a list of configured webhooks with optional filtering and pagination. use when you need to view your webhooks.
POSTGRID_LIST_WEBHOOKSAcciónTool to retrieve a list of configured webhooks with optional filtering and pagination. use when you need to view your webhooks.
Parámetros de entrada
pageintegerPage number of results to retrieve, must be >= 1.
eventstringFilter webhooks by event type, e.g., 'letter.created'.
limitintegerNumber of results per page, must be >= 1.
target_urlstringFilter webhooks by the target URL.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not