NAiOS IconNAiOS Logo
Contacto
Volver al catálogo

Postgrid

postgrid

PostGrid 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.

Developer ToolsWeb del proveedor
Acciones
22
Triggers
0
Autenticación
—
OAuth gestionado
No
Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

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ón

Tool to create a new bank account for print & mail service.

Parámetros de entrada

  • bankNamestringObligatorio

    Name of the bank

  • accountTypestringObligatorioenum

    Type of bank account

    checkingsavings
  • contactEmailstringObligatorio

    Contact email for the account

  • contactPhonestring

    Contact phone number

  • accountNumberstringObligatorio

    Bank account number

  • routingNumberstringObligatorio

    9-digit bank routing number

  • signatureTextstring

    Signature text

  • signatureImagestring

    URL or file path for signature image

  • bankCountryCodestringObligatorio

    Country code (ISO 3166-1 alpha-2)

  • accountHolderNamestringObligatorio

    Name of the bank account holder

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create ContactPOSTGRID_CREATE_CONTACTAcción

Tool to create a new contact in postgrid. use after collecting contact's name, address, and optional metadata.

Parámetros de entrada

  • citystringObligatorio

    City name

  • emailstring

    Email address

  • lastNamestringObligatorio

    Last name of the contact

  • metadataobject

    Custom metadata as key-value pairs

  • firstNamestringObligatorio

    First name of the contact

  • countryCodestringObligatorio

    Country ISO code

  • phoneNumberstring

    Phone number in E.164 format

  • postalOrZipstringObligatorio

    Postal or ZIP code

  • addressLine1stringObligatorio

    Street address line 1

  • addressLine2string

    Street address line 2

  • organizationstring

    Organization name

  • provinceOrStatestringObligatorio

    Province or state

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create LetterPOSTGRID_CREATE_LETTERAcción

Tool to create and send a letter via postgrid. use when recipient, sender, and content details are ready.

Parámetros de entrada

  • toobjectObligatorio

    Recipient's address details

  • pdfstring

    URL to a PDF file for the letter content. Required if html is not provided

  • htmlstring

    HTML content of the letter. Required if pdf is not provided

  • expressboolean

    Request express shipping

  • metadataobject

    Custom metadata associated with the letter

  • descriptionstring

    Description of the letter

  • from_addressobjectObligatorio

    Sender's address details

  • mergeVariablesobject

    Key-value pairs for merging data into the letter content

  • perforatedPageinteger

    Page number to be perforated

  • returnEnvelopeboolean

    Include a return envelope

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create TemplatePOSTGRID_CREATE_TEMPLATEAcción

Tool 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

  • htmlstringObligatorio

    HTML content of the template (supports Handlebars/Mustache syntax)

  • namestringObligatorio

    Name of the template

  • descriptionstring

    Description of the template

  • testRenderModelobject

    Data model used for testing the template rendering

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create WebhookPOSTGRID_CREATE_WEBHOOKAcción

Tool to create a new webhook to receive order event notifications. use after configuring your endpoint to handle webhook payloads.

Parámetros de entrada

  • urlstringObligatorio

    The URL where webhook payloads will be sent.

  • enabledEventsstring[]Obligatorio

    List 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'.

  • payloadFormatstringenum

    Format of the webhook payload: 'jwt' (signed) or 'json' (plain JSON). Defaults to 'jwt'.

    jwtjson

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete Bank AccountPOSTGRID_DELETE_BANK_ACCOUNTAcción

Tool 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

  • idstringObligatorio

    Unique identifier of the bank account to delete

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete ContactPOSTGRID_DELETE_CONTACTAcción

Tool to delete a contact by its id. use when you need to remove obsolete contacts after confirming their identifier.

Parámetros de entrada

  • idstringObligatorio

    Unique identifier of the contact to delete

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete TemplatePOSTGRID_DELETE_TEMPLATEAcción

Tool to delete a template by its id. use when you need to remove an existing template after confirming its identifier.

