NAiOS IconNAiOS Logo
Contacto
Volver al catálogo

Postalytics

postalytics

Direct Mail Automation software in the cloud with deep integration to CRM and workflows, making direct mail look, act and feel like a digital marketing channel

Marketing AutomationDrip EmailsWeb del proveedor
Acciones
24
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 (24)

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.

Add AccountPOSTALYTICS_ADD_ACCOUNTAcción

Tool to create a new sub-account in the Postalytics system. Use when you need to create a new account with a unique ID associated with the requester's user ID as parent. The response includes the API key and user ID for the new account, which should be stored for future API calls.

Parámetros de entrada

  • phonestring

    The phone number associated with the account

  • companystring

    The company name associated with the account

  • passwordstringObligatorio

    The password associated with the account. Must follow password guidelines - minimum 8 characters including 1 uppercase letter, 1 lowercase letter, 1 number, and 1 special character

  • usernamestringObligatorio

    The username associated with the account - must be unique

  • last_namestringObligatorio

    The last name of the account holder

  • first_namestringObligatorio

    The first name of the account holder

  • address_zipstring

    The zip code associated with the account's address

  • address_citystring

    The city associated with the account's address

  • address_statestring

    The state associated with the account's address

  • email_addressstring

    The email address associated with the account

  • address_streetstring

    The street address associated with the account

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

Add ContactPOSTALYTICS_ADD_CONTACTAcción

Tool to add a contact to a specified contact list with their information. Use when you need to create a new contact or update an existing one on a contact list.

Parámetros de entrada

  • phonestring

    Phone number of the contact.

  • companystring

    Company name of the contact.

  • websitestring

    Website URL of the contact.

  • last_namestring

    Last name of the contact.

  • contact_idinteger

    The unique id of the contact. Required for updating but not required for inserting.

  • first_namestring

    First name of the contact.

  • occupationstring

    Occupation of the contact.

  • address_zipstring

    Zip/postal code for the contact address.

  • var_field_1string

    Custom variable field 1 for additional data.

  • var_field_2string

    Custom variable field 2 for additional data.

  • var_field_3string

    Custom variable field 3 for additional data.

  • var_field_4string

    Custom variable field 4 for additional data.

  • var_field_5string

    Custom variable field 5 for additional data.

  • var_field_6string

    Custom variable field 6 for additional data.

  • var_field_7string

    Custom variable field 7 for additional data.

  • var_field_8string

    Custom variable field 8 for additional data.

  • var_field_9string

    Custom variable field 9 for additional data.

  • address_citystring

    City for the contact address.

  • created_datestring

    The date and time when the contact was created (ISO 8601 format).

  • mobile_phonestring

    Mobile phone number of the contact.

  • var_field_10string

    Custom variable field 10 for additional data.

  • var_field_11string

    Custom variable field 11 for additional data.

  • var_field_12string

    Custom variable field 12 for additional data.

  • var_field_13string

    Custom variable field 13 for additional data.

  • var_field_14string

    Custom variable field 14 for additional data.

  • var_field_15string

    Custom variable field 15 for additional data.

  • var_field_16string

    Custom variable field 16 for additional data.

  • var_field_17string

    Custom variable field 17 for additional data.

  • var_field_18string

    Custom variable field 18 for additional data.

  • var_field_19string

    Custom variable field 19 for additional data.

  • var_field_20string

    Custom variable field 20 for additional data.

  • var_field_21string

    Custom variable field 21 for additional data.

  • var_field_22string

    Custom variable field 22 for additional data.

  • var_field_23string

    Custom variable field 23 for additional data.

  • var_field_24string

    Custom variable field 24 for additional data.

  • var_field_25string

    Custom variable field 25 for additional data.

  • var_field_26string

    Custom variable field 26 for additional data.

  • var_field_27string

    Custom variable field 27 for additional data.

  • var_field_28string

    Custom variable field 28 for additional data.

  • var_field_29string

    Custom variable field 29 for additional data.

  • var_field_30string

    Custom variable field 30 for additional data.

  • var_field_31string

    Custom variable field 31 for additional data.

  • var_field_32string

    Custom variable field 32 for additional data.

  • var_field_33string

    Custom variable field 33 for additional data.

  • var_field_34string

    Custom variable field 34 for additional data.

  • var_field_35string

    Custom variable field 35 for additional data.

  • address_statestring

    State for the contact address.

  • email_addressstring

    Email address of the contact.

  • address_streetstring

    Street address for the contact.

  • address_street2string

    Second line of street address for the contact.

  • contact_list_idintegerObligatorio

    The id of the contact list to add this contact to.

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

