Lob U R L Shortener API
The U R L Shortener API from Lob — 2 operation(s) for u r l shortener.
OpenAPI Specification
openapi: 3.0.3
info:
title: Lob U R L Shortener API
version: 1.20.2
description: "Experience direct mail like never before, with unmatched personalization and scalability \x14 all in one intuitive platform."
license:
name: MIT
url: https://mit-license.org/
contact:
name: Lob Developer Experience
url: https://support.lob.com/
email: lob-openapi@lob.com
termsOfService: https://www.lob.com/legal
servers:
- url: https://api.lob.com/v1
description: production
security:
- basicAuth: []
tags:
- name: U R L Shortener
paths:
/domains/{domain_id}:
parameters:
- in: path
name: domain_id
required: true
description: Unique identifier for a domain.
schema:
type: string
get:
operationId: domain_get
summary: Retrieve a domain
description: Retrieve details for a single domain.
tags:
- U R L Shortener
responses:
'200':
description: Returns domain related details.
content:
application/json:
schema:
$ref: '#/components/schemas/domain_response'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/error'
x-codeSamples:
- lang: Shell
source: "curl -X GET \"https://api.lob.com/v1/domains/{domain_id}\" \\\n -u <YOUR_LIVE_API_KEY>:\n"
label: CURL
- lang: Typescript
source: "try {\n const domain = await new DomainsApi(config).get('xxxxxx');\n} catch (err: any) {\n console.error(err);\n}\n"
label: TYPESCRIPT
- lang: Javascript
source: "Lob.domains.retrieve('xxxxxx', function (err, res) {\n console.log(err, res);\n});\n"
label: NODE
- lang: Ruby
source: "domainsAPI = DomainsApi.new(config)\n\nbegin\n retrievedDomain = domainsAPI.get(\"xxxxxx\")\nrescue => err\n p err.message\nend\n"
label: RUBY
- lang: Python
source: "with ApiClient(configuration) as api_client:\n api = DomainsApi(api_client)\n\ntry:\n domain = api.get(\"xxxxxx\")\nexcept ApiException as e:\n print(e)\n"
label: PYTHON
- lang: PHP
source: "$apiInstance = new OpenAPI\\Client\\Api\\DomainsApi($config, new GuzzleHttp\\Client());\n\ntry {\n $result = $apiInstance->get(\"xxxxxx\");\n} catch (Exception $e) {\n echo $e->getMessage(), PHP_EOL;\n}\n"
- lang: Java
source: "DomainsApi apiInstance = new DomainsApi(config);\n\ntry {\n Domain response = apiInstance.get(\"xxxxxx\");\n} catch (ApiException e) {\n e.printStackTrace();\n}\n"
label: JAVA
- lang: Elixir
source: 'Lob.Domain.retrieve("xxxxxx")
'
label: ELIXIR
- lang: CSharp
source: "DomainsApi api = new DomainsApi(config);\n\ntry {\n Domain response = api.get(\"xxxxxx\");\n} catch (ApiException e) {\n Console.WriteLine(e.ToString());\n}\n"
label: CSHARP
- lang: Go
source: "var context = context.Background()\ncontext = context.WithValue(suite.ctx, lob.ContextBasicAuth, lob.BasicAuth{UserName: os.Getenv(\"<YOUR_API_KEY>\")})\n\nvar apiClient = *lob.NewAPIClient(configuration)\n\nfetchedDomain, _, err := apiClient.DomainsApi.Get(context,\"xxxxxx\").Execute()\n\nif err != nil {\n return err\n}\n"
label: GO
delete:
operationId: domain_delete
summary: Delete a Domain
description: Delete a registered domain. This operation can only be performed if all associated links with the domain are deleted.
tags:
- U R L Shortener
responses:
'200':
description: Returns the deleted link object.
content:
application/json:
schema:
$ref: '#/components/schemas/domain_delete'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/error'
/links/{link_id}:
parameters:
- in: path
name: link_id
required: true
description: Unique identifier for a link.
schema:
type: string
get:
operationId: links_get
summary: Retrieve a link
description: Retrieves a single shortened link.
tags:
- U R L Shortener
responses:
'200':
description: Returns a single link.
content:
application/json:
schema:
$ref: '#/components/schemas/link_response'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/error'
x-codeSamples:
- lang: Shell
source: "curl -X GET \"https://api.lob.com/v1/links/<link_id>\" \\\n -u <YOUR_LIVE_API_KEY>:\n"
label: CURL
patch:
operationId: link_update
summary: Update a Link
description: Update any of the properties of a shortened link.
tags:
- U R L Shortener
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/link_update'
examples:
basic:
value:
resource_id: ltr_133
test:
value:
redirect_link: ltr_133
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/link_update'
examples:
basic:
value:
resource_id: ltr_133
test:
value:
resource_id: ltr_133
multipart/form-data:
schema:
$ref: '#/components/schemas/link_update'
examples:
basic:
value:
resource_id: ltr_133
test:
value:
resource_id: ltr_133
responses:
'200':
description: Returns the updated link.
content:
application/json:
schema:
$ref: '#/components/schemas/link_response'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/error'
example:
error:
code: invalid
message: redirect_link is required
status_code: 422
x-codeSamples:
- lang: Shell
source: "curl https://api.lob.com/v1/links/<link_id> \\\n -u <YOUR_LIVE_API_KEY>: \\\n -d \"redirect_link=https://www.lob.com\"\n"
label: CURL
delete:
operationId: links_delete
summary: Delete Link
description: Delete the shortened link.
tags:
- U R L Shortener
responses:
'200':
description: Returns the deleted short link object
content:
application/json:
schema:
$ref: '#/components/schemas/link_delete_response'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/error'
components:
schemas:
domain_delete:
type: object
properties:
id:
description: Unique identifier for a domain.
type: string
deleted:
description: Only returned if the domain was successfully deleted.
type: boolean
link_response:
type: object
properties:
id:
description: Unique identifier prefixed with `lnk_`.
type: string
title:
description: The title of the URL.
type: string
domain_id:
description: A unique identifier for the registered domain.
type: string
redirect_link:
$ref: '#/components/schemas/redirect_link'
short_link:
description: The shortened URL for the associated original URL.
type: string
metadata:
$ref: '#/components/schemas/metadata'
created_at:
description: The date and time the link was created.
type: string
updated_at:
description: The date and time the link was last updated.
type: string
error:
type: object
description: Lob uses RESTful HTTP response codes to indicate success or failure of an API request. In general, 2xx indicates success, 4xx indicate an input error, and 5xx indicates an error on Lob's end.
required:
- error
properties:
error:
type: object
required:
- message
- status_code
- code
properties:
message:
type: string
description: A human-readable message with more details about the error
example: Rate limit exceeded. Please wait 5 seconds and try your request again.
status_code:
$ref: '#/components/schemas/failure_status_code'
code:
type: string
enum:
- bad_request
- conflict
- feature_limit_reached
- internal_server_error
- invalid
- not_deletable
- not_found
- request_timeout
- service_unavailable
- unrecognized_endpoint
- unsupported_lob_version
- address_length_exceeds_limit
- bank_account_already_verified
- bank_error
- billing_address_required
- custom_envelope_inventory_depleted
- deleted_bank_account
- failed_deliverability_strictness
- file_pages_below_min
- file_pages_exceed_max
- file_size_exceeds_limit
- foreign_return_address
- inconsistent_page_dimensions
- invalid_bank_account
- invalid_bank_account_verification
- invalid_check_international
- invalid_country_covid
- invalid_file
- invalid_file_dimensions
- invalid_file_download_time
- invalid_file_url
- invalid_image_dpi
- invalid_international_feature
- invalid_perforation_return_envelope
- invalid_template_html
- mail_use_type_can_not_be_null
- merge_variable_required
- merge_variable_whitespace
- payment_method_unverified
- pdf_encrypted
- special_characters_restricted
- unembedded_fonts
- email_required
- invalid_api_key
- publishable_key_not_allowed
- rate_limit_exceeded
- unauthorized
- unauthorized_token
description: 'A pre-defined string identifying an error. Error codes fall into three categories:
**GENERIC**
* `bad_request` - 422: an invalid request was made. See error message for details.
* `conflict` - 409/422: this operation would leave data in a conflicted state.
* `feature_limit_reached` - 403: the account has reached its resource limit and requires upgrading to add more.
* `internal_server_error` - 500: an error has occured on Lob''s servers. Please try request again.
* `invalid` - 422: an invalid request was made. See error message for details.
* `not_deletable` - 422: an attempt was made to delete a resource, but the resource cannot be deleted.
* `not_found` - 404: the requested resource was not found.
* `request_timeout` - 408: the request took too long. Please try again.
* `service_unavailable` - 503: the Lob servers are temporarily unavailable. Please try agian.
* `unrecognized_endpoint` - 404: the requested endpoint doesn''t exist.
* `unsupported_lob_version` - 422: an unsupported Lob API version was requested.
**ADVANCED**
* `address_length_exceeds_limit` - 422: the sum of to.address_line1 and to.address_line2 cannot surpass 50 characters.
* `bank_account_already_verified` - 422: the bank account has already been verified.
* `bank_error` - 422: there''s an issue with the bank account.
* `billing_address_required` - 403: in order to create a live mail piece, your account needs to set up a billing address.
* `custom_envelope_inventory_depleted` - 422: custom envelope inventory is depleted, and more will need to be ordered.
* `deleted_bank_account` - 404: checks cannot be created with a deleted bank account.
* `failed_deliverability_strictness` - 422: the `to` address doesn''t meet strictness requirements. See <a href="https://dashboard.lob.com/#/settings/account" target="_blank">Account Settings</a> to configure strictness.
* `file_pages_below_min` - 422: not enough pages.
* `file_pages_exceed_max` - 422: too many pages.
* `file_size_exceeds_limit` - 422: the file size is too large. See description for details.
* `foreign_return_address` - 422: the `from` address must be a US address.
* `inconsistent_page_dimensions` - 422: all pages of the input file must have the same dimensions.
* `invalid_bank_account` - 422: the provided bank routing number is invalid.
* `invalid_bank_account_verification` - 422: verification amounts do not match.
* `invalid_check_international` - 422: checks cannot be sent internationally.
* `invalid_country_covid` - 422: the postal service in the specified country is currently unable to process the request due to COVID-19 restrictions.
* `invalid_file` - 422: the file is invalid.
* `invalid_file_dimensions` - 422: file dimensions are incorrect for the selected mail type.
* `invalid_file_download_time` - 422: file download from remote server took too long.
* `invalid_file_url` - 422: the file URL when creating a resource is invalid.
* `invalid_image_dpi` - 422: DPI must be at least 300.
* `invalid_international_feature` - 422: the specified product cannot be sent to the destination.
* `invalid_perforation_return_envelope` - 422: both `return_envelope` and `perforation` must be used together.
* `invalid_template_html` - 422: the provided HTML is invalid.
* `mail_use_type_can_not_be_null` - 422: use_type must be one of "marketing" or "operational". Alternatively, an admin can set the account default use type in Account Settings.
* `merge_variable_required` - 422: a required merge variable is missing.
* `merge_variable_whitespace` - 422: merge variable names cannot contain whitespace.
* `payment_method_unverified` - 401: you must have a verified bank account or credit card to submit live requests.
* `pdf_encrypted` - 422: an encrypted PDF was provided.
* `special_characters_restricted` - 422: cannot use special characters for merge variable names.
* `unembedded_fonts` - 422: the provided PDF contains non-standard unembedded fonts. See description for details.
**AUTHENTICATION**
* `email_required` - 401: account must have a verified email address before creating live resources.
* `invalid_api_key` - 401/403: the API key is invalid.
* `publishable_key_not_allowed` - 403: the requested operation needs a secret key, not a publishable key. See [API Keys](#section/API-Keys) for more information.
* `rate_limit_exceeded` - 429: requests were sent too quickly and must be slowed down.
* `unauthorized` - 401: the request isn''t authorized.
* `unauthorized_token` - 401: token isn''t authorized.
'
link_delete_response:
type: object
properties:
id:
description: Unique identifier for a link.
type: string
deleted:
description: Only returned if the link was successfully deleted.
type: boolean
link_update:
type: object
required:
- redirect_link
properties:
title:
description: The title of the URL.
type: string
redirect_link:
$ref: '#/components/schemas/redirect_link'
metadata:
$ref: '#/components/schemas/metadata'
domain_response:
type: object
properties:
id:
description: Unique identifier for a domain.
type: string
domain:
description: The registered domain/hostname.
type: string
error_redirect_link:
description: URL to redirect customers if a short link is broken or inactive.
type: string
status:
description: The configuration status of the domain.
type: string
enum:
- configured
- not_configured
created_at:
description: The date and time the domain was created.
type: string
updated_at:
description: The date and time the domain was last updated.
type: string
metadata:
type: object
additionalProperties:
type: string
description: '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 `\`. i.e. ''{"customer_id" : "NEWYORK2015"}'' Nested objects are not supported. See [Metadata](#section/Metadata) for more information.'
maxLength: 500
pattern: '[^"\\]{0,500}'
failure_status_code:
type: integer
enum:
- 401
- 403
- 404
- 413
- 422
- 429
- 500
description: "A conventional HTTP status code:\n * `401` - Authorization error with your API key or account\n * `403` - Forbidden error with your API key or account\n * `404` - The requested item does not exist\n * `413` - Payload too large\n * `422` - The query or body parameters did not pass validation\n * `429` - Too many requests have been sent with an API key in a given amount of time\n * `500` - An internal server error occurred, please contact support@lob.com\n"
redirect_link:
type: string
description: The original target URL.
securitySchemes:
basicAuth:
type: http
scheme: basic
x-webhooks:
events:
post:
summary: Events
description: Information about an event
operationId: event
tags:
- Events
responses:
'200':
$ref: '#/components/responses/events'
tracking_events:
post:
summary: Tracking Events
description: Information about tracking events
operationId: tracking_event
tags:
- Tracking Events
responses:
'200':
$ref: '#/components/responses/tracking_events'
x-tagGroups:
- name: Overview
tags:
- Introduction
- Authentication
- Getting Started
- SDKs and Tools
- name: Address Book
tags:
- Addresses
- National Change of Address
- name: Print and Mail API
tags:
- Postcards
- Self Mailers
- Letters
- Checks
- Snap Packs
- Booklets
- Bank Accounts
- Templates
- Template Versions
- Template Design
- Manage Mail
- name: Campaigns API (BETA)
tags:
- Campaigns
- Creatives
- Uploads
- name: Informed Delivery Campaign API
tags:
- Informed Delivery Campaign
- name: Address Verification API
tags:
- US Verifications
- US Verification Types
- US Autocompletions
- Reverse Geocode Lookups
- Zip Lookups
- Identity Validation
- Intl Verifications
- name: Webhooks
tags:
- Webhooks
- Events
- Tracking Events
- name: Special Features
tags:
- Billing Groups
- Buckslips
- Buckslip Orders
- Cards
- Card Orders
- QR Codes
- URL Shortener
- name: Appendix
tags:
- Beta Program
- Errors
- Rate Limiting
- Requests and Responses
- Test and Live Environments
- Versioning and Changelog