Parámetros de entrada

  • idstringObligatorio

    Unique identifier of the template to delete

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete WebhookPOSTGRID_DELETE_WEBHOOKAcción

Tool to delete a webhook subscription. use when you need to remove an existing webhook by its id.

Parámetros de entrada

  • idstringObligatorio

    Unique identifier of the webhook to delete

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Bank AccountPOSTGRID_GET_BANK_ACCOUNTAcción

Tool to retrieve a bank account. use after obtaining the bank account id to fetch its details.

Parámetros de entrada

  • idstringObligatorio

    Unique identifier of the bank account to retrieve

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get ContactPOSTGRID_GET_CONTACTAcción

Tool to retrieve a contact. use after obtaining the contact id to fetch its details.

Parámetros de entrada

  • idstringObligatorio

    Unique identifier of the contact to retrieve

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get LetterPOSTGRID_GET_LETTERAcción

Tool to retrieve a letter. use after you have the letter id to fetch its details.

Parámetros de entrada

  • idstringObligatorio

    Unique identifier of the letter to retrieve

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get TemplatePOSTGRID_GET_TEMPLATEAcción

Tool to retrieve a template. use when you have the template id and need its details.

Parámetros de entrada

  • idstringObligatorio

    Unique identifier of the template to retrieve

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get WebhookPOSTGRID_GET_WEBHOOKAcción

Tool 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

  • idstringObligatorio

    Unique identifier of the webhook to retrieve

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Bank AccountsPOSTGRID_LIST_BANK_ACCOUNTSAcción

Tool to list bank accounts. use when retrieving bank accounts with optional status filter and pagination.

Parámetros de entrada

  • afterstring

    Cursor for pagination to fetch records after a specific ID

  • limitinteger

    Maximum number of bank accounts to return (default 10, max 100)

  • beforestring

    Cursor for pagination to fetch records before a specific ID

  • statusstringenum

    Filter bank accounts by status

    activeinactive

Parámetros de salida

  • dataobject[]Obligatorio

    List of bank account objects.

  • errorstring

    Error if any occurred during the execution of the action

  • objectstringObligatorio

    Response object type, should be 'list'.

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

  • next_cursorstring

    Cursor for the next page of results, if any.

  • previous_cursorstring

    Cursor for the previous page of results, if any.

List ChequesPOSTGRID_LIST_CHEQUESAcción

Tool 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

  • afterstring

    Cursor for pagination. Fetch items after this cursor.

  • countinteger

    Number of items to return per page. Maximum is 100.

  • statusstringenum

    Filter by cheque status.

    createdmailedfailed
  • to_datestring

    ISO-8601 timestamp. Only return cheques created before this time.

  • from_datestring

    ISO-8601 timestamp. Only return cheques created after this time.

Parámetros de salida

  • dataobject[]Obligatorio

    List of Cheque objects

  • nextstring

    Cursor for next page of results

  • errorstring

    Error if any occurred during the execution of the action

  • objectstringObligatorio

    Response object type, should be 'list'

  • previousstring

    Cursor for previous page of results

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List ContactsPOSTGRID_LIST_CONTACTSAcción

Tool 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

  • afterstring

    Cursor for pagination to fetch records after this cursor

  • emailstring

    Filter by contact email address

  • limitinteger

    Maximum number of contacts to return per page (1-100)

  • to_datestring

    Filter contacts created on or before this ISO8601 timestamp

  • metadataobject

    Filter by metadata key-value pairs

  • from_datestring

    Filter contacts created on or after this ISO8601 timestamp

  • contact_namestring

    Filter by contact's full or partial name

Parámetros de salida

  • dataobject[]Obligatorio

    List of contact objects

  • errorstring

    Error if any occurred during the execution of the action

  • objectstringObligatorio

    Response object type, should be 'list'

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

  • next_cursorstring

    Cursor for the next page of results

  • prev_cursorstring

    Cursor for the previous page of results

  • total_countintegerObligatorio

    Total number of contacts matching query

List LettersPOSTGRID_LIST_LETTERSAcción

Tool to list letters. use when retrieving letters with optional filters and pagination.

