{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/business:lob/get-lob-credits-balance":{"get":{"operationId":"business_lob_get_lob_credits_balance","summary":"Get Lob Credits Balance","description":"GET /accounts","tags":["business"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:lob/addresses-list":{"get":{"operationId":"business_lob_addresses_list","summary":"List","description":"GET /addresses","tags":["business"],"parameters":[{"name":"limit","in":"query","required":false,"description":"How many results to return.","schema":{"type":"integer","default":10,"description":"How many results to return."}},{"name":"before/after","in":"query","required":false,"description":"`before` and `after` are both optional but only one of them can be in the query at a time.","schema":{"type":"string","description":"`before` and `after` are both optional but only one of them can be in the query at a time."}},{"name":"include","in":"query","required":false,"description":"Request that the response include the total count by specifying `include=[\"total_count\"]`.","schema":{"type":"array","description":"Request that the response include the total count by specifying `include=[\"total_count\"]`."}},{"name":"date_created","in":"query","required":false,"description":"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…","schema":{"type":"object","description":"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…"}},{"name":"metadata","in":"query","required":false,"description":"Filter by metadata key-value pair`.","schema":{"type":"object","description":"Filter by metadata key-value pair`."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:lob/address-create":{"post":{"operationId":"business_lob_address_create","summary":"Create","description":"POST /addresses","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:lob/address-retrieve":{"get":{"operationId":"business_lob_address_retrieve","summary":"Retrieve","description":"GET /addresses/{adr_id}","tags":["business"],"parameters":[{"name":"adr_id","in":"query","required":true,"description":"id of the address","schema":{"type":"string","description":"id of the address"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:lob/address-delete":{"post":{"operationId":"business_lob_address_delete","summary":"Delete","description":"DELETE /addresses/{adr_id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["adr_id"],"properties":{"adr_id":{"type":"string","description":"id of the address"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:lob/bank-account-verify":{"post":{"operationId":"business_lob_bank_account_verify","summary":"Verify","description":"POST /bank_accounts/{bank_id}/verify","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["bank_id","body"],"properties":{"bank_id":{"type":"string","description":"id of the bank account to be verified"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:lob/bank-account-retrieve":{"get":{"operationId":"business_lob_bank_account_retrieve","summary":"Retrieve","description":"GET /bank_accounts/{bank_id}","tags":["business"],"parameters":[{"name":"bank_id","in":"query","required":true,"description":"id of the bank account","schema":{"type":"string","description":"id of the bank account"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:lob/bank-account-delete":{"post":{"operationId":"business_lob_bank_account_delete","summary":"Delete","description":"DELETE /bank_accounts/{bank_id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["bank_id"],"properties":{"bank_id":{"type":"string","description":"id of the bank account"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:lob/bank-accounts-list":{"get":{"operationId":"business_lob_bank_accounts_list","summary":"List","description":"GET /bank_accounts","tags":["business"],"parameters":[{"name":"limit","in":"query","required":false,"description":"How many results to return.","schema":{"type":"integer","default":10,"description":"How many results to return."}},{"name":"before/after","in":"query","required":false,"description":"`before` and `after` are both optional but only one of them can be in the query at a time.","schema":{"type":"string","description":"`before` and `after` are both optional but only one of them can be in the query at a time."}},{"name":"include","in":"query","required":false,"description":"Request that the response include the total count by specifying `include=[\"total_count\"]`.","schema":{"type":"array","description":"Request that the response include the total count by specifying `include=[\"total_count\"]`."}},{"name":"date_created","in":"query","required":false,"description":"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…","schema":{"type":"object","description":"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…"}},{"name":"metadata","in":"query","required":false,"description":"Filter by metadata key-value pair`.","schema":{"type":"object","description":"Filter by metadata key-value pair`."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:lob/bank-account-create":{"post":{"operationId":"business_lob_bank_account_create","summary":"Create","description":"POST /bank_accounts","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:lob/billing-group-retrieve":{"get":{"operationId":"business_lob_billing_group_retrieve","summary":"Retrieve","description":"GET /billing_groups/{bg_id}","tags":["business"],"parameters":[{"name":"bg_id","in":"query","required":true,"description":"id of the billing_group","schema":{"type":"string","description":"id of the billing_group"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:lob/billing-group-update":{"post":{"operationId":"business_lob_billing_group_update","summary":"Update","description":"POST /billing_groups/{bg_id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["bg_id","body"],"properties":{"bg_id":{"type":"string","description":"id of the billing_group"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:lob/billing-groups-list":{"get":{"operationId":"business_lob_billing_groups_list","summary":"List","description":"GET /billing_groups","tags":["business"],"parameters":[{"name":"limit","in":"query","required":false,"description":"How many results to return.","schema":{"type":"integer","default":10,"description":"How many results to return."}},{"name":"offset","in":"query","required":false,"description":"An integer that designates the offset at which to begin returning results. Defaults to 0.","schema":{"type":"integer","default":0,"description":"An integer that designates the offset at which to begin returning results. Defaults to 0."}},{"name":"include","in":"query","required":false,"description":"Request that the response include the total count by specifying `include=[\"total_count\"]`.","schema":{"type":"array","description":"Request that the response include the total count by specifying `include=[\"total_count\"]`."}},{"name":"date_created","in":"query","required":false,"description":"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…","schema":{"type":"object","description":"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…"}},{"name":"date_modified","in":"query","required":false,"description":"Filter by date modified. Accepted formats are ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where…","schema":{"type":"object","description":"Filter by date modified. Accepted formats are ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where…"}},{"name":"sort_by","in":"query","required":false,"description":"Sorts items by ascending or descending dates. Use either `date_created` or `date_modified`, not both.","schema":{"type":"string","description":"Sorts items by ascending or descending dates. Use either `date_created` or `date_modified`, not both."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:lob/billing-group-create":{"post":{"operationId":"business_lob_billing_group_create","summary":"Create","description":"POST /billing_groups","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:lob/booklet-retrieve":{"get":{"operationId":"business_lob_booklet_retrieve","summary":"Retrieve","description":"GET /booklets/{booklet_id}","tags":["business"],"parameters":[{"name":"booklet_id","in":"query","required":true,"description":"id of the booklet","schema":{"type":"string","description":"id of the booklet"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:lob/booklet-delete":{"post":{"operationId":"business_lob_booklet_delete","summary":"Delete","description":"DELETE /booklets/{booklet_id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["booklet_id"],"properties":{"booklet_id":{"type":"string","description":"id of the booklet"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:lob/booklets-list":{"get":{"operationId":"business_lob_booklets_list","summary":"List","description":"GET /booklets","tags":["business"],"parameters":[{"name":"limit","in":"query","required":false,"description":"How many results to return.","schema":{"type":"integer","default":10,"description":"How many results to return."}},{"name":"before/after","in":"query","required":false,"description":"`before` and `after` are both optional but only one of them can be in the query at a time.","schema":{"type":"string","description":"`before` and `after` are both optional but only one of them can be in the query at a time."}},{"name":"include","in":"query","required":false,"description":"Request that the response include the total count by specifying `include=[\"total_count\"]`.","schema":{"type":"array","description":"Request that the response include the total count by specifying `include=[\"total_count\"]`."}},{"name":"date_created","in":"query","required":false,"description":"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…","schema":{"type":"object","description":"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…"}},{"name":"metadata","in":"query","required":false,"description":"Filter by metadata key-value pair`.","schema":{"type":"object","description":"Filter by metadata key-value pair`."}},{"name":"send_date","in":"query","required":false,"description":"Filter by ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥,…","schema":{"type":"string","description":"Filter by ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥,…"}},{"name":"mail_type","in":"query","required":false,"description":"A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a cheaper option which is less…","schema":{"type":"string","enum":["usps_first_class","usps_standard"],"default":"usps_first_class","description":"A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a cheaper option which is less…"}},{"name":"sort_by","in":"query","required":false,"description":"Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both.","schema":{"type":"string","description":"Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both."}},{"name":"campaign_id","in":"query","required":false,"description":"Filters resources created by the provided campaign id, prefixed with `cmp_`. In the case of snap packs, booklets, and letters with size…","schema":{"type":"string","description":"Filters resources created by the provided campaign id, prefixed with `cmp_`. In the case of snap packs, booklets, and letters with size…"}},{"name":"status","in":"query","required":false,"description":"A string describing the render status: * `processed` - the rendering process is currently underway. * `rendered` - the rendering process…","schema":{"type":"string","enum":["processed","rendered","failed"],"description":"A string describing the render status: * `processed` - the rendering process is currently underway. * `rendered` - the rendering process…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:lob/booklet-create":{"post":{"operationId":"business_lob_booklet_create","summary":"Create","description":"POST /booklets","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"Idempotency-Key":{"type":"string","description":"A string of no longer than 256 characters that uniquely identifies this resource. For more help integrating idempotency keys, refer to our…"},"idempotency_key":{"type":"string","description":"A string of no longer than 256 characters that uniquely identifies this resource. For more help integrating idempotency keys, refer to our…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:lob/buckslips-list":{"get":{"operationId":"business_lob_buckslips_list","summary":"List","description":"GET /buckslips","tags":["business"],"parameters":[{"name":"limit","in":"query","required":false,"description":"How many results to return.","schema":{"type":"integer","default":10,"description":"How many results to return."}},{"name":"before/after","in":"query","required":false,"description":"`before` and `after` are both optional but only one of them can be in the query at a time.","schema":{"type":"string","description":"`before` and `after` are both optional but only one of them can be in the query at a time."}},{"name":"include","in":"query","required":false,"description":"Request that the response include the total count by specifying `include=[\"total_count\"]`.","schema":{"type":"array","description":"Request that the response include the total count by specifying `include=[\"total_count\"]`."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:lob/buckslip-create":{"post":{"operationId":"business_lob_buckslip_create","summary":"Create","description":"POST /buckslips","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:lob/buckslip-retrieve":{"get":{"operationId":"business_lob_buckslip_retrieve","summary":"Retrieve","description":"GET /buckslips/{buckslip_id}","tags":["business"],"parameters":[{"name":"buckslip_id","in":"query","required":true,"description":"id of the buckslip","schema":{"type":"string","description":"id of the buckslip"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:lob/buckslip-update":{"post":{"operationId":"business_lob_buckslip_update","summary":"Update","description":"PATCH /buckslips/{buckslip_id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["buckslip_id","body"],"properties":{"buckslip_id":{"type":"string","description":"id of the buckslip"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:lob/buckslip-delete":{"post":{"operationId":"business_lob_buckslip_delete","summary":"Delete","description":"DELETE /buckslips/{buckslip_id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["buckslip_id"],"properties":{"buckslip_id":{"type":"string","description":"id of the buckslip"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:lob/buckslip-orders-retrieve":{"get":{"operationId":"business_lob_buckslip_orders_retrieve","summary":"Retrieve","description":"GET /buckslips/{buckslip_id}/orders","tags":["business"],"parameters":[{"name":"buckslip_id","in":"query","required":true,"description":"The ID of the buckslip to which the buckslip orders belong.","schema":{"type":"string","description":"The ID of the buckslip to which the buckslip orders belong."}},{"name":"limit","in":"query","required":false,"description":"How many results to return.","schema":{"type":"integer","default":10,"description":"How many results to return."}},{"name":"offset","in":"query","required":false,"description":"An integer that designates the offset at which to begin returning results. Defaults to 0.","schema":{"type":"integer","default":0,"description":"An integer that designates the offset at which to begin returning results. Defaults to 0."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:lob/buckslip-order-create":{"post":{"operationId":"business_lob_buckslip_order_create","summary":"Create","description":"POST /buckslips/{buckslip_id}/orders","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["buckslip_id","body"],"properties":{"buckslip_id":{"type":"string","description":"The ID of the buckslip to which the buckslip orders belong."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:lob/bulk-us-verifications":{"post":{"operationId":"business_lob_bulk_us_verifications","summary":"Bulk Verify","description":"POST /bulk/us_verifications","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"case":{"type":"string","enum":["upper","proper"],"default":"upper","description":"Casing of the verified address. Possible values are `upper` and `proper` for uppercased (e.g. \"PO BOX\") and proper-cased (e.g. \"PO Box\"),…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:lob/bulk-intl-verifications":{"post":{"operationId":"business_lob_bulk_intl_verifications","summary":"Bulk Verify","description":"POST /bulk/intl_verifications","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:lob/campaigns-list":{"get":{"operationId":"business_lob_campaigns_list","summary":"List","description":"GET /campaigns","tags":["business"],"parameters":[{"name":"limit","in":"query","required":false,"description":"How many results to return.","schema":{"type":"integer","default":10,"description":"How many results to return."}},{"name":"include","in":"query","required":false,"description":"Request that the response include the total count by specifying `include=[\"total_count\"]`.","schema":{"type":"array","description":"Request that the response include the total count by specifying `include=[\"total_count\"]`."}},{"name":"before/after","in":"query","required":false,"description":"`before` and `after` are both optional but only one of them can be in the query at a time.","schema":{"type":"string","description":"`before` and `after` are both optional but only one of them can be in the query at a time."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:lob/campaign-create":{"post":{"operationId":"business_lob_campaign_create","summary":"Create","description":"POST /campaigns","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"x-lang-output":{"type":"string","enum":["native","match"],"description":"* `native` - Translate response to the native language of the country in the request * `match` - match the response to the language in the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:lob/campaign-retrieve":{"get":{"operationId":"business_lob_campaign_retrieve","summary":"Retrieve","description":"GET /campaigns/{cmp_id}","tags":["business"],"parameters":[{"name":"cmp_id","in":"query","required":true,"description":"id of the campaign","schema":{"type":"string","description":"id of the campaign"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:lob/campaign-update":{"post":{"operationId":"business_lob_campaign_update","summary":"Update","description":"PATCH /campaigns/{cmp_id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["cmp_id","body"],"properties":{"cmp_id":{"type":"string","description":"id of the campaign"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:lob/campaign-delete":{"post":{"operationId":"business_lob_campaign_delete","summary":"Delete","description":"DELETE /campaigns/{cmp_id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["cmp_id"],"properties":{"cmp_id":{"type":"string","description":"id of the campaign"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:lob/campaign-send":{"post":{"operationId":"business_lob_campaign_send","summary":"Send Campaign","description":"POST /campaigns/{cmp_id}/send","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["cmp_id"],"properties":{"cmp_id":{"type":"string","description":"id of the campaign"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:lob/cards-list":{"get":{"operationId":"business_lob_cards_list","summary":"List","description":"GET /cards","tags":["business"],"parameters":[{"name":"limit","in":"query","required":false,"description":"How many results to return.","schema":{"type":"integer","default":10,"description":"How many results to return."}},{"name":"before/after","in":"query","required":false,"description":"`before` and `after` are both optional but only one of them can be in the query at a time.","schema":{"type":"string","description":"`before` and `after` are both optional but only one of them can be in the query at a time."}},{"name":"include","in":"query","required":false,"description":"Request that the response include the total count by specifying `include=[\"total_count\"]`.","schema":{"type":"array","description":"Request that the response include the total count by specifying `include=[\"total_count\"]`."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:lob/card-create":{"post":{"operationId":"business_lob_card_create","summary":"Create","description":"POST /cards","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:lob/card-retrieve":{"get":{"operationId":"business_lob_card_retrieve","summary":"Retrieve","description":"GET /cards/{card_id}","tags":["business"],"parameters":[{"name":"card_id","in":"query","required":true,"description":"id of the card","schema":{"type":"string","description":"id of the card"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:lob/card-update":{"post":{"operationId":"business_lob_card_update","summary":"Update","description":"POST /cards/{card_id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["card_id","body"],"properties":{"card_id":{"type":"string","description":"id of the card"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:lob/card-delete":{"post":{"operationId":"business_lob_card_delete","summary":"Delete","description":"DELETE /cards/{card_id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["card_id"],"properties":{"card_id":{"type":"string","description":"id of the card"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:lob/card-orders-retrieve":{"get":{"operationId":"business_lob_card_orders_retrieve","summary":"Retrieve","description":"GET /cards/{card_id}/orders","tags":["business"],"parameters":[{"name":"card_id","in":"query","required":true,"description":"The ID of the card to which the card orders belong.","schema":{"type":"string","description":"The ID of the card to which the card orders belong."}},{"name":"limit","in":"query","required":false,"description":"How many results to return.","schema":{"type":"integer","default":10,"description":"How many results to return."}},{"name":"offset","in":"query","required":false,"description":"An integer that designates the offset at which to begin returning results. Defaults to 0.","schema":{"type":"integer","default":0,"description":"An integer that designates the offset at which to begin returning results. Defaults to 0."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:lob/card-order-create":{"post":{"operationId":"business_lob_card_order_create","summary":"Create","description":"POST /cards/{card_id}/orders","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["card_id","body"],"properties":{"card_id":{"type":"string","description":"The ID of the card to which the card orders belong."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:lob/checks-list":{"get":{"operationId":"business_lob_checks_list","summary":"List","description":"GET /checks","tags":["business"],"parameters":[{"name":"limit","in":"query","required":false,"description":"How many results to return.","schema":{"type":"integer","default":10,"description":"How many results to return."}},{"name":"before/after","in":"query","required":false,"description":"`before` and `after` are both optional but only one of them can be in the query at a time.","schema":{"type":"string","description":"`before` and `after` are both optional but only one of them can be in the query at a time."}},{"name":"include","in":"query","required":false,"description":"Request that the response include the total count by specifying `include=[\"total_count\"]`.","schema":{"type":"array","description":"Request that the response include the total count by specifying `include=[\"total_count\"]`."}},{"name":"date_created","in":"query","required":false,"description":"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…","schema":{"type":"object","description":"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…"}},{"name":"metadata","in":"query","required":false,"description":"Filter by metadata key-value pair`.","schema":{"type":"object","description":"Filter by metadata key-value pair`."}},{"name":"scheduled","in":"query","required":false,"description":"* `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where…","schema":{"type":"boolean","description":"* `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where…"}},{"name":"send_date","in":"query","required":false,"description":"Filter by ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥,…","schema":{"type":"string","description":"Filter by ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥,…"}},{"name":"mail_type","in":"query","required":false,"description":"A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a cheaper option which is less…","schema":{"type":"string","enum":["usps_first_class","usps_standard"],"default":"usps_first_class","description":"A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a cheaper option which is less…"}},{"name":"sort_by","in":"query","required":false,"description":"Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both.","schema":{"type":"string","description":"Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both."}},{"name":"status","in":"query","required":false,"description":"A string describing the render status: * `processed` - the rendering process is currently underway. * `rendered` - the rendering process…","schema":{"type":"string","enum":["processed","rendered","failed"],"description":"A string describing the render status: * `processed` - the rendering process is currently underway. * `rendered` - the rendering process…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:lob/check-create":{"post":{"operationId":"business_lob_check_create","summary":"Create","description":"POST /checks","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"Idempotency-Key":{"type":"string","description":"A string of no longer than 256 characters that uniquely identifies this resource. For more help integrating idempotency keys, refer to our…"},"idempotency_key":{"type":"string","description":"A string of no longer than 256 characters that uniquely identifies this resource. For more help integrating idempotency keys, refer to our…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:lob/check-retrieve":{"get":{"operationId":"business_lob_check_retrieve","summary":"Retrieve","description":"GET /checks/{chk_id}","tags":["business"],"parameters":[{"name":"chk_id","in":"query","required":true,"description":"id of the check","schema":{"type":"string","description":"id of the check"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:lob/check-cancel":{"post":{"operationId":"business_lob_check_cancel","summary":"Cancel","description":"DELETE /checks/{chk_id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["chk_id"],"properties":{"chk_id":{"type":"string","description":"id of the check"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:lob/creative-create":{"post":{"operationId":"business_lob_creative_create","summary":"Create","description":"POST /creatives","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"x-lang-output":{"type":"string","enum":["native","match"],"description":"* `native` - Translate response to the native language of the country in the request * `match` - match the response to the language in the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:lob/creative-retrieve":{"get":{"operationId":"business_lob_creative_retrieve","summary":"Retrieve","description":"GET /creatives/{crv_id}","tags":["business"],"parameters":[{"name":"crv_id","in":"query","required":true,"description":"id of the creative","schema":{"type":"string","description":"id of the creative"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:lob/creative-update":{"post":{"operationId":"business_lob_creative_update","summary":"Update","description":"PATCH /creatives/{crv_id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["crv_id","body"],"properties":{"crv_id":{"type":"string","description":"id of the creative"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:lob/identity-validation":{"post":{"operationId":"business_lob_identity_validation","summary":"Identity Validation","description":"POST /identity_validation","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:lob/informed-delivery-campaign-list":{"get":{"operationId":"business_lob_informed_delivery_campaign_list","summary":"List","description":"GET /informed_delivery_campaigns","tags":["business"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:lob/informed-delivery-campaign-create":{"post":{"operationId":"business_lob_informed_delivery_campaign_create","summary":"Create","description":"POST /informed_delivery_campaigns","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:lob/informed-delivery-campaign-retrieve":{"get":{"operationId":"business_lob_informed_delivery_campaign_retrieve","summary":"Retrieve","description":"GET /informed_delivery_campaigns/{usps_campaign_id}","tags":["business"],"parameters":[{"name":"usps_campaign_id","in":"query","required":true,"description":"usps_campaign_id of the Informed Delivery campaign","schema":{"type":"string","description":"usps_campaign_id of the Informed Delivery campaign"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:lob/informed-delivery-campaign-update":{"post":{"operationId":"business_lob_informed_delivery_campaign_update","summary":"Update","description":"PATCH /informed_delivery_campaigns/{usps_campaign_id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["usps_campaign_id","body"],"properties":{"usps_campaign_id":{"type":"string","description":"usps_campaign_id of the Informed Delivery campaign"},"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:lob/intl-verification":{"post":{"operationId":"business_lob_intl_verification","summary":"Single Verify","description":"POST /intl_verifications","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"x-lang-output":{"type":"string","enum":["native","match"],"description":"* `native` - Translate response to the native language of the country in the request * `match` - match the response to the language in the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:lob/letter-retrieve":{"get":{"operationId":"business_lob_letter_retrieve","summary":"Retrieve","description":"GET /letters/{ltr_id}","tags":["business"],"parameters":[{"name":"ltr_id","in":"query","required":true,"description":"id of the letter","schema":{"type":"string","description":"id of the letter"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:lob/letter-cancel":{"post":{"operationId":"business_lob_letter_cancel","summary":"Cancel","description":"DELETE /letters/{ltr_id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ltr_id"],"properties":{"ltr_id":{"type":"string","description":"id of the letter"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:lob/letters-list":{"get":{"operationId":"business_lob_letters_list","summary":"List","description":"GET /letters","tags":["business"],"parameters":[{"name":"limit","in":"query","required":false,"description":"How many results to return.","schema":{"type":"integer","default":10,"description":"How many results to return."}},{"name":"before/after","in":"query","required":false,"description":"`before` and `after` are both optional but only one of them can be in the query at a time.","schema":{"type":"string","description":"`before` and `after` are both optional but only one of them can be in the query at a time."}},{"name":"include","in":"query","required":false,"description":"Request that the response include the total count by specifying `include=[\"total_count\"]`.","schema":{"type":"array","description":"Request that the response include the total count by specifying `include=[\"total_count\"]`."}},{"name":"date_created","in":"query","required":false,"description":"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…","schema":{"type":"object","description":"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…"}},{"name":"metadata","in":"query","required":false,"description":"Filter by metadata key-value pair`.","schema":{"type":"object","description":"Filter by metadata key-value pair`."}},{"name":"campaign_id","in":"query","required":false,"description":"Filters resources created by the provided campaign id, prefixed with `cmp_`. In the case of snap packs, booklets, and letters with size…","schema":{"type":"string","description":"Filters resources created by the provided campaign id, prefixed with `cmp_`. In the case of snap packs, booklets, and letters with size…"}},{"name":"status","in":"query","required":false,"description":"A string describing the render status: * `processed` - the rendering process is currently underway. * `rendered` - the rendering process…","schema":{"type":"string","enum":["processed","rendered","failed"],"description":"A string describing the render status: * `processed` - the rendering process is currently underway. * `rendered` - the rendering process…"}},{"name":"color","in":"query","required":false,"description":"Set to `true` to return only color letters. Set to `false` to return only black & white letters.","schema":{"type":"boolean","description":"Set to `true` to return only color letters. Set to `false` to return only black & white letters."}},{"name":"scheduled","in":"query","required":false,"description":"* `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where…","schema":{"type":"boolean","description":"* `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where…"}},{"name":"send_date","in":"query","required":false,"description":"Filter by ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥,…","schema":{"type":"string","description":"Filter by ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥,…"}},{"name":"mail_type","in":"query","required":false,"description":"A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a cheaper option which is less…","schema":{"type":"string","enum":["usps_first_class","usps_standard"],"default":"usps_first_class","description":"A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a cheaper option which is less…"}},{"name":"sort_by","in":"query","required":false,"description":"Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both.","schema":{"type":"string","description":"Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:lob/letter-create":{"post":{"operationId":"business_lob_letter_create","summary":"Create","description":"POST /letters","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"Idempotency-Key":{"type":"string","description":"A string of no longer than 256 characters that uniquely identifies this resource. For more help integrating idempotency keys, refer to our…"},"idempotency_key":{"type":"string","description":"A string of no longer than 256 characters that uniquely identifies this resource. For more help integrating idempotency keys, refer to our…"},"Lob-Version":{"type":"string","description":"A string representing the version of the API being used. Specifically for letters, if this header is set to `2024-01-01` and above, the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:lob/postcard-retrieve":{"get":{"operationId":"business_lob_postcard_retrieve","summary":"Retrieve","description":"GET /postcards/{psc_id}","tags":["business"],"parameters":[{"name":"psc_id","in":"query","required":true,"description":"id of the postcard","schema":{"type":"string","description":"id of the postcard"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:lob/postcard-delete":{"post":{"operationId":"business_lob_postcard_delete","summary":"Cancel","description":"DELETE /postcards/{psc_id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["psc_id"],"properties":{"psc_id":{"type":"string","description":"id of the postcard"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:lob/postcards-list":{"get":{"operationId":"business_lob_postcards_list","summary":"List","description":"GET /postcards","tags":["business"],"parameters":[{"name":"limit","in":"query","required":false,"description":"How many results to return.","schema":{"type":"integer","default":10,"description":"How many results to return."}},{"name":"before/after","in":"query","required":false,"description":"`before` and `after` are both optional but only one of them can be in the query at a time.","schema":{"type":"string","description":"`before` and `after` are both optional but only one of them can be in the query at a time."}},{"name":"include","in":"query","required":false,"description":"Request that the response include the total count by specifying `include=[\"total_count\"]`.","schema":{"type":"array","description":"Request that the response include the total count by specifying `include=[\"total_count\"]`."}},{"name":"date_created","in":"query","required":false,"description":"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…","schema":{"type":"object","description":"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…"}},{"name":"metadata","in":"query","required":false,"description":"Filter by metadata key-value pair`.","schema":{"type":"object","description":"Filter by metadata key-value pair`."}},{"name":"campaign_id","in":"query","required":false,"description":"Filters resources created by the provided campaign id, prefixed with `cmp_`. In the case of snap packs, booklets, and letters with size…","schema":{"type":"string","description":"Filters resources created by the provided campaign id, prefixed with `cmp_`. In the case of snap packs, booklets, and letters with size…"}},{"name":"status","in":"query","required":false,"description":"A string describing the render status: * `processed` - the rendering process is currently underway. * `rendered` - the rendering process…","schema":{"type":"string","enum":["processed","rendered","failed"],"description":"A string describing the render status: * `processed` - the rendering process is currently underway. * `rendered` - the rendering process…"}},{"name":"size","in":"query","required":false,"description":"Specifies the size of the postcard. Only `4x6` postcards can be sent to international destinations.","schema":{"type":"array","description":"Specifies the size of the postcard. Only `4x6` postcards can be sent to international destinations."}},{"name":"scheduled","in":"query","required":false,"description":"* `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where…","schema":{"type":"boolean","description":"* `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where…"}},{"name":"send_date","in":"query","required":false,"description":"Filter by ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥,…","schema":{"type":"string","description":"Filter by ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥,…"}},{"name":"mail_type","in":"query","required":false,"description":"A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a cheaper option which is less…","schema":{"type":"string","enum":["usps_first_class","usps_standard"],"default":"usps_first_class","description":"A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a cheaper option which is less…"}},{"name":"sort_by","in":"query","required":false,"description":"Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both.","schema":{"type":"string","description":"Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:lob/postcard-create":{"post":{"operationId":"business_lob_postcard_create","summary":"Create","description":"POST /postcards","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"Idempotency-Key":{"type":"string","description":"A string of no longer than 256 characters that uniquely identifies this resource. For more help integrating idempotency keys, refer to our…"},"idempotency_key":{"type":"string","description":"A string of no longer than 256 characters that uniquely identifies this resource. For more help integrating idempotency keys, refer to our…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:lob/qr-codes-list":{"get":{"operationId":"business_lob_qr_codes_list","summary":"List","description":"GET /qr_code_analytics","tags":["business"],"parameters":[{"name":"limit","in":"query","required":false,"description":"How many results to return.","schema":{"type":"integer","default":10,"description":"How many results to return."}},{"name":"offset","in":"query","required":false,"description":"An integer that designates the offset at which to begin returning results. Defaults to 0.","schema":{"type":"integer","default":0,"description":"An integer that designates the offset at which to begin returning results. Defaults to 0."}},{"name":"include","in":"query","required":false,"description":"Request that the response include the total count by specifying `include=[\"total_count\"]`.","schema":{"type":"array","description":"Request that the response include the total count by specifying `include=[\"total_count\"]`."}},{"name":"date_created","in":"query","required":false,"description":"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…","schema":{"type":"object","description":"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…"}},{"name":"scanned","in":"query","required":false,"description":"Filter list of responses to only include QR codes with at least one scan event.","schema":{"type":"boolean","description":"Filter list of responses to only include QR codes with at least one scan event."}},{"name":"resource_ids","in":"query","required":false,"description":"Filter by the resource ID.","schema":{"type":"array","description":"Filter by the resource ID."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:lob/domain-get":{"get":{"operationId":"business_lob_domain_get","summary":"Retrieve a domain","description":"GET /domains/{domain_id}","tags":["business"],"parameters":[{"name":"domain_id","in":"query","required":true,"description":"Unique identifier for a domain.","schema":{"type":"string","description":"Unique identifier for a domain."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:lob/domain-delete":{"post":{"operationId":"business_lob_domain_delete","summary":"Delete a Domain","description":"DELETE /domains/{domain_id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain_id"],"properties":{"domain_id":{"type":"string","description":"Unique identifier for a domain."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:lob/domain-list":{"get":{"operationId":"business_lob_domain_list","summary":"List all domains","description":"GET /domains","tags":["business"],"parameters":[{"name":"limit","in":"query","required":false,"description":"How many results to return.","schema":{"type":"integer","default":10,"description":"How many results to return."}},{"name":"before/after","in":"query","required":false,"description":"`before` and `after` are both optional but only one of them can be in the query at a time.","schema":{"type":"string","description":"`before` and `after` are both optional but only one of them can be in the query at a time."}},{"name":"status","in":"query","required":false,"description":"Filter domains by their configuration status.","schema":{"type":"string","enum":["configured","not_configured"],"description":"Filter domains by their configuration status."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:lob/domain-create":{"post":{"operationId":"business_lob_domain_create","summary":"Create Domain","description":"POST /domains","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:lob/links-get":{"get":{"operationId":"business_lob_links_get","summary":"Retrieve a link","description":"GET /links/{link_id}","tags":["business"],"parameters":[{"name":"link_id","in":"query","required":true,"description":"Unique identifier for a link.","schema":{"type":"string","description":"Unique identifier for a link."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:lob/link-update":{"post":{"operationId":"business_lob_link_update","summary":"Update a Link","description":"PATCH /links/{link_id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["link_id","body"],"properties":{"link_id":{"type":"string","description":"Unique identifier for a link."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:lob/links-delete":{"post":{"operationId":"business_lob_links_delete","summary":"Delete Link","description":"DELETE /links/{link_id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["link_id"],"properties":{"link_id":{"type":"string","description":"Unique identifier for a link."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:lob/links-list":{"get":{"operationId":"business_lob_links_list","summary":"List all links","description":"GET /links","tags":["business"],"parameters":[{"name":"limit","in":"query","required":false,"description":"How many results to return.","schema":{"type":"integer","default":10,"description":"How many results to return."}},{"name":"before/after","in":"query","required":false,"description":"`before` and `after` are both optional but only one of them can be in the query at a time.","schema":{"type":"string","description":"`before` and `after` are both optional but only one of them can be in the query at a time."}},{"name":"campaign_id","in":"query","required":false,"description":"Filters resources created by the provided campaign id, prefixed with `cmp_`. In the case of snap packs, booklets, and letters with size…","schema":{"type":"string","description":"Filters resources created by the provided campaign id, prefixed with `cmp_`. In the case of snap packs, booklets, and letters with size…"}},{"name":"domain_id","in":"query","required":false,"description":"Filters links by the provided domain id.","schema":{"type":"string","description":"Filters links by the provided domain id."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:lob/link-create":{"post":{"operationId":"business_lob_link_create","summary":"Create Link","description":"POST /links","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:lob/resource-proof-retrieve":{"get":{"operationId":"business_lob_resource_proof_retrieve","summary":"Retrieve","description":"GET /resource_proofs/{res_prf_id}","tags":["business"],"parameters":[{"name":"res_prf_id","in":"query","required":true,"description":"id of the resource proof","schema":{"type":"string","description":"id of the resource proof"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:lob/resource-proof-update":{"post":{"operationId":"business_lob_resource_proof_update","summary":"Update","description":"PATCH /resource_proofs/{res_prf_id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["res_prf_id","body"],"properties":{"res_prf_id":{"type":"string","description":"id of the resource proof"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:lob/resource-proof-create":{"post":{"operationId":"business_lob_resource_proof_create","summary":"Create","description":"POST /resource_proofs","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:lob/self-mailer-retrieve":{"get":{"operationId":"business_lob_self_mailer_retrieve","summary":"Retrieve","description":"GET /self_mailers/{sfm_id}","tags":["business"],"parameters":[{"name":"sfm_id","in":"query","required":true,"description":"id of the self_mailer","schema":{"type":"string","description":"id of the self_mailer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:lob/self-mailer-delete":{"post":{"operationId":"business_lob_self_mailer_delete","summary":"Delete","description":"DELETE /self_mailers/{sfm_id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["sfm_id"],"properties":{"sfm_id":{"type":"string","description":"id of the self_mailer"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:lob/self-mailers-list":{"get":{"operationId":"business_lob_self_mailers_list","summary":"List","description":"GET /self_mailers","tags":["business"],"parameters":[{"name":"limit","in":"query","required":false,"description":"How many results to return.","schema":{"type":"integer","default":10,"description":"How many results to return."}},{"name":"before/after","in":"query","required":false,"description":"`before` and `after` are both optional but only one of them can be in the query at a time.","schema":{"type":"string","description":"`before` and `after` are both optional but only one of them can be in the query at a time."}},{"name":"include","in":"query","required":false,"description":"Request that the response include the total count by specifying `include=[\"total_count\"]`.","schema":{"type":"array","description":"Request that the response include the total count by specifying `include=[\"total_count\"]`."}},{"name":"date_created","in":"query","required":false,"description":"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…","schema":{"type":"object","description":"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…"}},{"name":"metadata","in":"query","required":false,"description":"Filter by metadata key-value pair`.","schema":{"type":"object","description":"Filter by metadata key-value pair`."}},{"name":"size","in":"query","required":false,"description":"The self mailer sizes to be returned.","schema":{"type":"array","description":"The self mailer sizes to be returned."}},{"name":"scheduled","in":"query","required":false,"description":"* `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where…","schema":{"type":"boolean","description":"* `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where…"}},{"name":"send_date","in":"query","required":false,"description":"Filter by ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥,…","schema":{"type":"string","description":"Filter by ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥,…"}},{"name":"mail_type","in":"query","required":false,"description":"A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a cheaper option which is less…","schema":{"type":"string","enum":["usps_first_class","usps_standard"],"default":"usps_first_class","description":"A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a cheaper option which is less…"}},{"name":"sort_by","in":"query","required":false,"description":"Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both.","schema":{"type":"string","description":"Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both."}},{"name":"campaign_id","in":"query","required":false,"description":"Filters resources created by the provided campaign id, prefixed with `cmp_`. In the case of snap packs, booklets, and letters with size…","schema":{"type":"string","description":"Filters resources created by the provided campaign id, prefixed with `cmp_`. In the case of snap packs, booklets, and letters with size…"}},{"name":"status","in":"query","required":false,"description":"A string describing the render status: * `processed` - the rendering process is currently underway. * `rendered` - the rendering process…","schema":{"type":"string","enum":["processed","rendered","failed"],"description":"A string describing the render status: * `processed` - the rendering process is currently underway. * `rendered` - the rendering process…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:lob/self-mailer-create":{"post":{"operationId":"business_lob_self_mailer_create","summary":"Create","description":"POST /self_mailers","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"Idempotency-Key":{"type":"string","description":"A string of no longer than 256 characters that uniquely identifies this resource. For more help integrating idempotency keys, refer to our…"},"idempotency_key":{"type":"string","description":"A string of no longer than 256 characters that uniquely identifies this resource. For more help integrating idempotency keys, refer to our…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:lob/snap-pack-retrieve":{"get":{"operationId":"business_lob_snap_pack_retrieve","summary":"Retrieve","description":"GET /snap_packs/{snap_pack_id}","tags":["business"],"parameters":[{"name":"snap_pack_id","in":"query","required":true,"description":"id of the snap_pack","schema":{"type":"string","description":"id of the snap_pack"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:lob/snap-pack-delete":{"post":{"operationId":"business_lob_snap_pack_delete","summary":"Delete","description":"DELETE /snap_packs/{snap_pack_id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["snap_pack_id"],"properties":{"snap_pack_id":{"type":"string","description":"id of the snap_pack"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:lob/snap-packs-list":{"get":{"operationId":"business_lob_snap_packs_list","summary":"List","description":"GET /snap_packs","tags":["business"],"parameters":[{"name":"limit","in":"query","required":false,"description":"How many results to return.","schema":{"type":"integer","default":10,"description":"How many results to return."}},{"name":"before/after","in":"query","required":false,"description":"`before` and `after` are both optional but only one of them can be in the query at a time.","schema":{"type":"string","description":"`before` and `after` are both optional but only one of them can be in the query at a time."}},{"name":"include","in":"query","required":false,"description":"Request that the response include the total count by specifying `include=[\"total_count\"]`.","schema":{"type":"array","description":"Request that the response include the total count by specifying `include=[\"total_count\"]`."}},{"name":"date_created","in":"query","required":false,"description":"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…","schema":{"type":"object","description":"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…"}},{"name":"metadata","in":"query","required":false,"description":"Filter by metadata key-value pair`.","schema":{"type":"object","description":"Filter by metadata key-value pair`."}},{"name":"send_date","in":"query","required":false,"description":"Filter by ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥,…","schema":{"type":"string","description":"Filter by ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥,…"}},{"name":"mail_type","in":"query","required":false,"description":"A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a cheaper option which is less…","schema":{"type":"string","enum":["usps_first_class","usps_standard"],"default":"usps_first_class","description":"A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a cheaper option which is less…"}},{"name":"sort_by","in":"query","required":false,"description":"Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both.","schema":{"type":"string","description":"Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both."}},{"name":"campaign_id","in":"query","required":false,"description":"Filters resources created by the provided campaign id, prefixed with `cmp_`. In the case of snap packs, booklets, and letters with size…","schema":{"type":"string","description":"Filters resources created by the provided campaign id, prefixed with `cmp_`. In the case of snap packs, booklets, and letters with size…"}},{"name":"status","in":"query","required":false,"description":"A string describing the render status: * `processed` - the rendering process is currently underway. * `rendered` - the rendering process…","schema":{"type":"string","enum":["processed","rendered","failed"],"description":"A string describing the render status: * `processed` - the rendering process is currently underway. * `rendered` - the rendering process…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:lob/snap-pack-create":{"post":{"operationId":"business_lob_snap_pack_create","summary":"Create","description":"POST /snap_packs","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"Idempotency-Key":{"type":"string","description":"A string of no longer than 256 characters that uniquely identifies this resource. For more help integrating idempotency keys, refer to our…"},"idempotency_key":{"type":"string","description":"A string of no longer than 256 characters that uniquely identifies this resource. For more help integrating idempotency keys, refer to our…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:lob/template-version-retrieve":{"get":{"operationId":"business_lob_template_version_retrieve","summary":"Retrieve","description":"GET /templates/{tmpl_id}/versions/{vrsn_id}","tags":["business"],"parameters":[{"name":"tmpl_id","in":"query","required":true,"description":"The ID of the template to which the version belongs.","schema":{"type":"string","description":"The ID of the template to which the version belongs."}},{"name":"vrsn_id","in":"query","required":true,"description":"id of the template_version","schema":{"type":"string","description":"id of the template_version"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:lob/template-version-update":{"post":{"operationId":"business_lob_template_version_update","summary":"Update","description":"POST /templates/{tmpl_id}/versions/{vrsn_id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["tmpl_id","vrsn_id","body"],"properties":{"tmpl_id":{"type":"string","description":"The ID of the template to which the version belongs."},"vrsn_id":{"type":"string","description":"id of the template_version"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:lob/template-version-delete":{"post":{"operationId":"business_lob_template_version_delete","summary":"Delete","description":"DELETE /templates/{tmpl_id}/versions/{vrsn_id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["tmpl_id","vrsn_id"],"properties":{"tmpl_id":{"type":"string","description":"The ID of the template to which the version belongs."},"vrsn_id":{"type":"string","description":"id of the template_version"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:lob/template-versions-list":{"get":{"operationId":"business_lob_template_versions_list","summary":"List","description":"GET /templates/{tmpl_id}/versions","tags":["business"],"parameters":[{"name":"tmpl_id","in":"query","required":true,"description":"The ID of the template associated with the retrieved versions","schema":{"type":"string","description":"The ID of the template associated with the retrieved versions"}},{"name":"limit","in":"query","required":false,"description":"How many results to return.","schema":{"type":"integer","default":10,"description":"How many results to return."}},{"name":"before/after","in":"query","required":false,"description":"`before` and `after` are both optional but only one of them can be in the query at a time.","schema":{"type":"string","description":"`before` and `after` are both optional but only one of them can be in the query at a time."}},{"name":"include","in":"query","required":false,"description":"Request that the response include the total count by specifying `include=[\"total_count\"]`.","schema":{"type":"array","description":"Request that the response include the total count by specifying `include=[\"total_count\"]`."}},{"name":"date_created","in":"query","required":false,"description":"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…","schema":{"type":"object","description":"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…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:lob/create-template-version":{"post":{"operationId":"business_lob_create_template_version","summary":"Create","description":"POST /templates/{tmpl_id}/versions","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["tmpl_id","body"],"properties":{"tmpl_id":{"type":"string","description":"The ID of the template the new version will be attached to"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:lob/template-retrieve":{"get":{"operationId":"business_lob_template_retrieve","summary":"Retrieve","description":"GET /templates/{tmpl_id}","tags":["business"],"parameters":[{"name":"tmpl_id","in":"query","required":true,"description":"id of the template","schema":{"type":"string","description":"id of the template"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:lob/template-update":{"post":{"operationId":"business_lob_template_update","summary":"Update","description":"POST /templates/{tmpl_id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["tmpl_id","body"],"properties":{"tmpl_id":{"type":"string","description":"id of the template"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:lob/template-delete":{"post":{"operationId":"business_lob_template_delete","summary":"Delete","description":"DELETE /templates/{tmpl_id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["tmpl_id"],"properties":{"tmpl_id":{"type":"string","description":"id of the template"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:lob/templates-list":{"get":{"operationId":"business_lob_templates_list","summary":"List","description":"GET /templates","tags":["business"],"parameters":[{"name":"limit","in":"query","required":false,"description":"How many results to return.","schema":{"type":"integer","default":10,"description":"How many results to return."}},{"name":"before/after","in":"query","required":false,"description":"`before` and `after` are both optional but only one of them can be in the query at a time.","schema":{"type":"string","description":"`before` and `after` are both optional but only one of them can be in the query at a time."}},{"name":"include","in":"query","required":false,"description":"Request that the response include the total count by specifying `include=[\"total_count\"]`.","schema":{"type":"array","description":"Request that the response include the total count by specifying `include=[\"total_count\"]`."}},{"name":"date_created","in":"query","required":false,"description":"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…","schema":{"type":"object","description":"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…"}},{"name":"metadata","in":"query","required":false,"description":"Filter by metadata key-value pair`.","schema":{"type":"object","description":"Filter by metadata key-value pair`."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:lob/create-template":{"post":{"operationId":"business_lob_create_template","summary":"Create","description":"POST /templates","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:lob/uploads-list":{"get":{"operationId":"business_lob_uploads_list","summary":"List","description":"GET /uploads","tags":["business"],"parameters":[{"name":"campaignId","in":"query","required":false,"description":"id of the campaign","schema":{"type":"string","description":"id of the campaign"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:lob/upload-create":{"post":{"operationId":"business_lob_upload_create","summary":"Create","description":"POST /uploads","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:lob/upload-retrieve":{"get":{"operationId":"business_lob_upload_retrieve","summary":"Retrieve","description":"GET /uploads/{upl_id}","tags":["business"],"parameters":[{"name":"upl_id","in":"query","required":true,"description":"id of the upload","schema":{"type":"string","description":"id of the upload"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:lob/upload-update":{"post":{"operationId":"business_lob_upload_update","summary":"Update","description":"PATCH /uploads/{upl_id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["upl_id","body"],"properties":{"upl_id":{"type":"string","description":"id of the upload"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:lob/upload-delete":{"post":{"operationId":"business_lob_upload_delete","summary":"Delete","description":"DELETE /uploads/{upl_id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["upl_id"],"properties":{"upl_id":{"type":"string","description":"id of the upload"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:lob/upload-file":{"post":{"operationId":"business_lob_upload_file","summary":"Upload file","description":"POST /uploads/{upl_id}/file","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["upl_id","body"],"properties":{"upl_id":{"type":"string","description":"ID of the upload"},"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:lob/upload-export-create":{"post":{"operationId":"business_lob_upload_export_create","summary":"Create Export","description":"POST /uploads/{upl_id}/exports","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["upl_id","body"],"properties":{"upl_id":{"type":"string","description":"ID of the upload"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:lob/report-retrieve":{"get":{"operationId":"business_lob_report_retrieve","summary":"Retrieve Line Item Report","description":"GET /uploads/{upl_id}/report","tags":["business"],"parameters":[{"name":"upl_id","in":"query","required":true,"description":"ID of the upload","schema":{"type":"string","description":"ID of the upload"}},{"name":"status","in":"query","required":false,"description":"The status of line items to filter and retrieve. By default all line items are returned.","schema":{"type":"string","enum":["Validated","Failed","Processing"],"description":"The status of line items to filter and retrieve. By default all line items are returned."}},{"name":"limit","in":"query","required":false,"description":"How many results to return.","schema":{"type":"integer","default":100,"description":"How many results to return."}},{"name":"offset","in":"query","required":false,"description":"An integer that designates the offset at which to begin returning results. Defaults to 0.","schema":{"type":"integer","default":0,"description":"An integer that designates the offset at which to begin returning results. Defaults to 0."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:lob/export-retrieve":{"get":{"operationId":"business_lob_export_retrieve","summary":"Retrieve Export","description":"GET /uploads/{upl_id}/exports/{ex_id}","tags":["business"],"parameters":[{"name":"upl_id","in":"query","required":true,"description":"ID of the upload","schema":{"type":"string","description":"ID of the upload"}},{"name":"ex_id","in":"query","required":true,"description":"ID of the export","schema":{"type":"string","description":"ID of the export"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:lob/autocompletion":{"post":{"operationId":"business_lob_autocompletion","summary":"Autocomplete","description":"POST /us_autocompletions","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"case":{"type":"string","enum":["upper","proper"],"default":"upper","description":"Casing of the verified address. Possible values are `upper` and `proper` for uppercased (e.g. \"PO BOX\") and proper-cased (e.g. \"PO Box\"),…"},"valid_addresses":{"type":"boolean","enum":[true,false],"default":false,"description":"Possible values are `true` and `false`. If false, not all of the suggestions in the response will be valid addresses; they'll need to be…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:lob/reverse-geocode-lookup":{"post":{"operationId":"business_lob_reverse_geocode_lookup","summary":"Reverse Geocode Lookup","description":"POST /us_reverse_geocode_lookups","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"size":{"type":"integer","default":5,"description":"Determines the number of locations returned. Possible values are between 1 and 50 and any number higher will be rounded down to 50.…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:lob/us-verification":{"post":{"operationId":"business_lob_us_verification","summary":"Single Verify","description":"POST /us_verifications","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"case":{"type":"string","enum":["upper","proper"],"default":"upper","description":"Casing of the verified address. Possible values are `upper` and `proper` for uppercased (e.g. \"PO BOX\") and proper-cased (e.g. \"PO Box\"),…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:lob/zip-lookup":{"post":{"operationId":"business_lob_zip_lookup","summary":"Lookups","description":"POST /us_zip_lookups","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}