Search by

Official Reacon API client for PHP

v4.0.0-beta.1 2026-10-04 07:13 UTC

This package is auto-updated.

Last update: 2026-10-04 07:16:35 UTC


README

Package reacon-io/sdk, version 4.0.0-beta.1.

Minimum runtime: PHP 8.1.

API reference and SDK examples. Select your language on an endpoint page for SDK calls and response schemas.

The SDK connects to https://api.reacon.io. The API address is built in and cannot be overridden. Configure your API key as shown in your language’s examples; do not pass a base URL.

API keys are secrets. Load your key from an environment variable or secret manager and pass it through the SDK authentication configuration. Do not commit keys or include them in browser or mobile application bundles. The examples use REACON_API_KEY; the SDK does not load this environment variable automatically.

SDK package versions and API path versions are separate. The generated methods already select their API paths; do not derive an API path such as /v2 from the package’s major version.

Prerelease packages may become available before the matching API changes are deployed. Package availability alone does not mean those changes are ready in production. Use the package versions shown in the production API documentation for the currently supported release; try newer prereleases only when their matching API changes are available.

Package managers can exclude prereleases from their default version selection. To test a prerelease, install its explicit version from the matching documentation instead of relying on a latest or unversioned install.

List methods can return one page of results. Use the pagination parameters and continuation fields documented for that operation; an empty page or a short page is not a universal end-of-list signal. Keep the same filters and ordering when following a continuation, and set an application-specific page or result limit.

For reproducible deployments, commit your dependency lockfile or pin the package version in your build configuration. Review the API reference and run your application’s integration tests before upgrading the SDK.

Installation

composer require reacon-io/sdk:4.0.0-beta.1

Requires PHP 8.1 or later. Composer resolves the package from Packagist.

Getting Started

<?php
require __DIR__.'/vendor/autoload.php';

$config = (new Reacon\Sdk\Configuration())
    ->setApiKey('X-API-Key', getenv('REACON_API_KEY'))
    ->setRequestTimeout(30.0);
$domains = new Reacon\Sdk\Api\DomainsApi(null, $config);
$result = $domains->withRequestTimeout(5.0)->getDomainCatchAll('example.com');

JSON and CSV calls have a 30-second network deadline, including complete body reads and time spent queued before the event loop starts. Positive finite seconds are required. withRequestTimeout clones the resource and configuration, leaving the original and any shared client unchanged. Calls buffer the body; use Streaming\VerificationStreamClient for SSE.

Async operation methods return Guzzle promises. Call cancel() on a pending promise to close its transfer; cancellation remains a native Guzzle CancellationException. Drive the Guzzle event loop or call wait() to execute pending asynchronous work. Chain asynchronous operations from promise callbacks; do not call blocking wait() from a promise or transport callback. PHP cannot progress a transfer while the process is busy elsewhere.

Catch Http\RequestTimeoutException for a deadline and Http\TransportException for transport failures. Both preserve the native cause through getPrevious(). HTTP failures use Http\ResponseException (an ApiException) with getCode() as HTTP status, getResponseHeaders(), original getResponseBody(), parsedBody(), requestId() and errorCode(). Http\ResponseDecodeException retains a successful HTTP response and its decoding cause. Error messages avoid including request URLs; the native cause may contain a URL, so redact it before logging.

There are no automatic SDK retries or redirects. The owned cURL transport uses fresh HTTP/1.1 connections to prevent implicit replay on stale pooled sockets. This trades connection reuse for predictable single-attempt requests, including billable GETs. TLS verification remains enabled. To customize CA/proxy settings, create a client with Http\RequestPolicy::client(['verify' => '/path/to/ca.pem']) and pass it as the resource constructor's first argument. The SDK never closes or mutates a caller-owned client. An injected custom handler is responsible for honoring timeout, cancellation, redirect and retry options.

API Endpoints

All URIs are relative to https://api.reacon.io

