NAiOS IconNAiOS Logo
Contacto
Volver al catálogo

Lob

lob

Direct Mail Automation and Address Verification APIs

Marketing AutomationWeb del proveedor
Acciones
13
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 (13)

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

Tool to add a new custom domain for creating custom links. Use when you need to register a domain for short link customization.

Parámetros de entrada

  • domainstringObligatorio

    The registered domain/hostname.

  • error_redirect_linkstringObligatorio

    URL to redirect customers if a short link is broken or inactive.

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

Tool to create a shortened URL from a long URL using Lob's link shortening service. Use when you need to shorten a long URL either by using a custom domain or Lob's own short domain.

Parámetros de entrada

  • slugstring

    The unique path for the shortened URL. If empty, a unique path will be automatically generated.

  • titlestring

    The title of the URL.

  • domainstring

    The registered domain to be used for the short URL. Defaults to 'lob.st'.

  • metadataobject

    Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `"` and `\`.

  • redirect_linkstringObligatorio

    The original target URL to be shortened.

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

Tool to delete a registered domain. Use only after confirming all associated links with the domain are deleted.

Parámetros de entrada

  • domain_idstringObligatorio

    Unique identifier for a domain.

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

Tool to delete a shortened link. Use when you need to remove a previously created short link from the system.

Parámetros de entrada

  • link_idstringObligatorio

    Unique identifier for a link.

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

Tool to delete an existing upload by its unique identifier. Use when you need to permanently remove an upload and its associated data.

Parámetros de entrada

  • upl_idstringObligatorio

    Unique identifier of the upload to delete. Format: 'upl_' followed by alphanumeric characters (e.g., 'upl_test'). This permanently deletes the upload and its associated data.

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

Tool to retrieve details for a single domain from Lob. Use when you need to get configuration status, redirect links, or other metadata for a specific domain.

Parámetros de entrada

  • domain_idstringObligatorio

    Unique identifier for a domain.

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

Tool to retrieve a single shortened link. Use when you need to fetch details about a specific link by its ID.

Parámetros de entrada

  • link_idstringObligatorio

    Unique identifier for a link.

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

Tool to retrieve a list of all created domains. Use when you need to view or manage custom domains configured for URL shortening. Supports pagination and filtering by configuration status.

Parámetros de entrada

  • afterstring

    A reference to a list entry used for paginating to the next set of entries. Cannot be used with 'before'.

  • limitinteger

    How many results to return. Maximum of 100 results per request.

  • beforestring

    A reference to a list entry used for paginating to the previous set of entries. Cannot be used with 'after'.

  • statusstringenum

    Status of domain configuration.

    configurednot_configured

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

Tool to retrieve a list of shortened links. The list is sorted by creation date, with the most recently created appearing first. Use when you need to view all links or filter by campaign or domain.

Parámetros de entrada

  • afterstring

    Cursor for pagination. Retrieve results after this cursor. Cannot be used with 'before'.

  • limitinteger

    How many results to return. Default is 10.

  • beforestring

    Cursor for pagination. Retrieve results before this cursor. Cannot be used with 'after'.

  • domain_idstring

    Filters links by the provided domain id.

  • campaign_idstring

    Filters resources created by the provided campaign id, prefixed with 'cmp_'. In the case of snap packs, booklets, and letters with size 'us_legal', however, the campaign id is prefixed with 'camp_' instead of 'cmp_'.

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 QR Code AnalyticsLOB_LIST_QR_CODE_ANALYTICSAcción

Tool to retrieve a list of your QR codes and their analytics data. The QR codes are returned sorted by scan date, with the most recently scanned QR codes appearing first.

Parámetros de entrada

  • limitinteger

    How many results to return.

  • offsetinteger

    An integer that designates the offset at which to begin returning results. Defaults to 0.

  • includestring[]

    Request that the response include the total count by specifying include=["total_count"].

  • scannedboolean

    Filter list of responses to only include QR codes with at least one scan event.

  • date_createdobject

    Filter by date created. Accepted formats are ISO-8601 date or datetime, e.g. { "gt": "2012-01-01", "lt": "2012-01-31T12:34:56Z" } where "gt" is >, "lt" is <, "gte" is ≥, and "lte" is ≤.

  • resource_idsstring[]

    Filter by the resource ID.

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

Tool to list uploads from Lob. Use when you need to retrieve all uploads or filter uploads by campaign ID.

Parámetros de entrada

  • campaignIdstring

    ID of the campaign to filter uploads by. If provided, only returns uploads associated with this campaign.

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

Tool to update any properties of a shortened link. Use when you need to modify the redirect URL, title, or metadata of an existing Lob shortened link. Requires the link_id and at least the redirect_link to update.

Parámetros de entrada

  • titlestring

    The title of the URL. Useful for organizing and identifying links.

  • link_idstringObligatorio

    Unique identifier for the link to update. Must be a valid link ID prefixed with 'lnk_'.

  • metadataobject

    Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters '"' and '\'. Example: {'customer_id': 'NEWYORK2015'}. Nested objects are not supported.

  • redirect_linkstringObligatorio

    The original target URL to redirect to when the shortened link is accessed.

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

Validate IdentityLOB_VALIDATE_IDENTITYAcción

Tool to validate whether a given name is associated with an address. Use when you need to verify identity information by checking if a recipient name matches address records.

Parámetros de entrada

  • citystring

    City name

  • statestring

    State abbreviation (2 characters)

  • zip_codestring

    ZIP code (5 or 9 digits)

  • recipientstringObligatorio

    Full name of the recipient to validate against the address

  • primary_linestringObligatorio

    Primary address line (street address)

  • secondary_linestring

    Secondary address line (apartment, suite, etc.)

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