Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Abound Mailings API

The Mailings API from Abound — 2 operation(s) for mailings.

Abound Mailings API is one of 13 APIs that Abound publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Mailings. The published artifact set on APIs.io includes an OpenAPI specification and an AsyncAPI specification.

This API exposes 4 operations across 2 paths, and defines 15 schemas. It is described by OpenAPI 3.1.0, at version 4.

Requests are made against 2 base URLs: https://production-api.withabound.com, https://sandbox-api.withabound.com.

4 operations 2 paths 15 schemas 1 DELETE2 GET1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
4
Base URL
https://production-api.withabound.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Abound Mailings API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Bearer token. The token is the concatenation of your Abound appId and appSecret separated by a period, e.g. appIdxxx.appSecretyyy.

Paths & Operations 4

Across 2 paths, the API surfaces 4 operations — 1 DELETE, 2 GET, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Mailings 4
GET
/v4/mailings
List all mailings
mailingsList 3 params → 200400401404500
GET
/v4/mailings/{mailingId}
Retrieve a mailing
mailingsRetrieve 1 param → 200400401404500
PUT
/v4/mailings/{mailingId}
Update a mailing
mailingsUpdate 2 params body → 200400401404500
DELETE
/v4/mailings/{mailingId}
Delete a mailing
mailingsDelete 1 param → 200400401404500

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are AddressSchema (6 properties), ErrorBadRequestSchemaErrorsItem (2 properties), MailingNameSchema (2 properties), MailingRequestSchema (2 properties). Each schema is shown below with its type and property counts.

MailingNameSchema
object
2 properties
UserId
string
The unique identifier for a single end-user of your application.
Page
integer
The specific page of results you're requesting. Responses are limited to a maximum of 100 records.
MailingStatusEnum
string
DefaultErrorSchema
object
1 property 1 required
MailingSchema
MailingRequestFromSchema
The mailing address of the sender.
OkSchema
object
MailingId
string
The unique identifier for an existing mailing.
MailingRequestSchema
object
2 properties 2 required
IdempotencyKey
string
The unique key used to identify a request that has already been processed.
ErrorBadRequestSchemaErrorsItem
object
2 properties 1 required
AddressSchema
object
6 properties 2 required
ErrorBadRequestSchema
object
1 property 1 required
MailingRequestToSchema
The mailing address of the recipient.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

abound-mailings-api-openapi.yml Raw ↑

Other APIs Abound publishes across the network.

Abound 1099-INT API
Abound 1099-K API
Abound 1099-MISC API
Abound 1099-NEC API
Abound Access Tokens API
Abound Electronic Delivery Consents API
Abound Tax Treaties API
Abound TIN Verifications API
Abound Users API
Abound W-8BEN API
Abound W-8BEN-E API
Abound W-9 API