Class Method HTTP request Description
CompaniesApi listCompanies GET /v1/companies List companies
DomainsApi getDomainCatchAll GET /v1/domains/{domain}/catch-all Read domain catch-all status
DomainsApi getDomainCompanyContext GET /v1/domains/{domain}/company-context Get company context for a domain
DomainsApi getDomainCounts GET /v1/domains/{domain}/counts Count known emails for a domain
EmailsApi deleteEmail DELETE /v1/emails/{email} Delete an email and its mentions
EmailsApi listEmailMentions GET /v1/emails/{email}/mentions List sources mentioning an email
EmailsApi listEmails GET /v1/emails List and reveal emails for a domain
EmailsApi revealEmail GET /v1/emails/{email} Reveal an email profile
EmailsApi revealEmailById GET /v1/emails/id/{id} Reveal an email profile by ID
IdentityApi getApiKeyIdentity GET /v1/whoami Get API-key identity
InsightsApi getEmailInsights GET /v1/insights/{email} Extract insights associated with an email
IntegrationsApi bindTypeformForm POST /v1/teams/{teamId}/integrations/typeform/oauth/bind Bind a Typeform OAuth form
IntegrationsApi bindWebflowForm POST /v1/teams/{teamId}/integrations/webflow/oauth/bind Bind a Webflow OAuth form
IntegrationsApi cancelIntegrationJob POST /v1/teams/{teamId}/integrations/jobs/{jobId}/cancel Cancel an integration job
IntegrationsApi configureAirtableMapping POST /v1/teams/{teamId}/integrations/connections/{connectionId}/airtable-mapping/configure Configure Airtable field mapping
IntegrationsApi configureCoda POST /v1/teams/{teamId}/integrations/coda Configure a Coda connection
IntegrationsApi configureCrmMapping POST /v1/teams/{teamId}/integrations/connections/{connectionId}/crm-mapping/configure Configure CRM field mapping
IntegrationsApi configureCrmSync POST /v1/teams/{teamId}/integrations/connections/{connectionId}/crm-sync/configure Configure CRM synchronization
IntegrationsApi configureFreshsales POST /v1/teams/{teamId}/integrations/freshsales Configure a Freshsales connection
IntegrationsApi configureNotificationRoutes POST /v1/teams/{teamId}/integrations/connections/{connectionId}/notification-routes Configure notification routes
IntegrationsApi configureSlackDestination POST /v1/teams/{teamId}/integrations/connections/{connectionId}/slack-destination Configure a Slack destination
IntegrationsApi configureTeamsWorkflow POST /v1/teams/{teamId}/integrations/microsoft-teams Configure a Microsoft Teams workflow
IntegrationsApi configureTypeformForm POST /v1/teams/{teamId}/integrations/typeform Configure a Typeform form
IntegrationsApi configureWarehouse POST /v1/teams/{teamId}/integrations/warehouses Configure a warehouse connection
IntegrationsApi configureWebflowForm POST /v1/teams/{teamId}/integrations/webflow Configure a Webflow form
IntegrationsApi disableMcpIdentity DELETE /v1/teams/{teamId}/integrations/mcp-identities/{identityId} Disable an MCP identity
IntegrationsApi executeIntegrationCapability POST /v1/actions/{capability} Execute an integration capability
IntegrationsApi getAirtableMappingOptions GET /v1/teams/{teamId}/integrations/connections/{connectionId}/airtable-mapping-options Get Airtable mapping options
IntegrationsApi getCrmMappingOptions GET /v1/teams/{teamId}/integrations/connections/{connectionId}/crm-mapping-options Get CRM mapping options
IntegrationsApi getHubSpotConfigurationOptions GET /v1/teams/{teamId}/integrations/connections/{connectionId}/hubspot-configuration-options Get HubSpot configuration options
IntegrationsApi getIntegrationJob GET /v1/teams/{teamId}/integrations/jobs/{jobId} Get an integration job
IntegrationsApi inspectCodaTable POST /v1/teams/{teamId}/integrations/coda/inspect Inspect Coda table columns
IntegrationsApi inspectExcelWorkbook POST /v1/teams/{teamId}/integrations/microsoft-excel/inspect Inspect an Excel workbook
IntegrationsApi inspectGoogleSheet POST /v1/teams/{teamId}/integrations/google-sheets/inspect Inspect a Google spreadsheet
IntegrationsApi linkMcpIdentity POST /v1/teams/{teamId}/integrations/mcp-identities Link an MCP identity
IntegrationsApi listIntegrationConnections GET /v1/teams/{teamId}/integrations/connections List integration connections
IntegrationsApi listIntegrationJobs GET /v1/teams/{teamId}/integrations/jobs List integration jobs
IntegrationsApi listIntegrationProviders GET /v1/integrations/providers List integration providers
IntegrationsApi listMcpIdentities GET /v1/teams/{teamId}/integrations/mcp-identities List linked MCP identities
IntegrationsApi listSheetWorkflows GET /v1/teams/{teamId}/integrations/spreadsheet-workflows List spreadsheet workflows
IntegrationsApi previewSheetWorkflow POST /v1/teams/{teamId}/integrations/spreadsheet-workflows/{workflowId}/preview Preview spreadsheet workflow inputs
IntegrationsApi queueIntegrationLeadExport POST /v1/teams/{teamId}/integrations/connections/{connectionId}/export-leads Queue lead export to an integration
IntegrationsApi queueNotificationTest POST /v1/teams/{teamId}/integrations/connections/{connectionId}/notification-test Queue a test notification
IntegrationsApi rotateCodaCredential POST /v1/teams/{teamId}/integrations/connections/{connectionId}/credentials/coda/rotate Rotate a Coda credential
IntegrationsApi rotateFreshsalesCredential POST /v1/teams/{teamId}/integrations/connections/{connectionId}/credentials/freshsales/rotate Rotate a Freshsales credential
IntegrationsApi runSheetWorkflow POST /v1/teams/{teamId}/integrations/spreadsheet-workflows/{workflowId}/run Queue a spreadsheet workflow
IntegrationsApi saveSheetWorkflow POST /v1/teams/{teamId}/integrations/spreadsheet-workflows Create or update a spreadsheet workflow
IntegrationsApi startAttioOAuth POST /v1/teams/{teamId}/integrations/attio/oauth/start Start Attio authorization
IntegrationsApi startGoogleSheetsOAuth POST /v1/teams/{teamId}/integrations/google-sheets/oauth/start Start Google Sheets authorization
IntegrationsApi startIntegrationOAuth POST /v1/teams/{teamId}/integrations/{provider}/oauth/start Start provider authorization
IntegrationsApi testIntegrationConnection POST /v1/teams/{teamId}/integrations/connections/{connectionId}/test Test an integration connection
IntegrationsApi updateIntegrationConnectionState POST /v1/teams/{teamId}/integrations/connections/{connectionId}/state Change integration connection state
IntegrationsApi updateSheetWorkflowState POST /v1/teams/{teamId}/integrations/spreadsheet-workflows/{workflowId}/state Change spreadsheet workflow state
LeadsApi createLead POST /v1/teams/{teamId}/leads Create a lead in a team
LeadsApi deleteLead DELETE /v1/leads/{leadId} Delete a lead
LeadsApi exportLeads POST /v1/teams/{teamId}/leads/export Export selected leads
LeadsApi getLead GET /v1/leads/{leadId} Retrieve a lead
LeadsApi listLeads GET /v1/teams/{teamId}/leads List team leads
LeadsApi updateLead POST /v1/leads/{leadId}/update Update a lead
MailApi addMailPortfolioTeam POST /v1/teams/{teamId}/mail/portfolio/teams Add a team to a portfolio
MailApi archiveMailExperiment POST /v1/teams/{teamId}/mail/experiments/{experimentKey}/archive Archive an experiment
MailApi cancelMailMessage POST /v1/teams/{teamId}/mail/messages/{messageId}/cancel Cancel a queued message
MailApi changeMailCadenceCampaignState POST /v1/teams/{teamId}/mail/cadence-campaigns/{campaignId}/state Change a cadence campaign state
MailApi changeMailCadenceRunState POST /v1/teams/{teamId}/mail/cadence-runs/{runId}/state Change a cadence run state
MailApi changeMailCampaignState POST /v1/teams/{teamId}/mail/campaigns/{campaignId}/state Change a campaign state
MailApi classifyMailReply POST /v1/teams/{teamId}/mail/crm/classify-reply Classify a reply
MailApi completeMailCrmTask POST /v1/teams/{teamId}/mail/crm/tasks/{taskId}/complete Complete a CRM task
MailApi configureMailDeliverability POST /v1/teams/{teamId}/mail/deliverability/mailboxes/{mailboxId} Configure a mailbox sending ramp
MailApi configureMailTrackingDomain POST /v1/teams/{teamId}/mail/tracking-domain Configure a tracking domain
MailApi copyMailCadence POST /v1/teams/{teamId}/mail/cadences/{cadenceId}/copy Copy a cadence to another team
MailApi copyMailTemplate POST /v1/teams/{teamId}/mail/templates/{templateId}/copy Copy a template to another team
MailApi createMailCampaignDraft POST /v1/teams/{teamId}/mail/campaigns Create a campaign draft
MailApi createMailCrmNote POST /v1/teams/{teamId}/mail/crm/notes Add a contact note
MailApi createMailCrmTask POST /v1/teams/{teamId}/mail/crm/tasks Create a CRM task
MailApi createMailMailboxPool POST /v1/teams/{teamId}/mail/deliverability/pools Create a mailbox pool
MailApi createMailPortfolio POST /v1/teams/{teamId}/mail/portfolio Create a mail portfolio
MailApi createMailPortfolioSuppression POST /v1/teams/{teamId}/mail/portfolio/suppressions Create a portfolio suppression
MailApi createMailSuppression POST /v1/teams/{teamId}/mail/suppressions Suppress an email or domain
MailApi createMailWebhook POST /v1/teams/{teamId}/mail/webhooks Create a mail webhook
MailApi decideMailExperiment POST /v1/teams/{teamId}/mail/experiments/{experimentKey}/decide Record an experiment decision
MailApi deleteMailCampaignDraft DELETE /v1/teams/{teamId}/mail/campaigns/{campaignId} Delete a campaign draft
MailApi deleteMailReplyAutomation DELETE /v1/teams/{teamId}/mail/reply-automations/{automationId} Delete a reply automation
MailApi deleteMailTrackingDomain DELETE /v1/teams/{teamId}/mail/tracking-domain Delete a tracking domain
MailApi deleteMailWebhook DELETE /v1/teams/{teamId}/mail/webhooks/{subscriptionId} Delete a mail webhook
MailApi disconnectMailMailbox DELETE /v1/teams/{teamId}/mail/mailboxes/{mailboxId} Disconnect a mailbox
MailApi duplicateMailCampaignDraft POST /v1/teams/{teamId}/mail/campaigns/{campaignId}/duplicate Duplicate a campaign draft
MailApi enqueueMailMessage POST /v1/teams/{teamId}/mail/messages Queue an outbound message
MailApi enrollMailCadence POST /v1/teams/{teamId}/mail/cadence-runs Enroll contacts in a cadence
MailApi exportMailAnalytics POST /v1/teams/{teamId}/mail/analytics/export Export mail analytics
MailApi exportMailPortfolio POST /v1/teams/{teamId}/mail/portfolio/export Export portfolio analytics
MailApi getMailAnalytics GET /v1/teams/{teamId}/mail/analytics Get mail analytics
MailApi getMailCampaignDraft GET /v1/teams/{teamId}/mail/campaigns/{campaignId} Get a campaign draft
MailApi getMailCampaignProgress GET /v1/teams/{teamId}/mail/campaign-progress Get campaign progress
MailApi getMailChannels GET /v1/teams/{teamId}/mail/channels Get channel availability
MailApi getMailContactStates POST /v1/teams/{teamId}/mail/crm/states/batch Get contact CRM states in a batch
MailApi getMailContacts POST /v1/teams/{teamId}/mail/crm/contacts/batch Get mail contacts in a batch
MailApi getMailDeliverability GET /v1/teams/{teamId}/mail/deliverability Get deliverability configuration
MailApi getMailExperimentReport GET /v1/teams/{teamId}/mail/experiments/{experimentKey}/report Get an experiment report
MailApi getMailExperimentsOverview GET /v1/teams/{teamId}/mail/experiments-overview Get experiment overview
MailApi getMailOverview GET /v1/teams/{teamId}/mail/overview Get mail overview
MailApi getMailPortfolio GET /v1/teams/{teamId}/mail/portfolio Get a mail portfolio
MailApi getMailPortfolioOverview GET /v1/teams/{teamId}/mail/portfolio/overview Get portfolio analytics
MailApi getMailQueue GET /v1/teams/{teamId}/mail/queue Get mail queue status
MailApi getMailTrackingDomain GET /v1/teams/{teamId}/mail/tracking-domain Get tracking domain configuration
MailApi inspectMailDomainHealth POST /v1/teams/{teamId}/mail/deliverability/domain-health Inspect domain authentication
MailApi launchMailCadenceCampaign POST /v1/teams/{teamId}/mail/cadence-campaigns Queue a cadence campaign
MailApi launchMailCampaignDraft POST /v1/teams/{teamId}/mail/campaigns/{campaignId}/launch Launch a campaign draft
MailApi listMailAudienceLists GET /v1/teams/{teamId}/mail/audience-lists List campaign audience lists
MailApi listMailCadenceCampaigns GET /v1/teams/{teamId}/mail/cadence-campaigns List cadence campaigns
MailApi listMailCadenceRuns GET /v1/teams/{teamId}/mail/cadence-runs List cadence runs
MailApi listMailCadences GET /v1/teams/{teamId}/mail/cadences List cadences
MailApi listMailCampaignDrafts GET /v1/teams/{teamId}/mail/campaigns List campaign drafts
MailApi listMailContactStates GET /v1/teams/{teamId}/mail/crm/states List contact CRM states
MailApi listMailCrmTasks GET /v1/teams/{teamId}/mail/crm/tasks List CRM tasks
MailApi listMailCrmTimeline GET /v1/teams/{teamId}/mail/crm/timeline List CRM timeline events
MailApi listMailExperiments GET /v1/teams/{teamId}/mail/experiments List mail experiments
MailApi listMailInbox GET /v1/teams/{teamId}/mail/inbox List inbox messages
MailApi listMailInboxThreads GET /v1/teams/{teamId}/mail/inbox/threads List inbox conversation threads
MailApi listMailMailboxes GET /v1/teams/{teamId}/mail/mailboxes List mailboxes and connections
MailApi listMailMessages GET /v1/teams/{teamId}/mail/messages List mail delivery activity
MailApi listMailReplyAutomations GET /v1/teams/{teamId}/mail/reply-automations List reply automations
MailApi listMailSignatures GET /v1/teams/{teamId}/mail/signatures List extracted signatures
MailApi listMailSuppressions GET /v1/teams/{teamId}/mail/suppressions List mail suppressions
MailApi listMailTemplates GET /v1/teams/{teamId}/mail/templates List message templates
MailApi listMailWebhooks GET /v1/teams/{teamId}/mail/webhooks List mail webhooks and deliveries
MailApi pauseMailExperiment POST /v1/teams/{teamId}/mail/experiments/{experimentKey}/pause Pause an experiment
MailApi pauseMailMailbox POST /v1/teams/{teamId}/mail/deliverability/mailboxes/{mailboxId}/pause Pause a mailbox
MailApi preflightMailCadenceEnrollment POST /v1/teams/{teamId}/mail/cadence-runs/preflight Check cadence enrollment
MailApi provisionMailMailbox POST /v1/teams/{teamId}/mail/mailboxes/manual Connect an SMTP/IMAP mailbox
MailApi reconcileMailMailboxHealth POST /v1/teams/{teamId}/mail/deliverability/mailboxes/{mailboxId}/reconcile Reconcile mailbox health
MailApi reconcileMailWebhook POST /v1/teams/{teamId}/mail/webhooks/{subscriptionId}/reconcile Reconcile a mail webhook
MailApi recordMailExperimentConversion POST /v1/teams/{teamId}/mail/experiments/{experimentKey}/conversions Record an experiment conversion
MailApi removeMailMailboxPoolMember DELETE /v1/teams/{teamId}/mail/deliverability/pools/{poolId}/members/{mailboxId} Remove a mailbox pool member
MailApi removeMailPortfolioTeam DELETE /v1/teams/{teamId}/mail/portfolio/teams/{memberTeamId} Remove a team from a portfolio
MailApi replayMailWebhookDelivery POST /v1/teams/{teamId}/mail/webhooks/deliveries/{deliveryId}/replay Replay a webhook delivery
MailApi replyToMailInboxMessage POST /v1/teams/{teamId}/mail/inbox/{messageId}/reply Queue an inbox reply
MailApi resumeMailExperiment POST /v1/teams/{teamId}/mail/experiments/{experimentKey}/resume Resume an experiment
MailApi resumeMailMailbox POST /v1/teams/{teamId}/mail/deliverability/mailboxes/{mailboxId}/resume Resume a mailbox
MailApi retryMailMessage POST /v1/teams/{teamId}/mail/messages/{messageId}/retry Retry a message explicitly
MailApi rotateMailWebhookSecret POST /v1/teams/{teamId}/mail/webhooks/{subscriptionId}/rotate-secret Rotate a mail webhook secret
MailApi saveMailCadence POST /v1/teams/{teamId}/mail/cadences Save a cadence version
MailApi saveMailReplyAutomation POST /v1/teams/{teamId}/mail/reply-automations Save a reply automation
MailApi saveMailTemplate POST /v1/teams/{teamId}/mail/templates Save a message template
MailApi setMailContactState PUT /v1/teams/{teamId}/mail/crm/states Set a contact CRM state
MailApi setMailMailboxPoolMember PUT /v1/teams/{teamId}/mail/deliverability/pools/{poolId}/members/{mailboxId} Set a mailbox pool member
MailApi setMailWebhookStatus POST /v1/teams/{teamId}/mail/webhooks/{subscriptionId}/status Set a mail webhook status
MailApi startMailOAuth POST /v1/teams/{teamId}/mail/oauth/begin Start mailbox authorization
MailApi updateMailCampaignDraft PATCH /v1/teams/{teamId}/mail/campaigns/{campaignId} Update a campaign draft
MailApi updateMailInboxMessage POST /v1/teams/{teamId}/mail/inbox/{messageId} Update an inbox message
MailApi updateMailWebhook PATCH /v1/teams/{teamId}/mail/webhooks/{subscriptionId} Update a mail webhook
MailApi verifyMailTrackingDomain POST /v1/teams/{teamId}/mail/tracking-domain/verify Verify a tracking domain
NamesApi listNamePatterns GET /v1/name/schemas List supported email name patterns
NamesApi verifyName GET /v1/name/verify Verify name-based email patterns
ProductToolsApi executeProductTool POST /v1/product/tools/{tool} Execute a product tool
StatsApi getStats GET /v1/stats Get public dataset statistics
VerificationApi verifyBatch POST /v1/verify/batch Verify a batch of email addresses
VerificationApi verifyEmail GET /v1/verify Verify an email address
WebhooksApi createAutomationHook POST /v1/hooks Create an automation webhook
WebhooksApi createSegmentInstallation POST /v1/origin-installations/segment Create a Segment origin installation
WebhooksApi deleteAutomationHook DELETE /v1/hooks/{hookId} Delete an automation webhook
WebhooksApi deleteSegmentInstallation DELETE /v1/origin-installations/segment/{installationId} Delete a Segment origin installation

