> ## 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. # Create quick link > **Required scope:** `quicklink:manage` Creates a persistent hosted link that connects one WhatsApp number to a new session in the project. ## OpenAPI ````yaml api-reference/features/integrations.json POST /messaging/quicklinks openapi: 3.0.3 info: title: Integrations API methods version: 1.0.0 description: >- Task-focused integrations methods across supported Polymorfa connection types. servers: [] security: [] paths: /messaging/quicklinks: post: tags: - Quicklink summary: Create quick link description: >- **Required scope:** `quicklink:manage` Creates a persistent hosted link that connects one WhatsApp number to a new session in the project. operationId: nativeCreateQuickLink requestBody: content: application/json: schema: $ref: '#/components/schemas/native__CreateQuickLinkRequest' responses: '201': description: QuickLink created content: application/json: schema: $ref: '#/components/schemas/native__QuickLinkResponse' headers: X-RateLimit-Limit: $ref: '#/components/headers/native__X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/native__X-RateLimit-Remaining' X-RateLimit-Reset: $ref: '#/components/headers/native__X-RateLimit-Reset' '400': description: Bad request — request body or params failed validation content: application/json: schema: $ref: '#/components/schemas/native__PublicError' example: error: type: invalid_request_error code: invalid_parameter message: Correct the invalid request field. param: null request_id: 5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30 data: null docs: https://docs.polymorfa.com/api/errors#invalid-parameter headers: X-RateLimit-Limit: $ref: '#/components/headers/native__X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/native__X-RateLimit-Remaining' X-RateLimit-Reset: $ref: '#/components/headers/native__X-RateLimit-Reset' '401': description: Missing or invalid authentication token content: application/json: schema: $ref: '#/components/schemas/native__PublicError' example: error: type: authentication_error code: invalid_credential message: Supply a valid credential. param: null request_id: 5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30 data: null docs: https://docs.polymorfa.com/api/errors#invalid-credential headers: X-RateLimit-Limit: $ref: '#/components/headers/native__X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/native__X-RateLimit-Remaining' X-RateLimit-Reset: $ref: '#/components/headers/native__X-RateLimit-Reset' '403': description: Authenticated but not permitted (missing scope or rule violation) content: application/json: schema: $ref: '#/components/schemas/native__PublicError' example: error: type: permission_error code: permission_denied message: The credential does not have access to this resource. param: null request_id: 5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30 data: null docs: https://docs.polymorfa.com/api/errors#permission-denied headers: X-RateLimit-Limit: $ref: '#/components/headers/native__X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/native__X-RateLimit-Remaining' X-RateLimit-Reset: $ref: '#/components/headers/native__X-RateLimit-Reset' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/native__PublicError' example: error: type: invalid_request_error code: resource_not_found message: The resource is unavailable to this caller. param: null request_id: 5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30 data: null docs: https://docs.polymorfa.com/api/errors#resource-not-found headers: X-RateLimit-Limit: $ref: '#/components/headers/native__X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/native__X-RateLimit-Remaining' X-RateLimit-Reset: $ref: '#/components/headers/native__X-RateLimit-Reset' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/native__PublicError' example: error: type: api_error code: internal_error message: >- An unexpected service failure occurred. Keep the request ID for support. param: null request_id: 5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30 data: null docs: https://docs.polymorfa.com/api/errors#internal-error headers: X-RateLimit-Limit: $ref: '#/components/headers/native__X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/native__X-RateLimit-Remaining' X-RateLimit-Reset: $ref: '#/components/headers/native__X-RateLimit-Reset' security: - native__BearerAuth: [] servers: - url: https://api.polymorfa.com components: schemas: native__CreateQuickLinkRequest: type: object properties: projectId: type: string format: uuid description: >- Project that receives the connected number. Required for organization keys with more than one project. **Value constraints** | Constraint | Accepted input | | --- | --- | | Format | `uuid` | customerId: type: string format: uuid description: >- Customer that owns the connected number when Customers is enabled for the project. **Value constraints** | Constraint | Accepted input | | --- | --- | | Format | `uuid` | externalId: type: string minLength: 1 maxLength: 256 pattern: ^[^\x00-\x1f\x7f]+$ description: >- Integrator correlation copied to the resulting session. May repeat across invitations; does not grant access. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | `1` through `256` characters | | Pattern | `^[^\x00-\x1f\x7f]+$` | configuration: allOf: - $ref: '#/components/schemas/native__QuickLinkConfiguration' description: Specifies configuration for this native create quick link request. additionalProperties: false native__QuickLinkResponse: type: object properties: success: type: boolean enum: - true description: |- Whether the request succeeded. **Allowed values** | Value | Meaning | | --- | --- | | `true` | True. | data: allOf: - $ref: '#/components/schemas/native__QuickLink' description: Structured data carried by this object. required: - success - data native__PublicError: type: object properties: error: type: object properties: type: type: string enum: - invalid_request_error - authentication_error - permission_error - conflict_error - rate_limit_error - api_error - upstream_error description: |- Type discriminator for this object. **Allowed values** | Value | Meaning | | --- | --- | | `invalid_request_error` | Invalid request error. | | `authentication_error` | Authentication error. | | `permission_error` | Permission error. | | `conflict_error` | Conflict error. | | `rate_limit_error` | Rate limit error. | | `api_error` | Api error. | | `upstream_error` | Upstream error. | code: type: string enum: - invalid_parameter - invalid_credential - entitlement_required - gate_limit_reached - method_not_allowed - permission_denied - missing_scope - resource_not_found - hms_not_enabled - media_fetch_failed - resource_gone - feature_unavailable - stream_cursor_invalid - stream_cursor_expired - stream_connection_limit_reached - state_conflict - hybrid_choice_required - idempotency_conflict - idempotency_in_progress - idempotency_completed - idempotency_outcome_unknown - call_claimed - call_not_ringing - connection_limit - unsupported_for_connection - call_permission_required - invalid_sip_trunk - calls_disabled - call_recipient_opted_out - call_destination_blocked - call_permission_request_limited - call_permission_granted - call_opt_out_limit - number_restricted - sip_trunk_in_use - sip_trunk_revision_conflict - sip_trunk_limit - sip_unavailable - voice_not_enabled - provider_credential_invalid - provider_unavailable - asset_not_ready - voice_asset_in_use - voice_asset_revision_conflict - voice_unavailable - rate_limit_exceeded - internal_error - operation_not_supported - upstream_failure - service_unavailable - credential_verification_unavailable - session_not_ready - command_dispatch_failed - result_unknown - recipient_not_on_whatsapp - conversation_window_closed - template_not_approved - media_too_large - whatsapp_rate_limited - new_chat_limit_reached - whatsapp_account_restricted - bansafe_suspended - bansafe_org_suspended - bansafe_cold_blocked - bansafe_cold_held - bansafe_throttled - bansafe_daily_allowance_reached - bansafe_accounting_unavailable - bansafe_send_outcome_unknown - campaigns_not_entitled - campaign_throughput_capped description: >- Stable machine-readable code for this result. **Allowed values** | Value | Meaning | | --- | --- | | `invalid_parameter` | Invalid parameter. | | `invalid_credential` | Invalid credential. | | `entitlement_required` | Entitlement required. | | `gate_limit_reached` | Gate limit reached. | | `method_not_allowed` | Method not allowed. | | `permission_denied` | Permission denied. | | `missing_scope` | Missing scope. | | `resource_not_found` | Resource not found. | | `hms_not_enabled` | Hms not enabled. | | `media_fetch_failed` | Media fetch failed. | | `resource_gone` | Resource gone. | | `feature_unavailable` | Feature unavailable. | | `stream_cursor_invalid` | Stream cursor invalid. | | `stream_cursor_expired` | Stream cursor expired. | | `stream_connection_limit_reached` | Stream connection limit reached. | | `state_conflict` | State conflict. | | `hybrid_choice_required` | Hybrid choice required. | | `idempotency_conflict` | Idempotency conflict. | | `idempotency_in_progress` | Idempotency in progress. | | `idempotency_completed` | Idempotency completed. | | `idempotency_outcome_unknown` | Idempotency outcome unknown. | | `call_claimed` | Call claimed. | | `call_not_ringing` | Call not ringing. | | `connection_limit` | Connection limit. | | `unsupported_for_connection` | Unsupported for connection. | | `call_permission_required` | Call permission required. | | `invalid_sip_trunk` | Invalid sip trunk. | | `calls_disabled` | Calls disabled. | | `call_recipient_opted_out` | Call recipient opted out. | | `call_destination_blocked` | Call destination blocked. | | `call_permission_request_limited` | Call permission request limited. | | `call_permission_granted` | Call permission granted. | | `call_opt_out_limit` | Call opt out limit. | | `number_restricted` | Number restricted. | | `sip_trunk_in_use` | Sip trunk in use. | | `sip_trunk_revision_conflict` | Sip trunk revision conflict. | | `sip_trunk_limit` | Sip trunk limit. | | `sip_unavailable` | Sip unavailable. | | `voice_not_enabled` | Voice not enabled. | | `provider_credential_invalid` | Provider credential invalid. | | `provider_unavailable` | Provider unavailable. | | `asset_not_ready` | Asset not ready. | | `voice_asset_in_use` | Voice asset in use. | | `voice_asset_revision_conflict` | Voice asset revision conflict. | | `voice_unavailable` | Voice unavailable. | | `rate_limit_exceeded` | Rate limit exceeded. | | `internal_error` | Internal error. | | `operation_not_supported` | Operation not supported. | | `upstream_failure` | Upstream failure. | | `service_unavailable` | Service unavailable. | | `credential_verification_unavailable` | Credential verification unavailable. | | `session_not_ready` | Session not ready. | | `command_dispatch_failed` | Command dispatch failed. | | `result_unknown` | Result unknown. | | `recipient_not_on_whatsapp` | Recipient not on whatsapp. | | `conversation_window_closed` | Conversation window closed. | | `template_not_approved` | Template not approved. | | `media_too_large` | Media too large. | | `whatsapp_rate_limited` | Whatsapp rate limited. | | `new_chat_limit_reached` | New chat limit reached. | | `whatsapp_account_restricted` | Whatsapp account restricted. | | `bansafe_suspended` | Bansafe suspended. | | `bansafe_org_suspended` | Bansafe org suspended. | | `bansafe_cold_blocked` | Bansafe cold blocked. | | `bansafe_cold_held` | Bansafe cold held. | | `bansafe_throttled` | Bansafe throttled. | | `bansafe_daily_allowance_reached` | Bansafe daily allowance reached. | | `bansafe_accounting_unavailable` | Bansafe accounting unavailable. | | `bansafe_send_outcome_unknown` | Bansafe send outcome unknown. | | `campaigns_not_entitled` | Campaigns not entitled. | | `campaign_throughput_capped` | Campaign throughput capped. | message: type: string description: Human-readable message associated with this result. param: type: string nullable: true description: |- Specifies param for this error. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string` | | Alternative 2 | `null` | request_id: type: string description: >- Matches the X-Request-Id response header. Include it when you contact support. request_log_url: type: string format: uri description: >- Console page that shows this request. Returned only to organization and project credentials whose request was logged. **Value constraints** | Constraint | Accepted input | | --- | --- | | Format | `uri` | required: - type - code - message - param - request_id description: Error details returned when the operation fails. data: type: string nullable: true enum: - null description: |- Always null for a failed request. **Allowed values** | Value | Meaning | | --- | --- | | `null` | Null. | **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string` | | Alternative 2 | `null` | docs: type: string format: uri description: |- Specifies docs for this native public error. **Value constraints** | Constraint | Accepted input | | --- | --- | | Format | `uri` | required: - error - data - docs native__QuickLinkConfiguration: type: object properties: testing: type: object 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 maxItems: 3 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. | **Value constraints** | Constraint | Accepted input | | --- | --- | | Array size | At most `3` items | additionalProperties: false description: Structured testing values for this native quick link configuration. prefillPhone: type: string pattern: ^\+?\d{6,15}$ description: |- Specifies prefill phone for this native quick link configuration. **Value constraints** | Constraint | Accepted input | | --- | --- | | Pattern | `^\+?\d{6,15}$` | connectionPreference: type: string enum: - cloud - linked - both description: >- Specifies connection preference for this native quick link configuration. **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 configuration. **Allowed values** | Value | Meaning | | --- | --- | | `prefer` | Prefer. | | `force` | Force. | methods: type: array items: type: string enum: - qr - pairing minItems: 1 maxItems: 2 description: |- Linked Devices methods offered for this connection. **Allowed item values** | Item value | Meaning | | --- | --- | | `qr` | Qr. | | `pairing` | Pairing. | **Value constraints** | Constraint | Accepted input | | --- | --- | | Array size | `1` through `2` items | defaultMethod: type: string nullable: true enum: - qr - pairing - null description: >- Linked Devices method opened first. Omit to inherit the saved project setting, or set null to choose by recipient device. **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` | allowPhoneChange: type: boolean description: Whether allow phone change. historySync: type: object properties: consent: type: string enum: - ask - force_on - force_off description: |- Specifies consent for this history sync. **Allowed values** | Value | Meaning | | --- | --- | | `ask` | Ask. | | `force_on` | Force on. | | `force_off` | Force off. | 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. additionalProperties: false description: History synchronization behavior for newly connected sessions. hms: anyOf: - type: object properties: enabled: type: boolean enum: - false description: |- Whether this feature is enabled. **Allowed values** | Value | Meaning | | --- | --- | | `false` | False. | required: - enabled additionalProperties: false - type: object properties: enabled: type: boolean enum: - true description: |- Whether this feature is enabled. **Allowed values** | Value | Meaning | | --- | --- | | `true` | True. | region: type: string pattern: ^[a-z0-9][a-z0-9-]{0,31}$ description: |- Specifies region for this any of. **Value constraints** | Constraint | Accepted input | | --- | --- | | Pattern | `^[a-z0-9][a-z0-9-]{0,31}$` | policy: type: string enum: - short - standard - extended - compliance - enterprise_archive description: |- Specifies policy for this any of. **Allowed values** | Value | Meaning | | --- | --- | | `short` | Short. | | `standard` | Standard. | | `extended` | Extended. | | `compliance` | Compliance. | | `enterprise_archive` | Enterprise archive. | retentionDays: type: integer minimum: 1 maximum: 2555 description: |- Specifies retention days for this any of. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `1` through `2555` (inclusive) | policyVersion: type: string minLength: 1 maxLength: 128 description: |- Specifies policy version for this any of. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | `1` through `128` characters | legalHold: type: boolean description: Whether legal hold. required: - enabled - region - policy additionalProperties: false description: >- Specifies hms for this native quick link configuration. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `object`; Field `enabled`: `false`; Required fields: `enabled` | | Alternative 2 | Type: `object`; Field `enabled`: `true`; Field `policy`: `short` or `standard` or `extended` or `compliance` or `enterprise_archive`; Required fields: `enabled`, `region`, `policy` | observation: type: object properties: presenceMode: type: string enum: - 'off' - events - cache description: |- Behavior selected for presence. **Allowed values** | Value | Meaning | | --- | --- | | `off` | Off. | | `events` | Events. | | `cache` | Cache. | typingMode: type: string enum: - 'off' - events - cache description: |- Behavior selected for typing. **Allowed values** | Value | Meaning | | --- | --- | | `off` | Off. | | `events` | Events. | | `cache` | Cache. | labelMode: type: string enum: - 'off' - events - cache - project description: |- Behavior selected for label. **Allowed values** | Value | Meaning | | --- | --- | | `off` | Off. | | `events` | Events. | | `cache` | Cache. | | `project` | Project. | quickReplyMode: type: string enum: - 'off' - events - cache description: |- Behavior selected for quick reply. **Allowed values** | Value | Meaning | | --- | --- | | `off` | Off. | | `events` | Events. | | `cache` | Cache. | additionalProperties: false description: >- Structured observation values for this native quick link configuration. additionalProperties: false description: >- Connection, pairing, phone, and history overrides. Omitted fields inherit saved defaults. Presentation, legal links, and callbacks belong to saved project settings. native__QuickLink: type: object properties: id: type: string description: Stable QuickLink identifier, prefixed `ql_`. url: type: string description: >- Hosted connection URL. Share it only with the person holding the phone. session: type: string description: Session name that receives the connected number. expiresAt: type: string nullable: true description: >- Null for new persistent QuickLinks. Legacy links retain their ISO-8601 expiry. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string` | | Alternative 2 | `null` | required: - id - url - session - expiresAt headers: native__X-RateLimit-Limit: description: >- Team request quota per rolling minute, when the per-team request limiter applies. schema: type: integer minimum: 1 native__X-RateLimit-Remaining: description: >- Requests left in the per-team quota; zero when this limiter rejects the request. schema: type: integer minimum: 0 native__X-RateLimit-Reset: description: >- Unix timestamp in seconds when the oldest counted request leaves the rolling window, when the per-team request limiter applies. Follow Retry-After on a rejected request. schema: type: integer minimum: 0 securitySchemes: native__BearerAuth: type: http scheme: bearer description: >- Polymorfa organization key (pmfa_ prefix), project token (pmfa_pt_ prefix) where supported, or short-lived client token (pmfa_ct_ prefix). Organization and project keys may be personal or service-account owned and enforce selected action scopes. Organization keys cover the team and its projects; project tokens stay inside one project. Client tokens stay inside their live project and session and enforce their client rules. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.