> ## Documentation Index > Fetch the complete documentation index at: https://docs.polymorfa.com/llms.txt > Use this file to discover all available pages before exploring further. # Start quick link testing ## OpenAPI ````yaml api-reference/features/integrate.json POST /quicklink/{token}/testing/start openapi: 3.0.3 info: title: Integrate API methods version: 1.0.0 description: Task-focused integrate methods across supported Polymorfa connection types. servers: [] security: [] paths: /quicklink/{token}/testing/start: post: tags: - Quicklink summary: Start quick link testing operationId: nativeStartQuickLinkTesting parameters: - schema: type: string description: Opaque QuickLink token from the hosted URL. required: true name: token in: path description: Opaque token required by the target operation. responses: '200': description: Current test connection state content: application/json: schema: type: object properties: data: allOf: - $ref: '#/components/schemas/native__QuickLinkState' description: Structured data carried by this object. required: - data '400': description: QuickLink request failed content: application/json: schema: $ref: '#/components/schemas/native__PublicQuickLinkError' '403': description: QuickLink request failed content: application/json: schema: $ref: '#/components/schemas/native__PublicQuickLinkError' '404': description: QuickLink request failed content: application/json: schema: $ref: '#/components/schemas/native__PublicQuickLinkError' '409': description: QuickLink request failed content: application/json: schema: $ref: '#/components/schemas/native__PublicQuickLinkError' '422': description: QuickLink request failed content: application/json: schema: $ref: '#/components/schemas/native__PublicQuickLinkError' '429': description: QuickLink request failed content: application/json: schema: $ref: '#/components/schemas/native__PublicQuickLinkError' '500': description: QuickLink request failed content: application/json: schema: $ref: '#/components/schemas/native__PublicQuickLinkError' '503': description: QuickLink request failed content: application/json: schema: $ref: '#/components/schemas/native__PublicQuickLinkError' security: [] servers: - url: https://api.polymorfa.com components: schemas: native__QuickLinkState: type: object properties: testing: type: object nullable: true properties: country: type: string description: ISO 3166-1 alpha-2 country code. configuration: type: object properties: profile: type: object properties: name: type: string minLength: 1 maxLength: 128 description: |- Human-readable name for this resource. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | `1` through `128` characters | status: type: string maxLength: 139 description: |- Current status of this resource or operation. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | At most `139` characters | additionalProperties: false description: Structured profile values for this configuration. accountType: type: string enum: - personal - business description: |- Category assigned to account. **Allowed values** | Value | Meaning | | --- | --- | | `personal` | Personal. | | `business` | Business. | replyBehavior: type: string enum: - 'off' - echo description: |- Specifies reply behavior for this configuration. **Allowed values** | Value | Meaning | | --- | --- | | `off` | Off. | | `echo` | Echo. | failureScenario: type: string enum: - none - reject-send description: |- Specifies failure scenario for this configuration. **Allowed values** | Value | Meaning | | --- | --- | | `none` | None. | | `reject-send` | Reject send. | historyFixtureId: type: string format: uuid description: |- Identifier for the history fixture. **Value constraints** | Constraint | Accepted input | | --- | --- | | Format | `uuid` | additionalProperties: false description: Structured configuration values for this testing. editable: type: array items: type: string enum: - profile.name - profile.status - accountType - replyBehavior - failureScenario - historyFixtureId description: |- Editable associated with this testing. **Allowed item values** | Item value | Meaning | | --- | --- | | `profile.name` | Profile.name. | | `profile.status` | Profile.status. | | `accountType` | Account type. | | `replyBehavior` | Reply behavior. | | `failureScenario` | Failure scenario. | | `historyFixtureId` | History fixture id. | state: type: string enum: - pending - starting - ready description: |- Current lifecycle state of this resource. **Allowed values** | Value | Meaning | | --- | --- | | `pending` | Pending. | | `starting` | Starting. | | `ready` | Ready. | phone: type: string description: Phone number in international format. required: - country - configuration - editable - state - phone description: >- Structured testing values for this native quick link state. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `object`; Field `state`: `pending` or `starting` or `ready`; Required fields: `country`, `configuration`, `editable`, `state`, `phone` | | Alternative 2 | `null` | historyConfiguration: type: object nullable: true properties: mode: type: string enum: - metadata_only - deliver description: |- Operating mode selected for this feature. **Allowed values** | Value | Meaning | | --- | --- | | `metadata_only` | Metadata only. | | `deliver` | Deliver. | requestFull: type: boolean description: Whether request full. required: - mode - requestFull description: >- Structured history configuration values for this native quick link state. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `object`; Field `mode`: `metadata_only` or `deliver`; Required fields: `mode`, `requestFull` | | Alternative 2 | `null` | historyConsent: type: string nullable: true enum: - pending - accepted - declined - null description: >- Specifies history consent for this native quick link state. **Allowed values** | Value | Meaning | | --- | --- | | `pending` | Pending. | | `accepted` | Accepted. | | `declined` | Declined. | | `null` | Null. | **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string`; Value `pending` or `accepted` or `declined` | | Alternative 2 | `null` | id: type: string description: Identifier for this resource. status: type: string enum: - pending - opened - linked - connected - failed - cancelled description: |- Current status of this resource or operation. **Allowed values** | Value | Meaning | | --- | --- | | `pending` | Pending. | | `opened` | Opened. | | `linked` | Linked. | | `connected` | Connected. | | `failed` | Failed. | | `cancelled` | Cancelled. | expiresAt: type: string nullable: true description: |- ISO 8601 timestamp when this resource expires. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string` | | Alternative 2 | `null` | redirectUrl: type: string nullable: true format: uri description: >- Snapshotted failure callback for a failed link. Omitted for non-failed states. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string`; Format: `uri` | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Format | `uri` | connections: type: array items: type: string enum: - cloud - linked description: |- Connections associated with this native quick link state. **Allowed item values** | Item value | Meaning | | --- | --- | | `cloud` | Cloud. | | `linked` | Linked. | selectedConnection: type: string nullable: true enum: - cloud - linked - null description: |- Specifies selected connection for this native quick link state. **Allowed values** | Value | Meaning | | --- | --- | | `cloud` | Cloud. | | `linked` | Linked. | | `null` | Null. | **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string`; Value `cloud` or `linked` | | Alternative 2 | `null` | connectionPreference: type: string enum: - cloud - linked - both description: |- Specifies connection preference for this native quick link state. **Allowed values** | Value | Meaning | | --- | --- | | `cloud` | Cloud. | | `linked` | Linked. | | `both` | Both. | connectionEnforcement: type: string enum: - prefer - force description: |- Specifies connection enforcement for this native quick link state. **Allowed values** | Value | Meaning | | --- | --- | | `prefer` | Prefer. | | `force` | Force. | cloud: type: object nullable: true properties: appId: type: string description: Identifier of the connected application. configId: type: string description: Identifier for the config. required: - appId - configId description: >- Structured cloud values for this native quick link state. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `object`; Required fields: `appId`, `configId` | | Alternative 2 | `null` | onboarding: type: object nullable: true properties: stage: type: string description: Specifies stage for this onboarding. connection: type: string nullable: true description: |- Specifies connection for this onboarding. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string` | | Alternative 2 | `null` | coexistence: type: boolean nullable: true description: |- Whether coexistence. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `boolean` | | Alternative 2 | `null` | contactsSync: type: string description: Specifies contacts sync for this onboarding. historySync: type: string description: History synchronization behavior for newly connected sessions. historyProgress: type: integer minimum: 0 maximum: 100 description: |- Specifies history progress for this onboarding. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` through `100` (inclusive) | errorCode: type: string nullable: true description: |- Machine-readable error code for this onboarding. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string` | | Alternative 2 | `null` | required: - stage - connection - coexistence - contactsSync - historySync - historyProgress - errorCode description: >- Structured onboarding values for this native quick link state. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `object`; Required fields: `stage`, `connection`, `coexistence`, `contactsSync`, `historySync`, `historyProgress`, `errorCode` | | Alternative 2 | `null` | methods: type: array items: type: string enum: - qr - pairing description: |- Connection methods enabled for the widget. **Allowed item values** | Item value | Meaning | | --- | --- | | `qr` | Qr. | | `pairing` | Pairing. | defaultMethod: type: string nullable: true enum: - qr - pairing - null description: |- Specifies default method for this native quick link state. **Allowed values** | Value | Meaning | | --- | --- | | `qr` | Qr. | | `pairing` | Pairing. | | `null` | Null. | **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string`; Value `qr` or `pairing` | | Alternative 2 | `null` | businessName: type: string description: Business name shown to the customer. headline: type: string nullable: true description: |- Specifies headline for this native quick link state. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string` | | Alternative 2 | `null` | description: type: string nullable: true description: |- Human-readable description of this resource. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string` | | Alternative 2 | `null` | successMessage: type: string nullable: true description: |- Specifies success message for this native quick link state. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string` | | Alternative 2 | `null` | supportUrl: type: string nullable: true description: |- URL for the support. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string` | | Alternative 2 | `null` | privacyUrl: type: string nullable: true description: |- URL for the privacy. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string` | | Alternative 2 | `null` | termsUrl: type: string nullable: true description: |- URL for the terms. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string` | | Alternative 2 | `null` | theme: type: string enum: - light - dark - system description: |- Visual theme used by the widget. **Allowed values** | Value | Meaning | | --- | --- | | `light` | Light. | | `dark` | Dark. | | `system` | System. | accent: type: string nullable: true description: |- Specifies accent for this native quick link state. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string` | | Alternative 2 | `null` | shape: type: string nullable: true enum: - square - rounded - pill - null description: >- Specifies shape for this native quick link state. **Allowed values** | Value | Meaning | | --- | --- | | `square` | Square. | | `rounded` | Rounded. | | `pill` | Pill. | | `null` | Null. | **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string`; Value `square` or `rounded` or `pill` | | Alternative 2 | `null` | radiusPx: type: number nullable: true description: |- Specifies radius px for this native quick link state. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number` | | Alternative 2 | `null` | logoUrl: type: string nullable: true description: |- URL for the logo. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string` | | Alternative 2 | `null` | hideWatermark: type: boolean description: Whether hide watermark. historySync: type: string enum: - ask - force_on - force_off description: |- History synchronization behavior for newly connected sessions. **Allowed values** | Value | Meaning | | --- | --- | | `ask` | Ask. | | `force_on` | Force on. | | `force_off` | Force off. | phoneStep: type: object properties: confirmed: type: boolean description: Whether confirmed. allowChange: type: boolean description: Whether allow change. noNumber: type: boolean description: Whether no number. allowNoNumber: type: boolean description: Whether allow no number. required: - confirmed - allowChange - noNumber - allowNoNumber description: Structured phone step values for this native quick link state. prefillPhone: type: string nullable: true description: |- Specifies prefill phone for this native quick link state. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string` | | Alternative 2 | `null` | phoneIdentity: type: object nullable: true properties: registered: type: boolean nullable: true description: >- Whether WhatsApp registration was confirmed. Null means the result is unknown. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `boolean` | | Alternative 2 | `null` | phone: type: string description: Phone number in international format. whatsappPhone: type: string nullable: true description: |- Specifies whatsapp phone for this phone identity. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string` | | Alternative 2 | `null` | accountType: type: string enum: - whatsapp - business_app - cloud_api - coexistence - unknown - unregistered description: |- Category assigned to account. **Allowed values** | Value | Meaning | | --- | --- | | `whatsapp` | Whatsapp. | | `business_app` | Business app. | | `cloud_api` | Cloud api. | | `coexistence` | Coexistence. | | `unknown` | Unknown. | | `unregistered` | Unregistered. | pushName: type: string nullable: true description: |- WhatsApp display name reported by the sender's client. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string` | | Alternative 2 | `null` | pictureUrl: type: string nullable: true format: uri description: |- URL for the picture. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string`; Format: `uri` | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Format | `uri` | required: - registered - phone - whatsappPhone - accountType - pushName - pictureUrl description: >- Structured phone identity values for this native quick link state. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `object`; Field `accountType`: `whatsapp` or `business_app` or `cloud_api` or `coexistence` or `unknown` or `unregistered`; Required fields: `registered`, `phone`, `whatsappPhone`, `accountType`, `pushName`, `pictureUrl` | | Alternative 2 | `null` | customer: type: boolean description: True when the link assigns the number to a Customer. session: type: object properties: status: type: string description: Current status of this resource or operation. phone: type: string nullable: true description: |- Phone number in international format. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string` | | Alternative 2 | `null` | required: - status - phone description: Identifier of the connected Polymorfa session. qrSvg: type: string nullable: true description: >- Inline SVG of the current WhatsApp QR code, when the QR method is offered and the number is not linked yet. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string` | | Alternative 2 | `null` | errorCode: type: string nullable: true description: |- Machine-readable error code for this native quick link state. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string` | | Alternative 2 | `null` | required: - testing - historyConfiguration - historyConsent - id - status - expiresAt - connections - selectedConnection - connectionPreference - connectionEnforcement - cloud - onboarding - methods - defaultMethod - businessName - headline - description - successMessage - supportUrl - privacyUrl - termsUrl - theme - accent - shape - radiusPx - logoUrl - hideWatermark - historySync - phoneStep - prefillPhone - phoneIdentity - customer - session - qrSvg - errorCode native__PublicQuickLinkError: type: object properties: error: type: object properties: code: type: string description: Stable machine-readable code for this result. message: type: string description: Human-readable message associated with this result. required: - code - message description: Error details returned when the operation fails. data: type: object properties: candidates: type: array items: type: object properties: phone: type: string description: Phone number in international format. whatsappPhone: type: string description: Specifies whatsapp phone for this candidate. registered: type: boolean nullable: true description: >- Whether WhatsApp registration was confirmed. Null means the result is unknown. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `boolean` | | Alternative 2 | `null` | pushName: type: string nullable: true description: |- WhatsApp display name reported by the sender's client. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string` | | Alternative 2 | `null` | pictureUrl: type: string nullable: true description: |- URL for the picture. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string` | | Alternative 2 | `null` | accountType: type: string enum: - whatsapp - business_app - cloud_api - coexistence - unknown - unregistered description: |- Category assigned to account. **Allowed values** | Value | Meaning | | --- | --- | | `whatsapp` | Whatsapp. | | `business_app` | Business app. | | `cloud_api` | Cloud api. | | `coexistence` | Coexistence. | | `unknown` | Unknown. | | `unregistered` | Unregistered. | required: - phone - registered - pushName - pictureUrl description: Candidates associated with this data. required: - candidates description: Structured data carried by this object. required: - error ````