Models

  • AirtableMappingOptionsResponse
  • AirtableMappingOptionsResponseOptions
  • AirtableMappingOptionsResponseOptionsBasesInner
  • AirtableMappingOptionsResponseOptionsTablesInner
  • AirtableMappingOptionsResponseOptionsTablesInnerFieldsInner
  • ApiError
  • ApiKeyIdentity
  • ApiValidationIssue
  • AutomationHookCreated
  • BatchVerificationError
  • BatchVerificationItem
  • BatchVerificationRequest
  • BatchVerificationRequestOnlyIfFree
  • BatchVerificationResponse
  • BindTypeformFormRequest
  • BindWebflowFormRequest
  • CapabilityDomainSearch
  • CapabilityDomainSearchContactsInner
  • CapabilityEmailFound
  • CapabilityEmailVerified
  • CapabilityEmailVerifiedDetails
  • CodaTableInspectionResponse
  • CodaTableInspectionResponseInspection
  • CompanyContextAddress
  • CompanyContextJob
  • CompanyContextSource
  • CompanyList
  • CompanyListResultsInner
  • CompanyListResultsInnerAddressesInner
  • ConfigureAirtableMappingRequest
  • ConfigureCodaRequest
  • ConfigureCodaRequestMapping
  • ConfigureCrmMappingRequest
  • ConfigureCrmSyncRequest
  • ConfigureCrmSyncRequestConfiguration
  • ConfigureCrmSyncRequestConfigurationHubspot
  • ConfigureCrmSyncRequestConfigurationHubspotDeal
  • ConfigureCrmSyncRequestConfigurationPolicy
  • ConfigureFreshsalesRequest
  • ConfigureNotificationRoutesRequest
  • ConfigureSlackDestinationRequest
  • ConfigureTeamsWorkflowRequest
  • ConfigureTypeformFormRequest
  • ConfigureWarehouseRequest
  • ConfigureWebflowFormRequest
  • CreateAutomationHookRequest
  • CreateLeadRequest
  • CreateLeadRequestCompany
  • CreateLeadRequestPerson
  • CreateLeadResponse
  • CreateLeadResponseLead
  • CreateSegmentInstallationRequest
  • CrmMappingOptionsResponse
  • CrmMappingOptionsResponseOptions
  • CrmMappingOptionsResponseOptionsObjectsInner
  • CrmRemoteField
  • CrmSyncConfiguration
  • CrmSyncConfigurationHubspot
  • CrmSyncConfigurationHubspotDeal
  • CrmSyncConfigurationPolicy
  • CrmSyncConfigurationResponse
  • DeleteEmailResponse
  • DeleteLeadResponse
  • DomainCatchAll
  • DomainCompanyContext
  • DomainCompanyContextCompany
  • DomainCounts
  • EmailMention
  • EmailMentionsPage
  • EmailNotFoundError
  • EmailNotFoundErrorError
  • EmailPage
  • EmailPageResultsInner
  • EmailPageResultsInnerSourcesInner
  • EmailRevealResponse
  • EmailRevealResponseProfile
  • ExcelWorkbookInspectionResponse
  • ExcelWorkbookInspectionResponseInspection
  • ExecuteIntegrationCapabilityRequest
  • ExportLeadsRequest
  • ExportLeadsRequestSelectionScopesInner
  • GetLeadResponse
  • GetLeadResponseLead
  • GetLeadResponseLeadCompany
  • GetLeadResponseLeadSync
  • GetLeadResponseLeadVerification
  • GoogleSheetInspectionResponse
  • GoogleSheetInspectionResponseInspection
  • HubSpotConfigurationOptionsResponse
  • HubSpotConfigurationOptionsResponseOptions
  • HubSpotConfigurationOptionsResponseOptionsOwnersInner
  • HubSpotConfigurationOptionsResponseOptionsPipelinesInner
  • HubSpotConfigurationOptionsResponseOptionsPipelinesInnerStagesInner
  • InsightAddress
  • InsightAddressEntry
  • InsightAttribute
  • InsightErrorEvent
  • InsightEvidence
  • InsightFinalEvent
  • InsightGeo
  • InsightIdentifier
  • InsightJurisdiction
  • InsightMention
  • InsightMentionErrorEvent
  • InsightMentionExtractedEvent
  • InsightMentionInsightEvent
  • InsightOffice
  • InsightOrganization
  • InsightPhone
  • InsightPlatformDetectedEvent
  • InsightPlatformProgressEvent
  • InsightPlatformScan
  • InsightPlatformScanEvent
  • InsightRole
  • InsightSocialProfile
  • InsightSource
  • InsightStartedEvent
  • InsightsResponse
  • InspectCodaTableRequest
  • InspectExcelWorkbookRequest
  • InspectGoogleSheetRequest
  • IntegrationCapabilityResponse
  • IntegrationCapabilityResponseOutput
  • IntegrationCapabilityResponseOutputNonNull
  • IntegrationConnection
  • IntegrationConnectionHealth
  • IntegrationConnectionList
  • IntegrationConnectionResponse
  • IntegrationConnectionStateResponse
  • IntegrationConnectionTest
  • IntegrationConnectionTestResponse
  • IntegrationFormConnectionResponse
  • IntegrationJob
  • IntegrationJobCancellation
  • IntegrationJobCounters
  • IntegrationJobPage
  • IntegrationJobResponse
  • IntegrationLeadExportResponse
  • IntegrationOAuthStartResponse
  • IntegrationProviderList
  • IntegrationProviderListProvidersInner
  • IntegrationProviderListProvidersInnerConnectability
  • IntegrationProviderListProvidersInnerReadiness
  • LeadExportInner
  • LeadExportInnerCompany
  • LeadExportInnerPerson
  • LeadExportTooLargeError
  • LeadPage
  • LeadPageResultsInner
  • LeadPageResultsInnerCompany
  • LinkMcpIdentityRequest
  • MailCadenceCampaignRecord
  • MailCadenceDefinition
  • MailCadenceEnrollmentVariableGap
  • MailCadenceExperimentContext
  • MailCadenceMessageExperiment
  • MailCadenceMessageExperimentVariant
  • MailCadenceNode
  • MailCadenceNodeAnyOf
  • MailCadenceNodeAnyOf1
  • MailCadenceNodeAnyOf2
  • MailCadenceNodeAnyOf3
  • MailCadenceNodeAnyOf4
  • MailCadenceNodeAnyOf4AllOfCondition
  • MailCadenceNodeAnyOf5
  • MailCadenceNodeAnyOf6
  • MailCadenceNodeBase
  • MailCadenceRunRecord
  • MailCadenceStopConditions
  • MailCadenceWorkflowExperiment
  • MailCadenceWorkflowExperimentVariant
  • MailCampaignDraftRecord
  • MailCampaignDraftStep
  • MailCampaignProgress
  • MailCampaignProgressMessageCounts
  • MailContactCrmState
  • MailContactListSummaryRecord
  • MailContactRecord
  • MailConversationEntry
  • MailConversationEntryFrom
  • MailConversationEntryLastError
  • MailConversationEntryLastErrorAnyOf
  • MailConversationEntryLastErrorAnyOf1
  • MailConversationEntryLastErrorAnyOf2
  • MailConversationThread
  • MailCrmTask
  • MailCrmTimelineEvent
  • MailDeleteCampaignsByCampaignIdRequest
  • MailDeleteCampaignsByCampaignIdResponse200
  • MailDeleteDeliverabilityPoolsByPoolIdMembersByMailboxIdResponse200
  • MailDeleteMailboxesByMailboxIdResponse200
  • MailDeletePortfolioTeamsByMemberTeamIdResponse200
  • MailDeleteReplyAutomationsByAutomationIdResponse200
  • MailDeleteTrackingDomainResponse200
  • MailDeleteWebhooksBySubscriptionIdResponse200
  • MailDomainHealthCheck
  • MailDomainHealthReport
  • MailEvidenceField
  • MailExperimentDecisionRecord
  • MailExperimentDefinitionRecord
  • MailExperimentOutcomeRecord
  • MailExperimentReport
  • MailExperimentReportDecision
  • MailExperimentRevisionRecord
  • MailExperimentVariant
  • MailExperimentVariantReport
  • MailExperimentVariantReportConfidenceInterval95
  • MailExperimentVariantReportGuardrails
  • MailGetAnalyticsResponse200
  • MailGetAudienceListsResponse200
  • MailGetCadenceCampaignsResponse200
  • MailGetCadenceRunsResponse200
  • MailGetCadencesResponse200
  • MailGetCampaignProgressResponse200
  • MailGetCampaignsByCampaignIdResponse200
  • MailGetCampaignsResponse200
  • MailGetChannelsResponse200
  • MailGetChannelsResponse200Email
  • MailGetChannelsResponse200Execution
  • MailGetChannelsResponse200Sms
  • MailGetChannelsResponse200Whatsapp
  • MailGetCrmStatesResponse200
  • MailGetCrmTasksResponse200
  • MailGetCrmTimelineResponse200
  • MailGetDeliverabilityResponse200
  • MailGetDeliverabilityResponse200PoolsInner
  • MailGetExperimentsByExperimentKeyReportResponse200
  • MailGetExperimentsOverviewResponse200
  • MailGetExperimentsResponse200
  • MailGetExperimentsResponse200ResultsInner
  • MailGetInboxResponse200
  • MailGetInboxThreadsResponse200
  • MailGetMailboxesResponse200
  • MailGetMessagesResponse200
  • MailGetOverviewResponse200
  • MailGetOverviewResponse200Inbox
  • MailGetPortfolioOverviewResponse200
  • MailGetPortfolioResponse200
  • MailGetPortfolioResponse200AnyOf
  • MailGetPortfolioResponse200AnyOf1
  • MailGetPortfolioResponse200Portfolio
  • MailGetQueueResponse200
  • MailGetReplyAutomationsResponse200
  • MailGetSignaturesResponse200
  • MailGetSuppressionsResponse200
  • MailGetTemplatesResponse200
  • MailGetTrackingDomainResponse200
  • MailGetTrackingDomainResponse200Domain
  • MailGetWebhooksResponse200
  • MailGetWebhooksResponse200SubscriptionsInner
  • MailImapCursor
  • MailInboxMessageRecord
  • MailMailAddress
  • MailMailPortfolio
  • MailMailPortfolioOverviewRow
  • MailMailPortfolioSuppression
  • MailMailPortfolioTeam
  • MailMailboxConnectionRecord
  • MailMailboxHealthRecord
  • MailMailboxPoolMember
  • MailMailboxProviderKind
  • MailMailboxRecord
  • MailMessageAnalyticsOverview
  • MailMessageAnalyticsOverviewDailyInner
  • MailMessageAnalyticsOverviewMailboxesInner
  • MailMessageAnalyticsOverviewVariantsInner
  • MailMessagePolicy
  • MailMessagePolicyInput
  • MailMessageRecord
  • MailMessageTemplateVersion
  • MailMessageTemplateVersionWhatsappApproval
  • MailMessageVariantInput
  • MailOperationalAnalyticsOverview
  • MailOperationalAnalyticsOverviewCadenceStepsInner
  • MailPatchCampaignsByCampaignIdRequest
  • MailPatchCampaignsByCampaignIdRequestPolicy
  • MailPatchCampaignsByCampaignIdRequestPolicyDomainQuotasInner
  • MailPatchCampaignsByCampaignIdRequestPolicySendingWindowsInner
  • MailPatchCampaignsByCampaignIdRequestStepsInner
  • MailPatchCampaignsByCampaignIdRequestStepsInnerVariantsInner
  • MailPatchCampaignsByCampaignIdResponse200
  • MailPatchWebhooksBySubscriptionIdRequest
  • MailPatchWebhooksBySubscriptionIdResponse200
  • MailPhoneNumberValue
  • MailPostAnalyticsExportRequest
  • MailPostAnalyticsExportRequestAfter
  • MailPostAnalyticsExportResponse200
  • MailPostAnalyticsExportResponse200NextCursor
  • MailPostCadenceCampaignsByCampaignIdStateRequest
  • MailPostCadenceCampaignsByCampaignIdStateResponse200
  • MailPostCadenceCampaignsByCampaignIdStateResponse200AnyOf
  • MailPostCadenceCampaignsByCampaignIdStateResponse200AnyOf1
  • MailPostCadenceCampaignsRequest
  • MailPostCadenceCampaignsResponse202
  • MailPostCadenceRunsByRunIdStateRequest
  • MailPostCadenceRunsByRunIdStateResponse200
  • MailPostCadenceRunsPreflightRequest
  • MailPostCadenceRunsPreflightResponse200
  • MailPostCadenceRunsRequest
  • MailPostCadenceRunsResponse200
  • MailPostCadencesByCadenceIdCopyRequest
  • MailPostCadencesByCadenceIdCopyResponse200
  • MailPostCadencesRequest
  • MailPostCadencesRequestNodesInner
  • MailPostCadencesRequestNodesInnerAnyOf
  • MailPostCadencesRequestNodesInnerAnyOf1
  • MailPostCadencesRequestNodesInnerAnyOf1Experiment
  • MailPostCadencesRequestNodesInnerAnyOf1ExperimentVariantsInner
  • MailPostCadencesRequestNodesInnerAnyOf2
  • MailPostCadencesRequestNodesInnerAnyOf3
  • MailPostCadencesRequestNodesInnerAnyOf4
  • MailPostCadencesRequestNodesInnerAnyOf4Condition
  • MailPostCadencesRequestNodesInnerAnyOf5
  • MailPostCadencesRequestNodesInnerAnyOf5Experiment
  • MailPostCadencesRequestNodesInnerAnyOf5ExperimentVariantsInner
  • MailPostCadencesRequestNodesInnerAnyOf6
  • MailPostCadencesRequestStopConditions
  • MailPostCadencesResponse200
  • MailPostCampaignsByCampaignIdDuplicateResponse201
  • MailPostCampaignsByCampaignIdLaunchRequest
  • MailPostCampaignsByCampaignIdLaunchResponse200
  • MailPostCampaignsByCampaignIdLaunchResponse200Campaign
  • MailPostCampaignsByCampaignIdStateRequest
  • MailPostCampaignsByCampaignIdStateResponse200
  • MailPostCampaignsRequest
  • MailPostCampaignsResponse201
  • MailPostCrmClassifyReplyRequest
  • MailPostCrmClassifyReplyResponse200
  • MailPostCrmContactsBatchRequest
  • MailPostCrmContactsBatchResponse200
  • MailPostCrmNotesRequest
  • MailPostCrmNotesResponse200
  • MailPostCrmNotesResponse200Event
  • MailPostCrmNotesResponse200EventPayload
  • MailPostCrmStatesBatchRequest
  • MailPostCrmStatesBatchResponse200
  • MailPostCrmTasksByTaskIdCompleteRequest
  • MailPostCrmTasksByTaskIdCompleteResponse200
  • MailPostCrmTasksRequest
  • MailPostCrmTasksResponse201
  • MailPostDeliverabilityDomainHealthRequest
  • MailPostDeliverabilityDomainHealthResponse200
  • MailPostDeliverabilityMailboxesByMailboxIdPauseRequest
  • MailPostDeliverabilityMailboxesByMailboxIdPauseResponse200
  • MailPostDeliverabilityMailboxesByMailboxIdReconcileResponse200
  • MailPostDeliverabilityMailboxesByMailboxIdRequest
  • MailPostDeliverabilityMailboxesByMailboxIdResponse200
  • MailPostDeliverabilityMailboxesByMailboxIdResumeResponse200
  • MailPostDeliverabilityPoolsRequest
  • MailPostDeliverabilityPoolsResponse201
  • MailPostDeliverabilityPoolsResponse201Pool
  • MailPostExperimentsByExperimentKeyArchiveResponse200
  • MailPostExperimentsByExperimentKeyConversionsRequest
  • MailPostExperimentsByExperimentKeyConversionsResponse200
  • MailPostExperimentsByExperimentKeyDecideRequest
  • MailPostExperimentsByExperimentKeyDecideResponse200
  • MailPostExperimentsByExperimentKeyPauseResponse200
  • MailPostExperimentsByExperimentKeyResumeResponse200
  • MailPostInboxByMessageIdReplyRequest
  • MailPostInboxByMessageIdReplyResponse200
  • MailPostInboxByMessageIdRequest
  • MailPostInboxByMessageIdResponse200
  • MailPostInboxByMessageIdResponse200Message
  • MailPostMailboxesManualRequest
  • MailPostMailboxesManualRequestImap
  • MailPostMailboxesManualRequestSmtp
  • MailPostMailboxesManualResponse200
  • MailPostMessagesByMessageIdCancelResponse200
  • MailPostMessagesByMessageIdRetryResponse200
  • MailPostMessagesRequest
  • MailPostMessagesRequestTo
  • MailPostMessagesResponse201
  • MailPostOauthBeginRequest
  • MailPostOauthBeginResponse200
  • MailPostPortfolioExportResponse200
  • MailPostPortfolioRequest
  • MailPostPortfolioResponse200
  • MailPostPortfolioSuppressionsRequest
  • MailPostPortfolioSuppressionsRequestAnyOf
  • MailPostPortfolioSuppressionsRequestAnyOf1
  • MailPostPortfolioSuppressionsResponse200
  • MailPostPortfolioTeamsRequest
  • MailPostPortfolioTeamsResponse200
  • MailPostReplyAutomationsRequest
  • MailPostReplyAutomationsRequestActions
  • MailPostReplyAutomationsRequestActionsTask
  • MailPostReplyAutomationsResponse200
  • MailPostSuppressionsRequest
  • MailPostSuppressionsRequestAnyOf
  • MailPostSuppressionsRequestAnyOf1
  • MailPostSuppressionsResponse200
  • MailPostTemplatesByTemplateIdCopyRequest
  • MailPostTemplatesByTemplateIdCopyResponse200
  • MailPostTemplatesRequest
  • MailPostTemplatesRequestWhatsappApproval
  • MailPostTemplatesResponse200
  • MailPostTrackingDomainRequest
  • MailPostTrackingDomainResponse200
  • MailPostTrackingDomainVerifyResponse200
  • MailPostWebhooksBySubscriptionIdReconcileResponse200
  • MailPostWebhooksBySubscriptionIdRotateSecretResponse200
  • MailPostWebhooksBySubscriptionIdStatusRequest
  • MailPostWebhooksBySubscriptionIdStatusResponse200
  • MailPostWebhooksDeliveriesByDeliveryIdReplayResponse200
  • MailPostWebhooksRequest
  • MailPostWebhooksResponse201
  • MailProviderFailure
  • MailPutCrmStatesRequest
  • MailPutCrmStatesResponse200
  • MailPutDeliverabilityPoolsByPoolIdMembersByMailboxIdRequest
  • MailPutDeliverabilityPoolsByPoolIdMembersByMailboxIdResponse200
  • MailQueueSnapshot
  • MailQuotaRule
  • MailRenderedMessage
  • MailReplyAutomationRule
  • MailReplyAutomationRuleActions
  • MailReplyAutomationRuleActionsTask
  • MailReplyClassificationResult
  • MailSendingWindow
  • MailSequenceRunRecord
  • MailSignatureCandidate
  • MailSignatureCandidateFields
  • MailSignatureCandidateFieldsPhonesInner
  • MailStoredImapSettings
  • MailStoredSmtpSettings
  • MailSuppressionRecord
  • MailTrackingDomainRecord
  • MailWebhookDelivery
  • MailWebhookEventSnapshot
  • McpIdentity
  • McpIdentityList
  • McpIdentityResponse
  • NamePattern
  • NamePatternsResponse
  • NameVerificationEmptyFinal
  • NameVerificationItem
  • NameVerificationResponse
  • PersonInsight
  • PreviewSheetWorkflowRequest
  • ProductAccountInfoExecution
  • ProductAccountInfoOutput
  • ProductCombinedEnrichExecution
  • ProductCombinedEnrichInput
  • ProductCombinedEnrichOutput
  • ProductCompaniesListExecution
  • ProductCompaniesListInput
  • ProductCompaniesListOutput
  • ProductCompany
  • ProductCompanyDeleteExecution
  • ProductCompanyDeleteInput
  • ProductCompanyDeleteOutput
  • ProductCompanyEnrichExecution
  • ProductCompanyEnrichInput
  • ProductCompanyList
  • ProductCompanyListAddExecution
  • ProductCompanyListAddInput
  • ProductCompanyListAddOutput
  • ProductCompanyListCreateExecution
  • ProductCompanyListCreateInput
  • ProductCompanyListRemoveExecution
  • ProductCompanyListRemoveInput
  • ProductCompanyListRemoveOutput
  • ProductCompanyListsListExecution
  • ProductCompanyListsListOutput
  • ProductCompanySummary
  • ProductCompanyTrackExecution
  • ProductCompanyTrackInput
  • ProductCompanyTrackOutput
  • ProductCompanyUpdateExecution
  • ProductCompanyUpdateInput
  • ProductCompanyUpdateOutput
  • ProductConnectedApp
  • ProductConnectedAppPushExecution
  • ProductConnectedAppPushInput
  • ProductConnectedAppPushOutput
  • ProductConnectedAppsExecution
  • ProductConnectedAppsOutput
  • ProductCustomAttribute
  • ProductCustomAttributeCreateExecution
  • ProductCustomAttributeCreateInput
  • ProductCustomAttributesListExecution
  • ProductCustomAttributesListOutput
  • ProductDatedRecipient
  • ProductDiscoverCompaniesExecution
  • ProductDiscoverCompaniesInput
  • ProductDiscoverCompaniesOutput
  • ProductDiscoverPeopleExecution
  • ProductDiscoverPeopleInput
  • ProductDiscoverPeopleOutput
  • ProductDomainFinderExecution
  • ProductDomainFinderInput
  • ProductDomainFinderOutput
  • ProductEmailCountExecution
  • ProductEmailCountInput
  • ProductEmailCountOutput
  • ProductLead
  • ProductLeadBulkDeleteExecution
  • ProductLeadBulkDeleteInput
  • ProductLeadBulkDeleteOutput
  • ProductLeadCreateExecution
  • ProductLeadCreateInput
  • ProductLeadDeleteExecution
  • ProductLeadDeleteInput
  • ProductLeadDeleteOutput
  • ProductLeadEnrichExecution
  • ProductLeadEnrichInput
  • ProductLeadGetExecution
  • ProductLeadGetInput
  • ProductLeadList
  • ProductLeadListAddLeadExecution
  • ProductLeadListAddLeadInput
  • ProductLeadListAddLeadOutput
  • ProductLeadListCreateExecution
  • ProductLeadListCreateInput
  • ProductLeadListDeleteExecution
  • ProductLeadListDeleteInput
  • ProductLeadListDeleteOutput
  • ProductLeadListRemoveLeadExecution
  • ProductLeadListRemoveLeadInput
  • ProductLeadListRemoveLeadOutput
  • ProductLeadListUpdateExecution
  • ProductLeadListUpdateInput
  • ProductLeadListsListExecution
  • ProductLeadListsListOutput
  • ProductLeadTagAssignExecution
  • ProductLeadTagAssignInput
  • ProductLeadTagAssignOutput
  • ProductLeadTagCreateExecution
  • ProductLeadTagCreateInput
  • ProductLeadTagRemoveExecution
  • ProductLeadTagRemoveInput
  • ProductLeadTagRemoveOutput
  • ProductLeadTagsListExecution
  • ProductLeadTagsListOutput
  • ProductLeadUpdateExecution
  • ProductLeadUpdateInput
  • ProductLeadUpsertExecution
  • ProductLeadUpsertInput
  • ProductLeadWithAttributes
  • ProductLeadsListExecution
  • ProductLeadsListInput
  • ProductLeadsListOutput
  • ProductNamedResource
  • ProductPerson
  • ProductPersonEnrichExecution
  • ProductPersonEnrichInput
  • ProductPersonSummary
  • ProductRecipient
  • ProductSavedSearchesListExecution
  • ProductSavedSearchesListOutput
  • ProductSequence
  • ProductSequenceRecipientAddExecution
  • ProductSequenceRecipientAddInput
  • ProductSequenceRecipientAddOutput
  • ProductSequenceRecipientCancelExecution
  • ProductSequenceRecipientCancelInput
  • ProductSequenceRecipientsAddExecution
  • ProductSequenceRecipientsAddInput
  • ProductSequenceRecipientsAddInputRecipientsInner
  • ProductSequenceRecipientsAddOutput
  • ProductSequenceRecipientsListExecution
  • ProductSequenceRecipientsListInput
  • ProductSequenceRecipientsListOutput
  • ProductSequenceStartExecution
  • ProductSequenceStartInput
  • ProductSequenceStartOutput
  • ProductSequencesListExecution
  • ProductSequencesListOutput
  • ProductTeamMember
  • ProductTeamMembersExecution
  • ProductTeamMembersOutput
  • ProductToolExecution
  • ProductToolRequest
  • ProductToolRequestInput
  • ProductTrackedCompany
  • ProductUsageExecution
  • ProductUsageHistoryExecution
  • ProductUsageHistoryInput
  • ProductUsageHistoryOutput
  • ProductUsageOutput
  • ProductUsageTransaction
  • PublicStats
  • QueueIntegrationLeadExportRequest
  • QueueIntegrationLeadExportRequestSelectionScopesInner
  • QueueNotificationTestRequest
  • QueuedIntegrationJob
  • QueuedIntegrationJobResponse
  • QueuedIntegrationJobStreamPosition
  • RotateCodaCredentialRequest
  • RotateFreshsalesCredentialRequest
  • RunSheetWorkflowRequest
  • SaveSheetWorkflowRequest
  • SegmentInstallationCreated
  • SheetWorkflow
  • SheetWorkflowDeleted
  • SheetWorkflowList
  • SheetWorkflowPreview
  • SheetWorkflowPreviewRowsInner
  • SheetWorkflowResponse
  • SheetWorkflowStateResponse
  • SheetWorkflowValidation
  • StartAttioOAuthRequest
  • StartGoogleSheetsOAuthRequest
  • StartIntegrationOAuthRequest
  • UpdateIntegrationConnectionStateRequest
  • UpdateLeadRequest
  • UpdateLeadRequestCompany
  • UpdateLeadRequestPerson
  • UpdateLeadResponse
  • UpdateLeadResponseLead
  • UpdateSheetWorkflowStateRequest
  • VerificationFinal
  • VerificationProgress
  • VerificationResponse
  • VerificationResult
  • VerificationStage
  • VerificationStreamError

Authorization

Authentication schemes defined for the API:

ApiKey

  • Type: API key
  • API key parameter name: X-API-Key
  • Location: HTTP header

McpIdentityToken

  • Type: Bearer authentication

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

  • API version: 0.1.0
    • Package version: 4.0.0-beta.1
    • Generator version: 7.25.0
  • Build package: org.openapitools.codegen.languages.PhpClientCodegen

The service URL is fixed to https://api.reacon.io. SDKs do not accept a service URL override.

Retrying requests

A timeout or dropped connection does not prove that the server rejected a request. Before retrying a write or credit-consuming operation, check its outcome. Only retry when the operation is safe to repeat; when present, respect the Retry-After response header. Keep application-level retries bounded as well: wrapping an SDK call in an unbounded retry loop can multiply requests and repeat side effects.

Reporting failures

When reporting a failure, include the SDK package version and HTTP status. Include a request identifier if the response supplies one. Remove API keys and customer data from logs and bug reports. Redact Authorization and X-API-Key headers before sharing a request. Never include the API key in a URL or a screenshot.