Lob integration: operations for AI agents
Lob connects to Type.com as an integration. This page lists the 105 operations documented for Claude and Codex in Type.com: 44 read, 45 write, 16 destructive.
About Lob
Direct Mail Automation and Address Verification APIs
Categories: Marketing & Social
How to connect Lob to Type.com
- Access
- Organization connection: one shared account for the workspace.
To add the connection, follow the steps in Space connections.
Documented operations
105 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.
105 operations listed.
Accounts
- Read
Get Lob Credits Balance
Returns the account's current balance of Lob Credits.
Addresses
- Read
List
Returns a list of your addresses. The addresses are returned sorted by creation date, with the most recently created addresses appearing first.
- Read
Retrieve
Retrieves the details of an existing address. You need only supply the unique identifier that was returned upon address creation.
- Write
Create
Creates a new address given information
- Destructive
Delete
Deletes the details of an existing address. You need only supply the unique identifier that was returned upon address creation.
Bank Accounts
- Read
Retrieve
Retrieves the details of an existing bank account. You need only supply the unique bank account identifier that was returned upon bank account creation.
- Read
List
Returns a list of your bank accounts. The bank accounts are returned sorted by creation date, with the most recently created bank accounts appearing first.
- Write
Verify
Verify a bank account in order to create a check. Check the microdeposittype field returned by GET /v1/bankaccounts/:id to determine which parameter to submit: - amounts — provide the two microdeposit amounts (in cents) that appeared in the bank account statement.
- Write
Create
Creates a new bank account with the provided properties. Bank accounts created in live mode will need to be verified via micro deposits before being able to send live checks.
- Destructive
Delete
Permanently deletes a bank account. It cannot be undone.
Billing Groups
- Read
Retrieve
Retrieves the details of an existing billinggroup. You need only supply the unique billinggroup identifier that was returned upon billinggroup creation.
- Read
List
Returns a list of your billinggroups. The billinggroups are returned sorted by creation date, with the most recently created billinggroups appearing first.
- Write
Update
Updates all editable attributes of the billinggroup with the given id.
- Write
Create
Creates a new billinggroup with the provided properties.
Booklets
- Read
Retrieve
Retrieves the details of an existing booklet. You need to only supply the unique booklet identifier that was returned upon booklet creation.
- Read
List
Returns a list of your booklets. The booklets are returned sorted by creation date, with the most recently created booklets appearing first.
- Write
Create
Creates a new booklet.
- Destructive
Delete
Completely removes a booklet from production. This can only be done if the booklet's senddate has not yet passed. If the booklet is successfully canceled, you will not be charged for it.
Buckslips
- Read
List
Returns a list of your buckslips. The buckslips are returned sorted by creation date, with the most recently created buckslips appearing first.
- Read
Retrieve
Retrieves the details of an existing buckslip. You need only supply the unique customer identifier that was returned upon buckslip creation.
- Write
Create
Creates a new buckslip given information
- Write
Update
Update the details of an existing buckslip. You need only supply the unique identifier that was returned upon buckslip creation.
- Destructive
Delete
Delete an existing buckslip. You need only supply the unique identifier that was returned upon buckslip creation.
Buckslip Orders
- Read
Retrieve
Retrieves the buckslip orders associated with the given buckslip id.
- Write
Create
Creates a new buckslip order given information
US Verifications
- Write
Bulk Verify
Verify a list of US or US territory addresses with a live API key. Requests to this endpoint with a test API key will return a dummy response based on the primary line you input.
- Write
Single Verify
Verify a US or US territory address with a live API key. The address can be in components (e.g. primaryline is "210 King Street", zipcode is "94107") or as a single string (e.g. "210 King Street 94107"), but not as both.
Intl Verifications
- Write
Bulk Verify
Verify a list of international (except US or US territories) address with a live API key. Requests to this endpoint with a test API key will return a dummy response based on the primary line you input.
- Write
Single Verify
Verify an international (except US or US territories) address with a live API key. Requests to this endpoint with a test API key will return a dummy response based on the primary line you input.
Campaigns
- Read
List
Returns a list of your campaigns. The campaigns are returned sorted by creation date, with the most recently created campaigns appearing first.
- Read
Retrieve
Retrieves the details of an existing campaign. You need only supply the unique campaign identifier that was returned upon campaign creation.
- Write
Create
Creates a new campaign with the provided properties. See how to launch your first campaign here.
- Write
Update
Update the details of an existing campaign. You need only supply the unique identifier that was returned upon campaign creation.
- Write
Send Campaign
Sends a campaign. You need only supply the unique campaign identifier that was returned upon campaign creation.
- Destructive
Delete
Delete an existing campaign. You need only supply the unique identifier that was returned upon campaign creation. Deleting a campaign also deletes any associated mail pieces that have been created but not sent. A campaign's senddate matches its associated mail pieces' senddates.
Cards
- Read
List
Returns a list of your cards. The cards are returned sorted by creation date, with the most recently created addresses appearing first.
- Read
Retrieve
Retrieves the details of an existing card. You need only supply the unique customer identifier that was returned upon card creation.
- Write
Create
Creates a new card given information
- Write
Update
Update the details of an existing card. You need only supply the unique identifier that was returned upon card creation.
- Destructive
Delete
Delete an existing card. You need only supply the unique identifier that was returned upon card creation.
Card Orders
- Read
Retrieve
Retrieves the card orders associated with the given card id.
- Write
Create
Creates a new card order given information
Checks
- Read
List
Returns a list of your checks. The checks are returned sorted by creation date, with the most recently created checks appearing first.
- Read
Retrieve
Retrieves the details of an existing check. You need only supply the unique check identifier that was returned upon check creation.
- Write
Create
Creates a new check with the provided properties.
- Destructive
Cancel
Completely removes a check from production. This can only be done if the check has a senddate and the senddate has not yet passed. If the check is successfully canceled, you will not be charged for it. Read more on cancellation windows and scheduling.
Creatives
- Read
Retrieve
Retrieves the details of an existing creative. You need only supply the unique creative identifier that was returned upon creative creation.
- Write
Create
Creates a new creative with the provided properties
- Write
Update
Update the details of an existing creative. You need only supply the unique identifier that was returned upon creative creation.
Identity Validation
- Write
Identity Validation
Validates whether a given name is associated with an address.
Informed Delivery Campaign
- Read
List
List Informed Delivery campaigns
- Read
Retrieve
Retrieves the details of an existing Informed Delivery campaign. You need only supply the uspscampaignid returned in the campaign creation request.
- Write
Create
Creates a new Informed Delivery campaign
- Write
Update
Update the details of an existing Informed Delivery campaign. NOTE: you can only update a campaign in the pendingapproval status.
Letters
- Read
Retrieve
Retrieves the details of an existing letter. You need only supply the unique letter identifier that was returned upon letter creation.
- Read
List
Returns a list of your letters. The letters are returned sorted by creation date, with the most recently created letters appearing first.
- Write
Create
Creates a new letter given information
- Destructive
Cancel
Completely removes a letter from production. This can only be done if the letter has a senddate and the senddate has not yet passed. If the letter is successfully canceled, you will not be charged for it. Read more on cancellation windows and scheduling.
Postcards
- Read
Retrieve
Retrieves the details of an existing postcard. You need only supply the unique customer identifier that was returned upon postcard creation.
- Read
List
Returns a list of your postcards. The addresses are returned sorted by creation date, with the most recently created addresses appearing first.
- Write
Create
Creates a new postcard given information
- Destructive
Cancel
Completely removes a postcard from production. This can only be done if the postcard has a senddate and the senddate has not yet passed. If the postcard is successfully canceled, you will not be charged for it. Read more on cancellation windows and scheduling.
QR Codes
- Read
List
Returns a list of your QR codes. The QR codes are returned sorted by scan date, with the most recently scanned QR codes appearing first.
URL Shortener
- Read
Retrieve a domain
Retrieve details for a single domain.
- Read
List all domains
Retrieve a list of all created domains.
- Read
Retrieve a link
Retrieves a single shortened link.
- Read
List all links
Retrieves a list of shortened links. The list is sorted by creation date, with the most recently created appearing first.
- Write
Create Domain
Add a new custom domain that can be used to create custom links.
- Write
Update a Link
Update any of the properties of a shortened link.
- Write
Create Link
Given a long URL, shorten your URL either by using a custom domain or Lob's own short domain.
- Destructive
Delete a Domain
Delete a registered domain. This operation can only be performed if all associated links with the domain are deleted.
- Destructive
Delete Link
Delete the shortened link.
Resource Proofs
- Read
Retrieve
Retrieves the details of an existing resource proof. You need only supply the unique resource proof identifier.
- Write
Update
Updates the specified resource proof.
- Write
Create
Creates a new resource proof with the provided properties.
Self Mailers
- Read
Retrieve
Retrieves the details of an existing selfmailer. You need only supply the unique selfmailer identifier that was returned upon selfmailer creation.
- Read
List
Returns a list of your selfmailers. The selfmailers are returned sorted by creation date, with the most recently created selfmailers appearing first.
- Write
Create
Creates a new selfmailer given information
- Destructive
Delete
Completely removes a self mailer from production. This can only be done if the self mailer's senddate has not yet passed. If the self mailer is successfully canceled, you will not be charged for it. This feature is exclusive to certain customers.
Snap Packs
- Read
Retrieve
Retrieves the details of an existing snappack. You need to only supply the unique snappack identifier that was returned upon snappack creation.
- Read
List
Returns a list of your snappacks. The snappacks are returned sorted by creation date, with the most recently created snappacks appearing first.
- Write
Create
Creates a new snappack given information
- Destructive
Delete
Completely removes a snap pack from production. This can only be done if the snap pack's senddate has not yet passed. If the snap pack is successfully canceled, you will not be charged for it.
Template Versions
- Read
Retrieve
Retrieves the template version with the given template and version ids.
- Read
List
Returns a list of template versions for the given template ID. The template versions are sorted by creation date, with the most recently created appearing first.
- Write
Update
Updates the template version with the given template and version ids.
- Write
Create
Creates a new template version attached to the specified template.
- Destructive
Delete
Permanently deletes a template version. A template's publishedversion can not be deleted.
Templates
- Read
Retrieve
Retrieves the details of an existing template. You need only supply the unique template identifier that was returned upon template creation.
- Read
List
Returns a list of your templates. The templates are returned sorted by creation date, with the most recently created templates appearing first.
- Write
Update
Updates the description and/or published version of the template with the given id. To update the template's html, create a new version of the template.
- Write
Create
Creates a new template for use with the Print & Mail API. In Live mode, you can only have as many non-deleted templates as allotted in your current Print & Mail Edition . If you attempt to create a template past your limit, you will receive a 403 error.
- Destructive
Delete
Permanently deletes a template. Deleting a template also deletes its associated versions. Deleted templates can not be used to create postcard, letter, or check resources.
Uploads
- Read
List
Returns a list of your uploads. Optionally, filter uploads by campaign.
- Read
Retrieve
Retrieves the details of an existing upload. You need only supply the unique upload identifier that was returned upon upload creation.
- Read
Retrieve Line Item Report
Retrieves the line item data for each row from the csv file associated with the upload id record. NOTE: This endpoint is currently feature flagged. Please reach out to Lob's support team if you would like access to this API endpoint.
- Read
Retrieve Export
Retrieves the details of an existing export. You need only supply the unique export identifier that was returned upon export creation.
- Write
Create
Creates a new upload with the provided properties.
- Write
Update
Update the details of an existing upload. You need only supply the unique identifier that was returned upon upload creation.
- Write
Upload file
Upload an audience file and associate it with an upload.
- Write
Create Export
Campaign Exports can help you understand exactly which records in a campaign could not be created. By initiating and retrieving an export, you will get row-by-row errors for your campaign.
- Destructive
Delete
Delete an existing upload. You need only supply the unique identifier that was returned upon upload creation.
US Autocompletions
- Write
Autocomplete
Given an address prefix consisting of a partial primary line, as well as optional input of city, state, and zip code, this functionality returns up to 10 full US address suggestions. Not all of them will turn out to be valid addresses; they'll need to be verified.
Reverse Geocode Lookups
- Write
Reverse Geocode Lookup
Reverse geocode a valid US location with a live API key.
Zip Lookups
- Write
Lookups
Returns information about a ZIP code
No operations match.
See How connections work for access and permissions, or browse all integrations.