Tool to create a new direct mail campaign in Postalytics. Use when you need to start a new campaign with specified sender details and template. Important: A template must be created and proofed before creating the campaign.

Parámetros de entrada

  • SenderZipstringObligatorio

    The sender's postal code.

  • SenderCitystringObligatorio

    The sender's city.

  • SenderNamestringObligatorio

    The name of the campaign sender.

  • PostageTypeintegerObligatorio

    Postage type for the campaign. 0 for first class, 1 for standard mail.

  • SenderStatestringObligatorio

    The sender's state abbreviation (e.g., NY, CA).

  • CreditTypeIdintegerObligatorio

    Identifies media type. Valid values are 21-34, including postcards, letters, and bifolds in first class or standard mail.

  • SenderCountrystring

    The sender's country code. Defaults to 'US' if not specified.

  • DirectMailNamestringObligatorio

    The name of the direct mail campaign.

  • SenderAddress1stringObligatorio

    The sender's primary street address.

  • SenderAddress2string

    The sender's secondary address line (e.g., apartment, suite number).

  • TemplateFrontIdintegerObligatorio

    The ID of the template to use for the front of this campaign. Template must be created and proofed before campaign creation.

  • TemplateEnvelopeIdinteger

    Custom envelope ID for letter campaigns. Optional parameter only applicable to letter-type campaigns.

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

Tool to create a new suppression list that can be used in campaigns to suppress contacts from being sent mail. Use when you need to create an empty suppression list. Note that contacts must be added separately using the SuppressionListContact API after the list is created.

Parámetros de entrada

  • Namestring

    The name of the suppression list.

  • Countrystring

    The country associated with the suppression list (e.g., 'US', 'CA').

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 Suppression List ContactPOSTALYTICS_CREATE_SUPPRESSION_LIST_CONTACTAcción

Tool to create a new suppression contact on a specified suppression list. Use when you need to add a contact to a suppression list to prevent them from receiving mailings.

Parámetros de entrada

  • Zipstring

    Zip/postal code.

  • Citystring

    City.

  • Emailstring

    Email address of the contact.

  • Phonestring

    Phone number.

  • Statestring

    State.

  • Mobilestring

    Mobile phone number.

  • Addressstring

    Primary address line.

  • Companystring

    Company name.

  • Countrystring

    Country.

  • Websitestring

    Website URL.

  • list_idintegerObligatorio

    The id of the suppression list to add the contact to.

  • Address2string

    Secondary address line.

  • LastNamestring

    Last name of the contact.

  • FirstNamestring

    First name of the contact.

  • VarField1string

    Custom variable field 1.

  • VarField2string

    Custom variable field 2.

  • VarField3string

    Custom variable field 3.

  • VarField4string

    Custom variable field 4.

  • VarField5string

    Custom variable field 5.

  • VarField6string

    Custom variable field 6.

  • VarField7string

    Custom variable field 7.

  • VarField8string

    Custom variable field 8.

  • VarField9string

    Custom variable field 9.

  • Occupationstring

    Occupation.

  • VarField10string

    Custom variable field 10.

  • VarField11string

    Custom variable field 11.

  • VarField12string

    Custom variable field 12.

  • VarField13string

    Custom variable field 13.

  • VarField14string

    Custom variable field 14.

  • VarField15string

    Custom variable field 15.

  • VarField16string

    Custom variable field 16.

  • VarField17string

    Custom variable field 17.

  • VarField18string

    Custom variable field 18.

  • VarField19string

    Custom variable field 19.

  • VarField20string

    Custom variable field 20.

  • VarField21string

    Custom variable field 21.

  • VarField22string

    Custom variable field 22.

  • VarField23string

    Custom variable field 23.

  • VarField24string

    Custom variable field 24.

  • VarField25string

    Custom variable field 25.

  • VarField26string

    Custom variable field 26.

  • VarField27string

    Custom variable field 27.

  • VarField28string

    Custom variable field 28.

  • VarField29string

    Custom variable field 29.

  • VarField30string

    Custom variable field 30.

  • VarField31string

    Custom variable field 31.

  • VarField32string

    Custom variable field 32.

  • VarField33string

    Custom variable field 33.

  • VarField34string

    Custom variable field 34.

  • VarField35string

    Custom variable field 35.

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

Tool to create a new template with full HTML for postcard or letter. Use when you need to create a template by providing complete HTML markup or image URLs for front/back. The template can be used for various mail types including postcards, letters, and bifolds.