Parámetros de entrada

  • afterstring

    Cursor for pagination to fetch records created after a specific ID

  • limitinteger

    Maximum number of records to return (default 10, max 100)

  • beforestring

    Cursor for pagination to fetch records created before a specific ID

  • statusstringenum

    Filter letters by status

    draftsubmittedprocessed
  • date_tostring

    Filter letters created on or before this date (ISO 8601)

  • date_fromstring

    Filter letters created on or after this date (ISO 8601)

Parámetros de salida

  • dataobject[]Obligatorio

    List of letter objects

  • errorstring

    Error if any occurred during the execution of the action

  • objectstringObligatorio

    Response object type, should be 'list'

  • next_urlstring

    URL to fetch the next set of results

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

  • previous_urlstring

    URL to fetch the previous set of results

List PostcardsPOSTGRID_LIST_POSTCARDSAcción

Tool 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

  • skipinteger

    Number of records to skip (offset).

  • limitinteger

    Number of records per page (1-100).

  • statusstringenum

    Filter by postcard status.

    draftqueuedprocessingcompletedfailed
  • to_datestring

    Return postcards created before this ISO8601 timestamp.

  • metadataobject

    Filter by custom metadata key-value pairs.

  • from_datestring

    Return postcards created after this ISO8601 timestamp.

  • contact_idstring

    Filter by the contact's unique ID.

Parámetros de salida

  • dataobject[]Obligatorio

    List of postcard objects.

  • skipintegerObligatorio

    Number of records skipped (offset).

  • errorstring

    Error if any occurred during the execution of the action

  • limitintegerObligatorio

    Number of records requested per page.

  • objectstringObligatorio

    Type of the response object, should be 'list'.

  • next_urlstring

    URL for the next page of results, if any.

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

  • previous_urlstring

    URL for the previous page of results, if any.

List Self-MailersPOSTGRID_LIST_SELF_MAILERSAcción

Tool to list self-mailers. use when you need to fetch self-mailers with filters and pagination.

Parámetros de entrada

  • countinteger

    Limit number of items returned

  • offsetinteger

    Number of items to skip before starting to collect result set

  • statusstring

    Filter by status (e.g., 'draft', 'queued', 'processing')

  • to_datestring

    Filter self-mailers created on or before this ISO 8601 timestamp (inclusive)

  • metadataobject

    Key-value metadata pairs to filter self-mailers

  • from_datestring

    Filter self-mailers created on or after this ISO 8601 timestamp (inclusive)

Parámetros de salida

  • urlstringObligatorio

    API endpoint that was called

  • dataobject[]Obligatorio

    List of self-mailer objects

  • countintegerObligatorio

    Number of results returned in this call

  • errorstring

    Error if any occurred during the execution of the action

  • objectstringObligatorio

    Fixed value: 'list'

  • offsetintegerObligatorio

    Number of resources skipped

  • next_urlstring

    URL for the next page of results

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

  • total_countintegerObligatorio

    Total number of matching resources

  • previous_urlstring

    URL for the previous page of results

List TemplatesPOSTGRID_LIST_TEMPLATESAcción

Tool to list templates. use when you need to retrieve a paginated list of templates with optional type filtering.

Parámetros de entrada

  • pageinteger

    Page number for pagination, must be >= 1

  • typestring

    Filter templates by type (e.g., 'letter', 'postcard')

  • limitinteger

    Number of results per page, must be >= 1

Parámetros de salida

  • dataobject[]Obligatorio

    List of template objects

  • metaobjectObligatorio

    Pagination metadata for the templates

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List WebhooksPOSTGRID_LIST_WEBHOOKSAcción

Tool to retrieve a list of configured webhooks with optional filtering and pagination. use when you need to view your webhooks.

Parámetros de entrada

  • pageinteger

    Page number of results to retrieve, must be >= 1.

  • eventstring

    Filter webhooks by event type, e.g., 'letter.created'.

  • limitinteger

    Number of results per page, must be >= 1.

  • target_urlstring

    Filter webhooks by the target URL.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not