> ## Documentation Index
> Fetch the complete documentation index at: https://docs.apostra.com/llms.txt
> Use this file to discover all available pages before exploring further.

# V3 response variants

> Literal values that identify successful V3 read and save responses.

Use the literal field in this table to identify a successful V3 response before
reading fields that belong only to that response variant. Strict response
validators must accept every value used by the tools they call.

| Tool | Literal field | Successful response variants |
| - | - | - |
| `get` | `outcome` | `object` for a normal noun read; `billing_readiness` for an organisation billing document; `billing_managed` when another organisation manages billing. The normal read also returns its noun in `kind`. |
| `search` | `objects.outcome`; `objects.sections[].outcome` when `objects.outcome` is `mixed` | At `objects.outcome`, use `page_<kind>` for one noun page, `library_browse` for a Library material browse, or `mixed` for a mixed result. Inside a mixed result, each `objects.sections[].outcome` is `page_<kind>` or `unavailable_<kind>`. A noun page has `results`; a mixed result has one or more `sections`. A [grouped count](https://docs.apostra.com/v3/count-with-search.md) is a `page_<kind>` with `groups` and `total` in place of `results`. |
| `get_delivery` | `report` | `delivery`, `campaign_delivery`, `margin`, or `live_campaign_delivery`. |
| `save_advertiser` | `action` | `preview`, `created`, `updated`, `unchanged`, `restored`, `bulk_archived`, `bulk_restored`, `needs_input`, `account_assigned`, `reporting_bucket_updated`, or `account_unassigned`. Bulk archive and restore used `archived` and `restored` before this release. |
| `save_campaign` | `action` | `archived`, `created`, `updated`, `activated`, `restored`, `canceled`, `cancellation_requested`, `pending_approval`, `pending_confirmation`, `created_readback_required`, or `restored_readback_required`. The two read-back-required receipts contain `campaignId`; read that campaign before making another change. |
| `save_creative` | `action` | `created`, `updated`, `associated`, `membership_updated`, `library_role_updated`, or `archived`. |
| `save_connection` | `action` | `authorization_required`, `selection_updated`, `advertiser_activation_updated`, `billing_updated`, `direct_billing_accepted`, `feature_policy_updated`, `enhanced_reporting_updated`, `accounts_refreshed`, `account_selected`, `advertiser_mapped`, `advertiser_unmapped`, or `removed`. |
| `save_billing` | `action` | `terms_accepted`, `terms_not_required`, `payment_terms_saved`, `billing_saved` when one call writes both Terms and payment terms, `approval_required` when a `plan`, a `paymentTerms` choice, a `renewal` change, a `paymentMethod` removal or a `payNow` waits for an administrator to approve it on the Apostra site, `plan_accepted` once a plan has been approved, `payment_method_removed` once a card removal has been approved, `pay_now_started` once a pay now has been approved and the charge started (it is not paid until the payment provider confirms it), `payer_saved` when a `payer` change is saved, `offer_response_recorded`, or `renewal_changed`. The output schema also declares `confirmation_required`, `human_action_required`, `payment_authority_pending`, `payment_authority_opened`, `payment_authority_verified` and `payment_authority_expired`, which only the removed earlier shape (`operation`, `paymentAuthority`) returned; `save_billing` no longer returns them. |
| `request_payment_authority` | `action` | `approval_required` while an administrator has not approved the card setup, with the `idempotencyKey` to read it again; `confirmation_required` once it is approved, with the confirmation token. |
| `confirm_payment_authority` | `action` | `human_action_required`. |

These variants describe successful calls. Error responses use the V3 error
envelope described in [Errors](https://docs.apostra.com/v3/errors.md).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.