Parámetros de entrada

  • backstring

    URL for full-sized back image or letter content. Used when is_full_html is false.

  • htmlstringObligatorio

    Complete HTML markup for the template following Postalytics formatting standards.

  • namestringObligatorio

    Template identifier name (e.g., 'The Architect', 'Welcome Postcard').

  • sizestringObligatorio

    Template dimensions: '0'=letter, '1'=4x6 postcard, '2'=6x9 postcard, '3'=6x11 postcard, '6'=12x9 bifold, '7'=6x18 bifold.

  • countinteger

    Page count for letter templates. Default: 0.

  • frontstring

    URL for full-sized front image or letter content. Used when is_full_html is false.

  • is_proofedboolean

    Indicates proofing status; bypasses web app safeguards when true. Default: false.

  • font_familystring

    CSS font family designation (e.g., 'sans-serif', 'Arial').

  • is_full_htmlboolean

    Determines whether HTML is sent as complete markup (true) or as separate front/back images (false). Default: true.

  • is_double_sidedboolean

    Specifies double-sided letter configuration. Default: false.

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

Tool to create a new webhook to receive campaign event notifications from Postalytics. Use when you need to set up a webhook endpoint that will be notified about campaign events like sent, delivered, opened, or clicked.

Parámetros de entrada

  • urlstringObligatorio

    The destination URL that will receive webhook event notifications.

  • namestringObligatorio

    Human-readable name for the webhook to help identify it.

  • eventsstring[]Obligatorio

    List of campaign event types to subscribe to. Common events include 'sent', 'delivered', 'opened', 'clicked'.

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

Tool to delete a Postalytics account and all associated campaigns, templates, and lists. Use when you need to permanently remove a sub account or sub user account. Cannot delete parent accounts.

Parámetros de entrada

  • account_idintegerObligatorio

    The unique identifier of the account to delete. Only sub accounts and sub user accounts can be deleted. Cannot delete parent accounts.

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

Tool to delete a campaign from the system. Use when you need to remove a campaign that is no longer needed.

Parámetros de entrada

  • idintegerObligatorio

    Integer contains the Id of the campaign 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 Suppression ListPOSTALYTICS_DELETE_SUPPRESSION_LISTAcción

Tool to delete a specified suppression list. Use when you need to remove a suppression list that is no longer needed.

Parámetros de entrada

  • idintegerObligatorio

    The ID of the suppression list 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 Suppression List ContactPOSTALYTICS_DELETE_SUPPRESSION_LIST_CONTACTAcción

Tool to delete a specific contact from a suppression list. Use when you need to remove a contact from a suppression list in Postalytics.

Parámetros de entrada

  • list_idintegerObligatorio

    The ID of the suppression list

  • contact_idintegerObligatorio

    The ID of the contact to be deleted from the list

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 All Contact ListsPOSTALYTICS_GET_ALL_CONTACT_LISTSAcción

Tool to retrieve all contact lists for an account. Use when you need to get a complete list of contact lists including their IDs, names, item counts, and creation dates.

Parámetros de entrada

Sin parámetros.

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 All Contacts on a ListPOSTALYTICS_GET_ALL_CONTACTS_ON_A_LISTAcción

Tool to retrieve all contacts from a specified contact list with pagination support. Use when you need to get contacts from a list, with optional pagination using start offset and limit parameters.

Parámetros de entrada

  • limitinteger

    Maximum number of contacts to return per page. Controls pagination page size.

  • startinteger

    Pagination offset for retrieving contacts. Use 0 for the first page.

  • list_idintegerObligatorio

    The unique identifier of the contact list to retrieve contacts from.

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 All Drip CampaignsPOSTALYTICS_GET_ALL_DRIP_CAMPAIGNSAcción

Tool to retrieve all triggered drip campaign names and endpoint IDs in the account. Use when you need to list all available drip campaigns for the authenticated user.

Parámetros de entrada

Sin parámetros.

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

Tool to retrieve all flows for the requester's account. Use when you need to list or browse available flows.

Parámetros de entrada

Sin parámetros.

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

Tool to retrieve all webhooks configured for the authenticated account. Use when you need to view webhook configurations for campaigns.

Parámetros de entrada

Sin parámetros.

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

Tool to retrieve all Connect integrations configured for the authenticated user's account. Use when you need to view CRM or data source integrations.

Parámetros de entrada

Sin parámetros.

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

Tool to retrieve basic account information for the authenticated user. Use when you need to get account details such as contact information, address, or API key.

Parámetros de entrada

Sin parámetros.

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

Tool to get the details of a suppression list based on the id supplied. Use when you need to retrieve information about a specific suppression list.

