> ## 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. # Update session > **Required scope:** `sessions:manage` ## OpenAPI ````yaml api-reference/features/connect.json PUT /messaging/sessions/{session} openapi: 3.0.3 info: title: Connect API methods version: 1.0.0 description: Task-focused connect methods across supported Polymorfa connection types. servers: [] security: [] paths: /messaging/sessions/{session}: put: tags: - Sessions summary: Update session description: '**Required scope:** `sessions:manage`' operationId: nativeUpdateSession parameters: - schema: type: string required: true name: session in: path description: Identifier of the connected Polymorfa session. requestBody: content: application/json: schema: $ref: '#/components/schemas/native__UpdateSessionRequest' responses: '200': description: Session updated content: application/json: schema: $ref: '#/components/schemas/native__UpdateSessionResponse' '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 data: null docs: https://docs.polymorfa.com/api/errors#invalid-parameter '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 data: null docs: https://docs.polymorfa.com/api/errors#invalid-credential '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 data: null docs: https://docs.polymorfa.com/api/errors#permission-denied '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 data: null docs: https://docs.polymorfa.com/api/errors#resource-not-found '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 data: null docs: https://docs.polymorfa.com/api/errors#internal-error '503': description: >- Session configuration was stored but the connected runner did not acknowledge it content: application/json: schema: $ref: '#/components/schemas/native__PublicError' example: error: type: api_error code: service_unavailable message: >- A required service is unavailable. Check completion before repeating a write. param: null data: null docs: https://docs.polymorfa.com/api/errors#service-unavailable security: - native__BearerAuth: [] servers: - url: https://api.polymorfa.com components: schemas: native__UpdateSessionRequest: type: object properties: config: type: object additionalProperties: true description: Structured config values for this native update session request. historySync: allOf: - $ref: '#/components/schemas/native__HistorySyncPolicy' description: History synchronization behavior for newly connected sessions. native__UpdateSessionResponse: 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__Session' 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 - method_not_allowed - permission_denied - missing_scope - resource_not_found - media_fetch_failed - resource_gone - state_conflict - rate_limit_exceeded - internal_error - operation_not_supported - upstream_failure - service_unavailable - credential_verification_unavailable - session_not_ready - command_dispatch_failed - result_unknown description: >- Stable machine-readable code for this result. **Allowed values** | Value | Meaning | | --- | --- | | `invalid_parameter` | Invalid parameter. | | `invalid_credential` | Invalid credential. | | `entitlement_required` | Entitlement required. | | `method_not_allowed` | Method not allowed. | | `permission_denied` | Permission denied. | | `missing_scope` | Missing scope. | | `resource_not_found` | Resource not found. | | `media_fetch_failed` | Media fetch failed. | | `resource_gone` | Resource gone. | | `state_conflict` | State conflict. | | `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. | 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` | required: - type - code - message - param 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__HistorySyncPolicy: type: object properties: mode: type: string enum: - metadata_only - deliver default: metadata_only description: |- Operating mode selected for this feature. **Allowed values** | Value | Meaning | | --- | --- | | `metadata_only` | Metadata only. | | `deliver` | Deliver. | requestFull: type: boolean default: false description: Whether request full. additionalProperties: false description: >- History processing for linked-device sessions. Defaults to metadata-only processing. native__Session: type: object properties: sessionId: type: string description: >- Canonical per-org session identifier. Use this in /messaging/sessions/{session}/* paths. name: type: string description: Display label, or the session identifier when no label is set. tenantId: type: string description: Identifier of the organization that owns this resource. type: type: string enum: - linked_device - cloud_api description: >- How the session connects to WhatsApp. 'linked_device' pairs as a WhatsApp linked device; 'cloud_api' uses the Meta Cloud API. Immutable after create. **Allowed values** | Value | Meaning | | --- | --- | | `linked_device` | Linked device. | | `cloud_api` | Cloud api. | testMode: type: boolean description: Whether this session was created as a simulated testing number. status: type: string description: 'Current status: CONNECTING, CONNECTED, or DISCONNECTED' statusReason: type: string description: Reason for the current status. config: type: object properties: historySync: type: object 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: History synchronization behavior for newly connected sessions. description: Structured config values for this native session. createdAt: type: string description: ISO 8601 timestamp when this resource was created. updatedAt: type: string description: ISO 8601 timestamp when this resource was last updated. required: - sessionId - name - tenantId - type - testMode - status - config - createdAt - updatedAt 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. ````