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ónTool to add a new custom domain for creating custom links. Use when you need to register a domain for short link customization.
LOB_CREATE_DOMAINAcciónTool 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
domainstringObligatorioThe registered domain/hostname.
error_redirect_linkstringObligatorioURL to redirect customers if a short link is broken or inactive.
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 LinkLOB_CREATE_LINKAcciónTool 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.
LOB_CREATE_LINKAcciónTool 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
slugstringThe unique path for the shortened URL. If empty, a unique path will be automatically generated.
titlestringThe title of the URL.
domainstringThe registered domain to be used for the short URL. Defaults to 'lob.st'.
metadataobjectUse 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_linkstringObligatorioThe original target URL to be shortened.
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 DomainLOB_DELETE_DOMAINAcciónTool to delete a registered domain. Use only after confirming all associated links with the domain are deleted.
LOB_DELETE_DOMAINAcciónTool to delete a registered domain. Use only after confirming all associated links with the domain are deleted.
Parámetros de entrada
domain_idstringObligatorioUnique identifier for a domain.
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 LinkLOB_DELETE_LINKAcciónTool to delete a shortened link. Use when you need to remove a previously created short link from the system.
LOB_DELETE_LINKAcciónTool to delete a shortened link. Use when you need to remove a previously created short link from the system.
Parámetros de entrada
link_idstringObligatorioUnique identifier for a link.
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 UploadLOB_DELETE_UPLOADAcciónTool to delete an existing upload by its unique identifier. Use when you need to permanently remove an upload and its associated data.
LOB_DELETE_UPLOADAcciónTool 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_idstringObligatorioUnique 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
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 DomainLOB_GET_DOMAINAcciónTool 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.
LOB_GET_DOMAINAcciónTool 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_idstringObligatorioUnique identifier for a domain.
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 LinkLOB_GET_LINKAcciónTool to retrieve a single shortened link. Use when you need to fetch details about a specific link by its ID.
LOB_GET_LINKAcciónTool 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_idstringObligatorioUnique identifier for a link.
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 DomainsLOB_LIST_DOMAINSAcciónTool 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.
LOB_LIST_DOMAINSAcciónTool 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
afterstringA reference to a list entry used for paginating to the next set of entries. Cannot be used with 'before'.
limitintegerHow many results to return. Maximum of 100 results per request.
beforestringA reference to a list entry used for paginating to the previous set of entries. Cannot be used with 'after'.
statusstringenumStatus of domain configuration.
configurednot_configured
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 Shortened LinksLOB_LIST_LINKSAcciónTool 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.
LOB_LIST_LINKSAcciónTool 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
afterstringCursor for pagination. Retrieve results after this cursor. Cannot be used with 'before'.
limitintegerHow many results to return. Default is 10.
beforestringCursor for pagination. Retrieve results before this cursor. Cannot be used with 'after'.
domain_idstringFilters links by the provided domain id.
campaign_idstringFilters 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
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 QR Code AnalyticsLOB_LIST_QR_CODE_ANALYTICSAcciónTool 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.
LOB_LIST_QR_CODE_ANALYTICSAcciónTool 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
limitintegerHow many results to return.
offsetintegerAn 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"].
scannedbooleanFilter list of responses to only include QR codes with at least one scan event.
date_createdobjectFilter 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
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 UploadsLOB_LIST_UPLOADSAcciónTool to list uploads from Lob. Use when you need to retrieve all uploads or filter uploads by campaign ID.
LOB_LIST_UPLOADSAcciónTool to list uploads from Lob. Use when you need to retrieve all uploads or filter uploads by campaign ID.
Parámetros de entrada
campaignIdstringID of the campaign to filter uploads by. If provided, only returns uploads associated with this campaign.
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
Update LinkLOB_UPDATE_LINKAcciónTool 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.
LOB_UPDATE_LINKAcciónTool 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
titlestringThe title of the URL. Useful for organizing and identifying links.
link_idstringObligatorioUnique identifier for the link to update. Must be a valid link ID prefixed with 'lnk_'.
metadataobjectUse 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_linkstringObligatorioThe original target URL to redirect to when the shortened link is accessed.
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
Validate IdentityLOB_VALIDATE_IDENTITYAcciónTool 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.
LOB_VALIDATE_IDENTITYAcciónTool 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
citystringCity name
statestringState abbreviation (2 characters)
zip_codestringZIP code (5 or 9 digits)
recipientstringObligatorioFull name of the recipient to validate against the address
primary_linestringObligatorioPrimary address line (street address)
secondary_linestringSecondary address line (apartment, suite, etc.)
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