Parámetros de entrada

  • idintegerObligatorio

    The id of the suppression list 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 Suppression List ContactPOSTALYTICS_GET_SUPPRESSION_LIST_CONTACTAcción

Tool to retrieve a specific contact from a suppression list. Use when you need to get details about a contact on a specific suppression list by their list ID and contact ID.

Parámetros de entrada

  • offsetinteger

    Offset for pagination

  • list_idintegerObligatorio

    The ID of the suppression list

  • contact_idintegerObligatorio

    The ID of the suppression list contact

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 Suppression List ContactsPOSTALYTICS_GET_SUPPRESSION_LIST_CONTACTSAcción

Tool to get all contacts on a specified suppression list. Use when you need to retrieve contacts that are suppressed for a particular list.

Parámetros de entrada

  • listIdintegerObligatorio

    The listId of the suppression list to get contacts for.

  • offsetinteger

    Offset count for paging through results.

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

Tool to retrieve all suppression lists for the authenticated user. Use when you need to view or manage suppression lists. Returns all lists or a specific list when ID is provided.

Parámetros de entrada

  • idinteger

    The identifier of a specific suppression list to retrieve. If not provided, all suppression lists will be returned.

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

Update AccountPOSTALYTICS_UPDATE_ACCOUNTAcción

Tool to update an existing account in the Postalytics system. Use when you need to modify account information such as contact details, address, or credentials for an existing account.

Parámetros de entrada

  • phonestring

    The phone number associated with the account

  • companystring

    The company name associated with the account

  • passwordstringObligatorio

    The password associated with the account. Must follow password guidelines - minimum 8 characters including 1 uppercase letter, 1 lowercase letter, 1 number, and 1 special character

  • usernamestringObligatorio

    The username associated with the account - must be unique

  • last_namestringObligatorio

    The last name of the account holder

  • account_idintegerObligatorio

    The unique identifier of the account to update

  • first_namestringObligatorio

    The first name of the account holder

  • address_zipstring

    The zip code associated with the account's address

  • address_citystring

    The city associated with the account's address

  • address_statestring

    The state associated with the account's address

  • email_addressstring

    The email address associated with the account

  • address_streetstring

    The street address associated with the account

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

Update Suppression List ContactPOSTALYTICS_UPDATE_SUPPRESSION_LIST_CONTACTAcción

Tool to update a suppression contact on the specified suppression list. Use when you need to modify contact information for a specific contact on a suppression list.

Parámetros de entrada

  • Zipstring

    Postal/ZIP code

  • Citystring

    City name

  • Emailstring

    Email address

  • Phonestring

    Phone number

  • Statestring

    State/Province

  • Mobilestring

    Mobile phone number

  • Addressstring

    Street address

  • Companystring

    Company name

  • Countrystring

    Country

  • Websitestring

    Website URL

  • list_idintegerObligatorio

    The id of the suppression list the contact is on

  • Address2string

    Additional address line

  • LastNamestring

    Last name

  • FirstNamestring

    First name

  • VarField1string

    Custom variable field 1

  • VarField2string

    Custom variable field 2

  • VarField3string

    Custom variable field 3

  • VarField4string

    Custom variable field 4

  • VarField5string

    Custom variable field 5

  • VarField6string

    Custom variable field 6

  • VarField7string

    Custom variable field 7

  • VarField8string

    Custom variable field 8

  • VarField9string

    Custom variable field 9

  • Occupationstring

    Occupation

  • VarField10string

    Custom variable field 10

  • VarField11string

    Custom variable field 11

  • VarField12string

    Custom variable field 12

  • VarField13string

    Custom variable field 13

  • VarField14string

    Custom variable field 14

  • VarField15string

    Custom variable field 15

  • VarField16string

    Custom variable field 16

  • VarField17string

    Custom variable field 17

  • VarField18string

    Custom variable field 18

  • VarField19string

    Custom variable field 19

  • VarField20string

    Custom variable field 20

  • VarField21string

    Custom variable field 21

  • VarField22string

    Custom variable field 22

  • VarField23string

    Custom variable field 23

  • VarField24string

    Custom variable field 24

  • VarField25string

    Custom variable field 25

  • VarField26string

    Custom variable field 26

  • VarField27string

    Custom variable field 27

  • VarField28string

    Custom variable field 28

  • VarField29string

    Custom variable field 29

  • VarField30string

    Custom variable field 30

  • VarField31string

    Custom variable field 31

  • VarField32string

    Custom variable field 32

  • VarField33string

    Custom variable field 33

  • VarField34string

    Custom variable field 34

  • VarField35string

    Custom variable field 35

  • contact_idintegerObligatorio

    The id of the contact to be updated

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