{"openapi":"3.1.0","info":{"title":"Inkbox API","contact":{"name":"Inkbox","url":"https://inkbox.ai/"},"version":"0.1.0"},"paths":{"/api/v1/signing-keys":{"get":{"tags":["Signing Keys"],"summary":"Get Org Signing Key Status","operationId":"get_org_signing_key_status_signing_keys_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SigningKeyStatusResponse"}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"deprecated":true,"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"post":{"tags":["Signing Keys"],"summary":"Create Or Rotate Signing Key","operationId":"create_or_rotate_signing_key_signing_keys_post","responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SigningKeyCreateResponse"}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"deprecated":true,"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/api-keys":{"get":{"tags":["API Keys"],"summary":"List Api Keys","operationId":"list_api_keys_api_keys_get","parameters":[{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/ApiKeyStatus"},{"type":"null"}],"description":"Filter by status: active, revoked, or omit for all.","title":"Status"},"description":"Filter by status: active, revoked, or omit for all."},{"name":"scoped_identity_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"Filter by scoped agent identity.","title":"Scoped Identity Id"},"description":"Filter by scoped agent identity."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListApiKeysResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"BearerAuth":[]}]},"post":{"tags":["API Keys"],"summary":"Create Api Key","operationId":"create_api_key_api_keys_post","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateApiKeyRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateApiKeyResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/api-keys/self":{"get":{"tags":["API Keys"],"summary":"Get Current Api Key","operationId":"get_current_api_key_api_keys_self_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKey"}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/api/v1/api-keys/{key_id}":{"patch":{"tags":["API Keys"],"summary":"Update Api Key","operationId":"update_api_key_api_keys__key_id__patch","parameters":[{"name":"key_id","in":"path","required":true,"schema":{"type":"string","title":"Key Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateApiKeyRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKey"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/api-keys/self/revoke":{"post":{"tags":["API Keys"],"summary":"Revoke Current Api Key","operationId":"revoke_current_api_key_api_keys_self_revoke_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKey"}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/api/v1/api-keys/{key_id}/revoke":{"post":{"tags":["API Keys"],"summary":"Revoke Api Key","operationId":"revoke_api_key_api_keys__key_id__revoke_post","parameters":[{"name":"key_id","in":"path","required":true,"schema":{"type":"string","title":"Key Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKey"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/resource-links/{resource_type}/{resource_id}":{"get":{"tags":["Resource Links"],"summary":"Resolve Resource Link","operationId":"resolve_resource_link_resource_links__resource_type___resource_id__get","parameters":[{"name":"resource_type","in":"path","required":true,"schema":{"type":"string","title":"Resource Type"}},{"name":"resource_id","in":"path","required":true,"schema":{"type":"string","title":"Resource Id"}},{"name":"organization","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Organization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/EmailResourceResponse"},{"$ref":"#/components/schemas/ContactResourceResponse"},{"$ref":"#/components/schemas/NoteResourceResponse"},{"$ref":"#/components/schemas/TextConversationResourceResponse"},{"$ref":"#/components/schemas/IMessageConversationResourceResponse"},{"$ref":"#/components/schemas/CallResourceResponse"},{"$ref":"#/components/schemas/CallTranscriptResourceResponse"}],"discriminator":{"propertyName":"type","mapping":{"emails":"#/components/schemas/EmailResourceResponse","contacts":"#/components/schemas/ContactResourceResponse","notes":"#/components/schemas/NoteResourceResponse","text-conversations":"#/components/schemas/TextConversationResourceResponse","imessage-conversations":"#/components/schemas/IMessageConversationResourceResponse","calls":"#/components/schemas/CallResourceResponse","call-transcripts":"#/components/schemas/CallTranscriptResourceResponse"}},"title":"Response Resolve Resource Link Resource Links  Resource Type   Resource Id  Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/webhooks/catalog":{"get":{"tags":["Webhooks"],"summary":"Get Webhook Catalog","operationId":"get_webhook_catalog_webhooks_catalog_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListWebhookCatalogResponse"}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/a2a/invitations":{"post":{"tags":["A2A Invitations"],"summary":"Create A2A Invitation","operationId":"create_a2a_invitation_invitations_post","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/A2AInvitationCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/A2AInvitationUnboundCreateResponse"},{"$ref":"#/components/schemas/A2AInvitationResponse"}],"title":"Response Create A2A Invitation Invitations Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}]},"get":{"tags":["A2A Invitations"],"summary":"List A2A Invitations","operationId":"list_a2a_invitations_invitations_get","parameters":[{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/A2AInvitationPage"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}]}},"/api/v1/a2a/invitations/preview":{"post":{"tags":["A2A Invitations"],"summary":"Preview A2A Invitation","operationId":"preview_a2a_invitation_invitations_preview_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/A2AInvitationPreview"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/A2AInvitationPreviewResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}}}},"/api/v1/a2a/invitations/accept":{"post":{"tags":["A2A Invitations"],"summary":"Accept A2A Invitation","operationId":"accept_a2a_invitation_invitations_accept_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/A2AInvitationAccept"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/A2AInvitationAcceptResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/api/v1/a2a/invitations/decline":{"post":{"tags":["A2A Invitations"],"summary":"Decline A2A Invitation","operationId":"decline_a2a_invitation_invitations_decline_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/A2AInvitationDecline"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/A2AInvitationDeclineResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}}}},"/api/v1/a2a/invitations/{invitation_id}":{"get":{"tags":["A2A Invitations"],"summary":"Get A2A Invitation","operationId":"get_a2a_invitation_invitations__invitation_id__get","parameters":[{"name":"invitation_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Invitation Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/A2AInvitationResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}]}},"/api/v1/a2a/invitations/{invitation_id}/revoke":{"post":{"tags":["A2A Invitations"],"summary":"Revoke A2A Invitation","operationId":"revoke_a2a_invitation_invitations__invitation_id__revoke_post","parameters":[{"name":"invitation_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Invitation Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/A2AInvitationResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}]}},"/api/v1/agent-signup/":{"post":{"tags":["Agent Signup"],"summary":"Agent self-signup","operationId":"signup__post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSignupRequest"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSignupResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}}}},"/api/v1/agent-signup/verify":{"post":{"tags":["Agent Signup"],"summary":"Verify agent with code from human","operationId":"verify_agent_verify_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentClaimRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentClaimResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/api/v1/agent-signup/resend-verification":{"post":{"tags":["Agent Signup"],"summary":"Resend verification email","operationId":"resend_agent_verification_resend_verification_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentClaimResponse"}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/api/v1/agent-signup/status":{"get":{"tags":["Agent Signup"],"summary":"Check agent signup status","operationId":"get_agent_status_status_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSignupStatusResponse"}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/api/v1/agent-signup/pending":{"get":{"tags":["Agent Signup"],"summary":"List pending agents for the authenticated human","operationId":"list_pending_agents_pending_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PendingAgentsResponse"}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/agent-signup/{identity_id}/approve":{"post":{"tags":["Agent Signup"],"summary":"Approve a pending agent","operationId":"approve_agent__identity_id__approve_post","parameters":[{"name":"identity_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Identity Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApproveAgentRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApproveAgentResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/agent-signup/{identity_id}/reject":{"post":{"tags":["Agent Signup"],"summary":"Reject a pending agent","operationId":"reject_agent__identity_id__reject_post","parameters":[{"name":"identity_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Identity Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RejectAgentResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/billing/checkout-session":{"post":{"tags":["Billing"],"summary":"Create Checkout Session","operationId":"create_checkout_session_checkout_session_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckoutSessionRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckoutSessionResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/billing/portal-session":{"post":{"tags":["Billing"],"summary":"Create Portal Session","operationId":"create_portal_session_portal_session_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalSessionRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalSessionResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/billing/subscription":{"get":{"tags":["Billing"],"summary":"Get Subscription","operationId":"get_subscription_subscription_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionStatusResponse"}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/billing/change-plan":{"post":{"tags":["Billing"],"summary":"Change Plan","operationId":"change_plan_change_plan_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangePlanRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionStatusResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/billing/usage":{"get":{"tags":["Billing"],"summary":"Get Usage","operationId":"get_usage_usage_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsageSummaryResponse"}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/billing/settings":{"get":{"tags":["Billing"],"summary":"Get Billing Settings","operationId":"get_billing_settings_settings_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingSettingsResponse"}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"put":{"tags":["Billing"],"summary":"Update Billing Settings","operationId":"update_billing_settings_settings_put","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBillingSettingsRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingSettingsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}]}},"/api/v1/compliance/brand":{"get":{"tags":["Brand"],"summary":"Get Org Brand","operationId":"get_org_brand_brand_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrandRegistrationResponse"}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"put":{"tags":["Brand"],"summary":"Update Org Brand","operationId":"update_org_brand_brand_put","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrandUpdateRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrandRegistrationResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"post":{"tags":["Brand"],"summary":"Register Brand","operationId":"register_brand_brand_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrandRegistrationRequest"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrandRegistrationResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"delete":{"tags":["Brand"],"summary":"Delete Org Brand","operationId":"delete_org_brand_brand_delete","responses":{"204":{"description":"Successful Response"},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/compliance/brand/sms-otp":{"put":{"tags":["Brand"],"summary":"Verify Brand Sms Otp","operationId":"verify_brand_sms_otp_brand_sms_otp_put","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrandSmsOtpVerifyRequest"}}},"required":true},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"post":{"tags":["Brand"],"summary":"Trigger Brand Sms Otp","operationId":"trigger_brand_sms_otp_brand_sms_otp_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrandSmsOtpTriggerResponse"}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/compliance/brand/2fa-email":{"post":{"tags":["Brand"],"summary":"Resend Brand 2Fa Email","operationId":"resend_brand_2fa_email_brand_2fa_email_post","responses":{"204":{"description":"Successful Response"},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/compliance/campaign":{"get":{"tags":["Campaign"],"summary":"Get Org Campaign","operationId":"get_org_campaign_campaign_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignRegistrationResponse"}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"put":{"tags":["Campaign"],"summary":"Update Org Campaign","operationId":"update_org_campaign_campaign_put","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignUpdateRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignRegistrationResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"post":{"tags":["Campaign"],"summary":"Register Campaign","operationId":"register_campaign_campaign_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignRegistrationRequest"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignRegistrationResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"delete":{"tags":["Campaign"],"summary":"Delete Org Campaign","operationId":"delete_org_campaign_campaign_delete","responses":{"204":{"description":"Successful Response"},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/compliance/campaign/resubmit":{"post":{"tags":["Campaign"],"summary":"Resubmit Org Campaign","operationId":"resubmit_org_campaign_campaign_resubmit_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignRegistrationRequest"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignRegistrationResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/compliance/campaign/active":{"get":{"tags":["Campaign"],"summary":"Get Campaign Active","operationId":"get_campaign_active_campaign_active_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignActiveStateResponse"}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"patch":{"tags":["Campaign"],"summary":"Toggle Campaign Active","operationId":"toggle_campaign_active_campaign_active_patch","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignActiveToggleRequest"}}},"required":true},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignActiveToggleResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/compliance/events/brand":{"post":{"tags":["Webhooks"],"summary":"Receive Brand Event","operationId":"receive_brand_event_events_brand_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}}}},"/api/v1/compliance/events/campaign":{"post":{"tags":["Webhooks"],"summary":"Receive Campaign Event","operationId":"receive_campaign_event_events_campaign_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}}}},"/api/v1/webhooks/destinations":{"get":{"tags":["Webhooks"],"summary":"List Org Webhook Destinations","operationId":"list_org_webhook_destinations_destinations_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":200,"minimum":1},{"type":"null"}],"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","maximum":10000,"minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListWebhookDestinationsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/webhooks/subscriptions":{"post":{"tags":["Webhooks"],"summary":"Create Subscription","operationId":"create_subscription_subscriptions_post","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookSubscriptionCreateRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookSubscriptionCreateResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"get":{"tags":["Webhooks"],"summary":"List Subscriptions","operationId":"list_subscriptions_subscriptions_get","parameters":[{"name":"mailbox_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Mailbox Id"}},{"name":"phone_number_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Phone Number Id"}},{"name":"agent_identity_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Agent Identity Id"}},{"name":"url","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url"}},{"name":"event_type","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/MailWebhookEventType"},{"$ref":"#/components/schemas/PhoneTextWebhookEventType"},{"$ref":"#/components/schemas/PhoneCallLifecycleWebhookEventType"},{"$ref":"#/components/schemas/IMessageWebhookEventType"},{"$ref":"#/components/schemas/A2AWebhookEventType"},{"type":"null"}],"title":"Event Type"}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":200,"minimum":1},{"type":"null"}],"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","maximum":10000,"minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListWebhookSubscriptionsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/webhooks/subscriptions/{sub_id}":{"get":{"tags":["Webhooks"],"summary":"Get Subscription","operationId":"get_subscription_subscriptions__sub_id__get","parameters":[{"name":"sub_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Sub Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookSubscriptionResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"patch":{"tags":["Webhooks"],"summary":"Update Subscription","operationId":"update_subscription_subscriptions__sub_id__patch","parameters":[{"name":"sub_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Sub Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookSubscriptionUpdateRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookSubscriptionResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"delete":{"tags":["Webhooks"],"summary":"Delete Subscription","operationId":"delete_subscription_subscriptions__sub_id__delete","parameters":[{"name":"sub_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Sub Id"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/webhooks/deliveries":{"get":{"tags":["Webhooks"],"summary":"List Deliveries","operationId":"list_deliveries_deliveries_get","parameters":[{"name":"subscription_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Subscription Id"}},{"name":"phone_number_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Phone Number Id"}},{"name":"event_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Event Type"}},{"name":"success","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Success"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListWebhookDeliveriesResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/webhooks/deliveries/{delivery_id}/replay":{"post":{"tags":["Webhooks"],"summary":"Replay Delivery","operationId":"replay_delivery_deliveries__delivery_id__replay_post","parameters":[{"name":"delivery_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Delivery Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookDeliveryResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/contacts/import":{"post":{"tags":["Contacts"],"summary":"Import Contacts","operationId":"import_contacts_import_post","parameters":[{"name":"X-VCard-Preview-Hash","in":"header","required":false,"schema":{"anyOf":[{"type":"string","pattern":"^[a-f0-9]{64}$"},{"type":"null"}],"title":"X-Vcard-Preview-Hash"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactImportResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/contacts/vcard-export":{"post":{"tags":["Contacts"],"summary":"Export Contacts Vcard","operationId":"export_contacts_vcard_vcard_export_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactVCardExportRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactVCardExportResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/contacts/import/preview":{"post":{"tags":["Contacts"],"summary":"Preview Contacts Import","operationId":"preview_contacts_import_import_preview_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactImportPreviewRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactImportPreviewResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/contacts/{contact_id}.vcf":{"get":{"tags":["Contacts"],"summary":"Export Contact Vcard","operationId":"export_contact_vcard__contact_id__vcf_get","parameters":[{"name":"contact_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Contact Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/contacts/{contact_id}/access":{"post":{"tags":["Contact Access"],"summary":"Grant Contact Access","operationId":"grant_contact_access__contact_id__access_post","deprecated":true,"parameters":[{"name":"contact_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Contact Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactAccessGrantRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactAccessResponse"}}}},"409":{"description":"Contacts are organization-wide","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"get":{"tags":["Contact Access"],"summary":"List Contact Access","operationId":"list_contact_access__contact_id__access_get","deprecated":true,"parameters":[{"name":"contact_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Contact Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ContactAccessResponse"},"title":"Response List Contact Access  Contact Id  Access Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/contacts/{contact_id}/access/{identity_id}":{"delete":{"tags":["Contact Access"],"summary":"Revoke Contact Access","operationId":"revoke_contact_access__contact_id__access__identity_id__delete","deprecated":true,"parameters":[{"name":"contact_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Contact Id"}},{"name":"identity_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Identity Id"}}],"responses":{"204":{"description":"Successful Response"},"409":{"description":"Contacts are organization-wide","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/contacts/{contact_id}/correspondence":{"get":{"tags":["Contact Correspondence"],"summary":"Get Correspondence","operationId":"get_correspondence__contact_id__correspondence_get","parameters":[{"name":"contact_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Contact Id"}},{"name":"channels","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"description":"Channels to include. Repeat the parameter or use comma-separated values.","default":["email","sms","imessage","calls"],"title":"Channels"},"description":"Channels to include. Repeat the parameter or use comma-separated values."},{"name":"after","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"After"}},{"name":"before","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Before"}},{"name":"limit_per_channel","in":"query","required":false,"schema":{"type":"integer","maximum":50,"minimum":1,"default":25,"title":"Limit Per Channel"}},{"name":"email_limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":50,"minimum":1},{"type":"null"}],"title":"Email Limit"}},{"name":"sms_limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":50,"minimum":1},{"type":"null"}],"title":"Sms Limit"}},{"name":"imessage_limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":50,"minimum":1},{"type":"null"}],"title":"Imessage Limit"}},{"name":"calls_limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":50,"minimum":1},{"type":"null"}],"title":"Calls Limit"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":4096},{"type":"null"}],"title":"Cursor"}},{"name":"order","in":"query","required":false,"schema":{"$ref":"#/components/schemas/CorrespondenceOrder","default":"desc"}},{"name":"content","in":"query","required":false,"schema":{"$ref":"#/components/schemas/CorrespondenceContentMode","default":"preview"}},{"name":"transcripts","in":"query","required":false,"schema":{"$ref":"#/components/schemas/CorrespondenceTranscriptMode","default":"none"}},{"name":"include_failed","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Include Failed"}},{"name":"identity_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Identity Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactCorrespondenceResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/contacts/{contact_id}/facts":{"get":{"tags":["Contact Memory"],"summary":"List Contact Facts","operationId":"list_contact_facts__contact_id__facts_get","parameters":[{"name":"contact_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Contact Id"}},{"name":"include_expired","in":"query","required":false,"schema":{"type":"boolean","description":"Include context memories whose deadline has passed.","default":false,"title":"Include Expired"},"description":"Include context memories whose deadline has passed."},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":200,"minimum":1},{"type":"null"}],"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","maximum":10000,"minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ContactFactResponse"},"title":"Response List Contact Facts  Contact Id  Facts Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"post":{"tags":["Contact Memory"],"summary":"Create Contact Fact","operationId":"create_contact_fact__contact_id__facts_post","parameters":[{"name":"contact_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Contact Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactFactCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactFactResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/contacts/{contact_id}/facts/{fact_id}":{"get":{"tags":["Contact Memory"],"summary":"Get Contact Fact","operationId":"get_contact_fact__contact_id__facts__fact_id__get","parameters":[{"name":"contact_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Contact Id"}},{"name":"fact_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Fact Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactFactResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"patch":{"tags":["Contact Memory"],"summary":"Update Contact Fact","operationId":"update_contact_fact__contact_id__facts__fact_id__patch","parameters":[{"name":"contact_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Contact Id"}},{"name":"fact_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Fact Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactFactUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactFactResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"delete":{"tags":["Contact Memory"],"summary":"Delete Contact Fact","operationId":"delete_contact_fact__contact_id__facts__fact_id__delete","parameters":[{"name":"contact_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Contact Id"}},{"name":"fact_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Fact Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactFactDeleteResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/contacts/{contact_id}/facts/{fact_id}/citations/{citation_id}":{"get":{"tags":["Contact Memory"],"summary":"Resolve Contact Fact Citation","operationId":"resolve_contact_fact_citation__contact_id__facts__fact_id__citations__citation_id__get","parameters":[{"name":"contact_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Contact Id"}},{"name":"fact_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Fact Id"}},{"name":"citation_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Citation Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactFactCitationDetailResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/contacts/":{"post":{"tags":["Contacts"],"summary":"Create Contact","operationId":"create_contact__post","parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Idempotency-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactMutationResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"get":{"tags":["Contacts"],"summary":"List Contacts","operationId":"list_contacts__get","parameters":[{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"description":"Case-insensitive substring match over name fields.","title":"Q"},"description":"Case-insensitive substring match over name fields."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","maximum":10000,"minimum":0,"default":0,"title":"Offset"}},{"name":"order","in":"query","required":false,"schema":{"enum":["name","recent"],"type":"string","default":"name","title":"Order"}},{"name":"review_status","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/ContactReviewStatus"}},{"type":"null"}],"title":"Review Status"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ContactListResponse"},"title":"Response List Contacts  Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/contacts/lookup":{"get":{"tags":["Contacts"],"summary":"Lookup Contact","operationId":"lookup_contact_lookup_get","parameters":[{"name":"email","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":320},{"type":"null"}],"title":"Email"}},{"name":"email_contains","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":320},{"type":"null"}],"description":"Substring match on stored email value (case-insensitive).","title":"Email Contains"},"description":"Substring match on stored email value (case-insensitive)."},{"name":"email_domain","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":253},{"type":"null"}],"description":"Suffix match on '@<domain>'. Leading '@' is tolerated.","title":"Email Domain"},"description":"Suffix match on '@<domain>'. Leading '@' is tolerated."},{"name":"phone","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":32},{"type":"null"}],"title":"Phone"}},{"name":"phone_contains","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":32},{"type":"null"}],"description":"Substring match on stored E.164 phone value.","title":"Phone Contains"},"description":"Substring match on stored E.164 phone value."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ContactResponse"},"title":"Response Lookup Contact Lookup Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/contacts/{contact_id}":{"get":{"tags":["Contacts"],"summary":"Get Contact","operationId":"get_contact__contact_id__get","parameters":[{"name":"contact_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Contact Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"patch":{"tags":["Contacts"],"summary":"Update Contact","operationId":"update_contact__contact_id__patch","parameters":[{"name":"contact_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Contact Id"}},{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Idempotency-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactMutationResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"delete":{"tags":["Contacts"],"summary":"Delete Contact","operationId":"delete_contact__contact_id__delete","parameters":[{"name":"contact_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Contact Id"}},{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Idempotency-Key"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/contacts/bulk-delete":{"post":{"tags":["Contacts"],"summary":"Bulk Delete Contacts","operationId":"bulk_delete_contacts_bulk_delete_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactBulkDeleteRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactBulkDeleteResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/contacts/{contact_id}/merge":{"post":{"tags":["Contacts"],"summary":"Merge Contact","operationId":"merge_contact__contact_id__merge_post","parameters":[{"name":"contact_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Contact Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactMergeRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactMutationResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/domains/":{"post":{"tags":["Domains"],"summary":"Create Domain","operationId":"create_domain__post","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDomainRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDomainResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}]},"get":{"tags":["Domains"],"summary":"List Domains","operationId":"list_domains__get","parameters":[{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/SendingDomainStatus"},{"type":"null"}],"description":"Filter to rows in this lifecycle status. Omit to return every row in the org regardless of state. The mailbox-create dropdown reads from `?status=verified`.","title":"Status"},"description":"Filter to rows in this lifecycle status. Omit to return every row in the org regardless of state. The mailbox-create dropdown reads from `?status=verified`."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DomainResponse"},"title":"Response List Domains  Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}]}},"/api/v1/domains/{domain_id}":{"get":{"tags":["Domains"],"summary":"Get Domain","operationId":"get_domain__domain_id__get","parameters":[{"name":"domain_id","in":"path","required":true,"schema":{"type":"string","title":"Domain Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainWithDnsRecordsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}]},"delete":{"tags":["Domains"],"summary":"Delete Domain","operationId":"delete_domain__domain_id__delete","parameters":[{"name":"domain_id","in":"path","required":true,"schema":{"type":"string","title":"Domain Id"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}]}},"/api/v1/domains/{domain_id}/health":{"get":{"tags":["Domains"],"summary":"Get Domain Health","operationId":"get_domain_health__domain_id__health_get","parameters":[{"name":"domain_id","in":"path","required":true,"schema":{"type":"string","title":"Domain Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainHealthResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}]}},"/api/v1/domains/{domain_id}/dns-records":{"get":{"tags":["Domains"],"summary":"Get Dns Records","operationId":"get_dns_records__domain_id__dns_records_get","parameters":[{"name":"domain_id","in":"path","required":true,"schema":{"type":"string","title":"Domain Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DnsRecordsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}]}},"/api/v1/domains/{domain_id}/verify":{"post":{"tags":["Domains"],"summary":"Verify Domain","operationId":"verify_domain__domain_id__verify_post","parameters":[{"name":"domain_id","in":"path","required":true,"schema":{"type":"string","title":"Domain Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainWithDnsRecordsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}]}},"/api/v1/domains/{domain_name}/set-default":{"post":{"tags":["Domains"],"summary":"Set Default Domain","operationId":"set_default_domain__domain_name__set_default_post","parameters":[{"name":"domain_name","in":"path","required":true,"schema":{"type":"string","title":"Domain Name"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetDefaultResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}]}},"/api/v1/domains/{domain_id}/rotate-dkim":{"post":{"tags":["Domains"],"summary":"Rotate Dkim Route","operationId":"rotate_dkim_route__domain_id__rotate_dkim_post","parameters":[{"name":"domain_id","in":"path","required":true,"schema":{"type":"string","title":"Domain Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RotateDkimResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}]}},"/api/v1/domains/{domain_id}/restore":{"post":{"tags":["Domains"],"summary":"Restore Domain","operationId":"restore_domain__domain_id__restore_post","parameters":[{"name":"domain_id","in":"path","required":true,"schema":{"type":"string","title":"Domain Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}]}},"/api/v1/domains/{domain_id}/force":{"delete":{"tags":["Domains"],"summary":"Force Delete Domain","operationId":"force_delete_domain__domain_id__force_delete","parameters":[{"name":"domain_id","in":"path","required":true,"schema":{"type":"string","title":"Domain Id"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}]}},"/api/v1/identities/{agent_handle}/access":{"post":{"tags":["Identity Access"],"summary":"Grant Identity Access","operationId":"grant_identity_access__agent_handle__access_post","deprecated":true,"parameters":[{"name":"agent_handle","in":"path","required":true,"schema":{"type":"string","title":"Agent Handle"}}],"responses":{"410":{"description":"Successful Response","content":{"application/json":{"schema":{"allOf":[{"type":"object","additionalProperties":{"type":"string"},"title":"Response Grant Identity Access  Agent Handle  Access Post"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"get":{"tags":["Identity Access"],"summary":"List Identity Access","operationId":"list_identity_access__agent_handle__access_get","deprecated":true,"parameters":[{"name":"agent_handle","in":"path","required":true,"schema":{"type":"string","title":"Agent Handle"}}],"responses":{"410":{"description":"Successful Response","content":{"application/json":{"schema":{"allOf":[{"type":"object","additionalProperties":{"type":"string"},"title":"Response List Identity Access  Agent Handle  Access Get"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/identities/{agent_handle}/access/{viewer_identity_id}":{"delete":{"tags":["Identity Access"],"summary":"Revoke Identity Access","operationId":"revoke_identity_access__agent_handle__access__viewer_identity_id__delete","deprecated":true,"parameters":[{"name":"agent_handle","in":"path","required":true,"schema":{"type":"string","title":"Agent Handle"}},{"name":"viewer_identity_id","in":"path","required":true,"schema":{"type":"string","title":"Viewer Identity Id"}}],"responses":{"410":{"description":"Successful Response","content":{"application/json":{"schema":{"allOf":[{"type":"object","additionalProperties":{"type":"string"},"title":"Response Revoke Identity Access  Agent Handle  Access  Viewer Identity Id  Delete"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/identities/a2a/directory":{"get":{"tags":["A2A"],"summary":"List Organization A2A Directory","operationId":"list_organization_a2a_directory_a2a_directory_get","parameters":[{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":1,"maxLength":100},{"type":"null"}],"title":"Q"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/A2ADirectoryPage"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/identities/a2a/settings":{"get":{"tags":["A2A"],"summary":"List Organization A2A Settings","operationId":"list_organization_a2a_settings_a2a_settings_get","parameters":[{"name":"enabled","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Enabled"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/A2ASettingsListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/identities/a2a/contact-rules":{"get":{"tags":["A2A"],"summary":"List Organization A2A Contact Rules","operationId":"list_organization_a2a_contact_rules_a2a_contact_rules_get","parameters":[{"name":"agent_identity_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Agent Identity Id"}},{"name":"action","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/A2ARuleAction"},{"type":"null"}],"title":"Action"}},{"name":"direction","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/A2ARuleDirection"},{"type":"null"}],"title":"Direction"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","maximum":10000,"minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/A2AIdentityContactRuleResponse"},"title":"Response List Organization A2A Contact Rules A2A Contact Rules Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/identities/":{"get":{"tags":["Identities"],"summary":"List Identities","operationId":"list_identities__get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/AgentIdentityDetailResponse"},"type":"array","title":"Response List Identities  Get"}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"post":{"tags":["Identities"],"summary":"Create an identity with its mandatory mailbox and tunnel, optionally also a phone number and/or attached vault secret access","operationId":"create_identity__post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentIdentityCreateRequest"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentIdentityDetailResponse"}}}},"402":{"description":"An identity or dedicated-number quota was exceeded.","content":{"application/json":{"schema":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/IMessageDedicatedNumberQuotaErrorResponse"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]},{"allOf":[{"$ref":"#/components/schemas/AgentIdentityOperationErrorResponse"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}],"title":"Response 402 Create Identity  Post"}}}},"503":{"description":"Identity provisioning is temporarily unavailable.","headers":{"Retry-After":{"description":"Present for number-inventory errors; seconds to wait.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/IMessageDedicatedNumberInventoryErrorResponse"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]},{"allOf":[{"$ref":"#/components/schemas/AgentIdentityOperationErrorResponse"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}],"title":"Response 503 Create Identity  Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/identities/self":{"get":{"tags":["Identities"],"summary":"Get Current Identity","operationId":"get_current_identity_self_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentIdentityDetailResponse"}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/api/v1/identities/{agent_handle}/channel-status":{"get":{"tags":["Identities"],"summary":"Get Identity Channel Status","operationId":"get_identity_channel_status__agent_handle__channel_status_get","parameters":[{"name":"agent_handle","in":"path","required":true,"schema":{"type":"string","title":"Agent Handle"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentityChannelStatusResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/identities/{agent_handle}":{"get":{"tags":["Identities"],"summary":"Get Identity","operationId":"get_identity__agent_handle__get","parameters":[{"name":"agent_handle","in":"path","required":true,"schema":{"type":"string","title":"Agent Handle"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentIdentityDetailResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"patch":{"tags":["Identities"],"summary":"Update Identity","operationId":"update_identity__agent_handle__patch","parameters":[{"name":"agent_handle","in":"path","required":true,"schema":{"type":"string","title":"Agent Handle"}},{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}],"description":"Required when claim_imessage_number claims a new line; replays return the original PATCH result.","title":"Idempotency-Key"},"description":"Required when claim_imessage_number claims a new line; replays return the original PATCH result."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentIdentityUpdateRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentIdentityDetailResponse"}}}},"400":{"description":"The identity mutation request is invalid.","content":{"application/json":{"schema":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/IMessageNumberClaimIdempotencyRequiredResponse"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]},{"allOf":[{"$ref":"#/components/schemas/AgentIdentityOperationErrorResponse"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}],"title":"Response 400 Update Identity  Agent Handle  Patch"}}}},"402":{"description":"An identity or dedicated-number quota was exceeded.","content":{"application/json":{"schema":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/IMessageDedicatedNumberQuotaErrorResponse"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]},{"allOf":[{"$ref":"#/components/schemas/AgentIdentityOperationErrorResponse"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}],"title":"Response 402 Update Identity  Agent Handle  Patch"}}}},"409":{"description":"The identity mutation conflicts with current state.","content":{"application/json":{"schema":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/IMessageDedicatedNumberIdempotencyErrorResponse"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]},{"allOf":[{"$ref":"#/components/schemas/AgentIdentityOperationErrorResponse"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}],"title":"Response 409 Update Identity  Agent Handle  Patch"}}}},"503":{"description":"Identity provisioning is temporarily unavailable.","headers":{"Retry-After":{"description":"Present for number-inventory errors; seconds to wait.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/IMessageDedicatedNumberInventoryErrorResponse"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]},{"allOf":[{"$ref":"#/components/schemas/AgentIdentityOperationErrorResponse"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}],"title":"Response 503 Update Identity  Agent Handle  Patch"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"delete":{"tags":["Identities"],"summary":"Delete Identity","operationId":"delete_identity__agent_handle__delete","parameters":[{"name":"agent_handle","in":"path","required":true,"schema":{"type":"string","title":"Agent Handle"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/identities/{agent_handle}/avatar":{"put":{"tags":["Identities"],"summary":"Upload Identity Avatar","operationId":"upload_identity_avatar__agent_handle__avatar_put","parameters":[{"name":"agent_handle","in":"path","required":true,"schema":{"type":"string","title":"Agent Handle"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_upload_identity_avatar__agent_handle__avatar_put"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentIdentityResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"get":{"tags":["Identities"],"summary":"Get Identity Avatar","operationId":"get_identity_avatar__agent_handle__avatar_get","parameters":[{"name":"agent_handle","in":"path","required":true,"schema":{"type":"string","title":"Agent Handle"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"delete":{"tags":["Identities"],"summary":"Delete Identity Avatar","operationId":"delete_identity_avatar__agent_handle__avatar_delete","parameters":[{"name":"agent_handle","in":"path","required":true,"schema":{"type":"string","title":"Agent Handle"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/identities/{agent_handle}/avatar-metadata":{"get":{"tags":["Identities"],"summary":"Get Identity Avatar Metadata","operationId":"get_identity_avatar_metadata__agent_handle__avatar_metadata_get","parameters":[{"name":"agent_handle","in":"path","required":true,"schema":{"type":"string","title":"Agent Handle"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentityAvatarMetadataResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/identities/{agent_handle}/avatar/staged":{"post":{"tags":["Identities"],"summary":"Set Identity Avatar From Staged Media","operationId":"set_identity_avatar_from_staged_media__agent_handle__avatar_staged_post","parameters":[{"name":"agent_handle","in":"path","required":true,"schema":{"type":"string","title":"Agent Handle"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentityStagedAvatarRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentityAvatarChangeResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/api/v1/identities/{agent_handle}/phone_number":{"delete":{"tags":["Identities"],"summary":"Release Identity Phone Number","operationId":"release_identity_phone_number__agent_handle__phone_number_delete","parameters":[{"name":"agent_handle","in":"path","required":true,"schema":{"type":"string","title":"Agent Handle"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/identities/{agent_handle}/imessage_number":{"post":{"tags":["Identities"],"summary":"Connect Identity Imessage Number","operationId":"connect_identity_imessage_number__agent_handle__imessage_number_post","parameters":[{"name":"agent_handle","in":"path","required":true,"schema":{"type":"string","title":"Agent Handle"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectIMessageNumberRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentIdentityIMessageNumberResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"delete":{"tags":["Identities"],"summary":"Disconnect Identity Imessage Number","operationId":"disconnect_identity_imessage_number__agent_handle__imessage_number_delete","parameters":[{"name":"agent_handle","in":"path","required":true,"schema":{"type":"string","title":"Agent Handle"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/identities/{agent_handle}/mail-contact-rules":{"post":{"tags":["Identities"],"summary":"Create Mail Contact Rule","operationId":"create_mail_contact_rule__agent_handle__mail_contact_rules_post","parameters":[{"name":"agent_handle","in":"path","required":true,"schema":{"type":"string","title":"Agent Handle"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailContactRuleCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailIdentityContactRuleResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"get":{"tags":["Identities"],"summary":"List Mail Contact Rules","operationId":"list_mail_contact_rules__agent_handle__mail_contact_rules_get","parameters":[{"name":"agent_handle","in":"path","required":true,"schema":{"type":"string","title":"Agent Handle"}},{"name":"action","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/MailRuleAction"},{"type":"null"}],"description":"Filter by allow or block.","title":"Action"},"description":"Filter by allow or block."},{"name":"match_type","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/MailRuleMatchType"},{"type":"null"}],"description":"Filter by exact_email or domain.","title":"Match Type"},"description":"Filter by exact_email or domain."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Max rules to return.","default":50,"title":"Limit"},"description":"Max rules to return."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Number of rules to skip.","default":0,"title":"Offset"},"description":"Number of rules to skip."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MailIdentityContactRuleResponse"},"title":"Response List Mail Contact Rules  Agent Handle  Mail Contact Rules Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/identities/{agent_handle}/mail-contact-rules/{rule_id}":{"get":{"tags":["Identities"],"summary":"Get Mail Contact Rule","operationId":"get_mail_contact_rule__agent_handle__mail_contact_rules__rule_id__get","parameters":[{"name":"rule_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Rule Id"}},{"name":"agent_handle","in":"path","required":true,"schema":{"type":"string","title":"Agent Handle"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailIdentityContactRuleResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"patch":{"tags":["Identities"],"summary":"Update Mail Contact Rule","operationId":"update_mail_contact_rule__agent_handle__mail_contact_rules__rule_id__patch","parameters":[{"name":"rule_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Rule Id"}},{"name":"agent_handle","in":"path","required":true,"schema":{"type":"string","title":"Agent Handle"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailContactRuleUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailIdentityContactRuleResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"delete":{"tags":["Identities"],"summary":"Delete Mail Contact Rule","operationId":"delete_mail_contact_rule__agent_handle__mail_contact_rules__rule_id__delete","parameters":[{"name":"rule_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Rule Id"}},{"name":"agent_handle","in":"path","required":true,"schema":{"type":"string","title":"Agent Handle"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/identities/{agent_handle}/phone-contact-rules":{"post":{"tags":["Identities"],"summary":"Create Phone Contact Rule","operationId":"create_phone_contact_rule__agent_handle__phone_contact_rules_post","parameters":[{"name":"agent_handle","in":"path","required":true,"schema":{"type":"string","title":"Agent Handle"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhoneContactRuleCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhoneIdentityContactRuleResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"get":{"tags":["Identities"],"summary":"List Phone Contact Rules","operationId":"list_phone_contact_rules__agent_handle__phone_contact_rules_get","parameters":[{"name":"agent_handle","in":"path","required":true,"schema":{"type":"string","title":"Agent Handle"}},{"name":"action","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/PhoneRuleAction"},{"type":"null"}],"description":"Filter by allow or block.","title":"Action"},"description":"Filter by allow or block."},{"name":"match_type","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/PhoneRuleMatchType"},{"type":"null"}],"description":"Filter by match type (only 'exact_number' in v1).","title":"Match Type"},"description":"Filter by match type (only 'exact_number' in v1)."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Max rules to return.","default":50,"title":"Limit"},"description":"Max rules to return."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Number of rules to skip.","default":0,"title":"Offset"},"description":"Number of rules to skip."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PhoneIdentityContactRuleResponse"},"title":"Response List Phone Contact Rules  Agent Handle  Phone Contact Rules Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/identities/{agent_handle}/phone-contact-rules/{rule_id}":{"get":{"tags":["Identities"],"summary":"Get Phone Contact Rule","operationId":"get_phone_contact_rule__agent_handle__phone_contact_rules__rule_id__get","parameters":[{"name":"rule_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Rule Id"}},{"name":"agent_handle","in":"path","required":true,"schema":{"type":"string","title":"Agent Handle"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhoneIdentityContactRuleResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"patch":{"tags":["Identities"],"summary":"Update Phone Contact Rule","operationId":"update_phone_contact_rule__agent_handle__phone_contact_rules__rule_id__patch","parameters":[{"name":"rule_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Rule Id"}},{"name":"agent_handle","in":"path","required":true,"schema":{"type":"string","title":"Agent Handle"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhoneContactRuleUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhoneIdentityContactRuleResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"delete":{"tags":["Identities"],"summary":"Delete Phone Contact Rule","operationId":"delete_phone_contact_rule__agent_handle__phone_contact_rules__rule_id__delete","parameters":[{"name":"rule_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Rule Id"}},{"name":"agent_handle","in":"path","required":true,"schema":{"type":"string","title":"Agent Handle"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/identities/{agent_handle}/signing-key":{"get":{"tags":["Identities"],"summary":"Get Identity Signing Key Status","operationId":"get_identity_signing_key_status__agent_handle__signing_key_get","parameters":[{"name":"agent_handle","in":"path","required":true,"schema":{"type":"string","title":"Agent Handle"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SigningKeyStatusResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"post":{"tags":["Identities"],"summary":"Create Or Rotate Identity Signing Key","operationId":"create_or_rotate_identity_signing_key__agent_handle__signing_key_post","parameters":[{"name":"agent_handle","in":"path","required":true,"schema":{"type":"string","title":"Agent Handle"}}],"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SigningKeyCreateResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/identities/{agent_handle}/a2a/settings":{"get":{"tags":["A2A"],"summary":"Get A2A Settings","operationId":"get_a2a_settings__agent_handle__a2a_settings_get","parameters":[{"name":"agent_handle","in":"path","required":true,"schema":{"type":"string","title":"Agent Handle"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/A2ASettingsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"put":{"tags":["A2A"],"summary":"Update A2A Settings","operationId":"update_a2a_settings__agent_handle__a2a_settings_put","parameters":[{"name":"agent_handle","in":"path","required":true,"schema":{"type":"string","title":"Agent Handle"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/A2ASettingsUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/A2ASettingsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/identities/{agent_handle}/a2a/card":{"get":{"tags":["A2A"],"summary":"Preview A2A Card","operationId":"preview_a2a_card__agent_handle__a2a_card_get","parameters":[{"name":"agent_handle","in":"path","required":true,"schema":{"type":"string","title":"Agent Handle"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Preview A2A Card  Agent Handle  A2A Card Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/identities/{agent_handle}/a2a/tasks":{"get":{"tags":["A2A"],"summary":"List A2A Tasks","operationId":"list_a2a_tasks__agent_handle__a2a_tasks_get","parameters":[{"name":"agent_handle","in":"path","required":true,"schema":{"type":"string","title":"Agent Handle"}},{"name":"direction","in":"query","required":false,"schema":{"$ref":"#/components/schemas/A2AHistoryDirection","description":"Task direction relative to the identity in the path.","default":"inbound"},"description":"Task direction relative to the identity in the path."},{"name":"requester_handle","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Requester Handle"}},{"name":"worker_handle","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Worker Handle"}},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/A2ATaskState"},{"type":"null"}],"title":"State"}},{"name":"context_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Context Id"}},{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":1,"maxLength":500},{"type":"null"}],"description":"Full-text search over task message content; results remain newest first.","title":"Q"},"description":"Full-text search over task message content; results remain newest first."},{"name":"since","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Since"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/A2ATaskPage"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/identities/{agent_handle}/a2a/sent/tasks":{"get":{"tags":["A2A"],"summary":"List Sent A2A Tasks","operationId":"list_sent_a2a_tasks__agent_handle__a2a_sent_tasks_get","parameters":[{"name":"agent_handle","in":"path","required":true,"schema":{"type":"string","title":"Agent Handle"}},{"name":"requester_handle","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Requester Handle"}},{"name":"worker_handle","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Worker Handle"}},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/A2ATaskState"},{"type":"null"}],"title":"State"}},{"name":"context_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Context Id"}},{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":1,"maxLength":500},{"type":"null"}],"description":"Full-text search over task message content; results remain newest first.","title":"Q"},"description":"Full-text search over task message content; results remain newest first."},{"name":"since","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Since"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/A2ATaskPage"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/identities/{agent_handle}/a2a/messages":{"get":{"tags":["A2A"],"summary":"List A2A Messages","operationId":"list_a2a_messages__agent_handle__a2a_messages_get","parameters":[{"name":"agent_handle","in":"path","required":true,"schema":{"type":"string","title":"Agent Handle"}},{"name":"direction","in":"query","required":false,"schema":{"$ref":"#/components/schemas/A2AHistoryDirection","description":"Task direction relative to the identity in the path.","default":"both"},"description":"Task direction relative to the identity in the path."},{"name":"requester_handle","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Requester Handle"}},{"name":"worker_handle","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Worker Handle"}},{"name":"task_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Task Id"}},{"name":"context_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Context Id"}},{"name":"role","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/A2AMessageRole"},{"type":"null"}],"description":"Message author role; this is independent of task direction.","title":"Role"},"description":"Message author role; this is independent of task direction."},{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":1,"maxLength":500},{"type":"null"}],"description":"Full-text search over message content; results remain newest first.","title":"Q"},"description":"Full-text search over message content; results remain newest first."},{"name":"since","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Since"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/A2AHistoryMessagePage"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/identities/{agent_handle}/a2a/sent/tasks/{task_id}":{"get":{"tags":["A2A"],"summary":"Get Sent A2A Task","operationId":"get_sent_a2a_task__agent_handle__a2a_sent_tasks__task_id__get","parameters":[{"name":"task_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Task Id"}},{"name":"agent_handle","in":"path","required":true,"schema":{"type":"string","title":"Agent Handle"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/A2ATaskResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/identities/{agent_handle}/a2a/tasks/{task_id}":{"get":{"tags":["A2A"],"summary":"Get A2A Task","operationId":"get_a2a_task__agent_handle__a2a_tasks__task_id__get","parameters":[{"name":"task_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Task Id"}},{"name":"agent_handle","in":"path","required":true,"schema":{"type":"string","title":"Agent Handle"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/A2ATaskResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/identities/{agent_handle}/a2a/tasks/{task_id}/reply":{"post":{"tags":["A2A"],"summary":"Reply To A2A Task","operationId":"reply_to_a2a_task__agent_handle__a2a_tasks__task_id__reply_post","parameters":[{"name":"task_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Task Id"}},{"name":"agent_handle","in":"path","required":true,"schema":{"type":"string","title":"Agent Handle"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/A2AReplyRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/A2ATaskResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/identities/{agent_handle}/a2a/contexts":{"get":{"tags":["A2A"],"summary":"List A2A Contexts","operationId":"list_a2a_contexts__agent_handle__a2a_contexts_get","parameters":[{"name":"agent_handle","in":"path","required":true,"schema":{"type":"string","title":"Agent Handle"}},{"name":"direction","in":"query","required":false,"schema":{"$ref":"#/components/schemas/A2AHistoryDirection","description":"Context direction relative to the identity in the path.","default":"inbound"},"description":"Context direction relative to the identity in the path."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/A2AContextPage"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/identities/{agent_handle}/a2a/sent/contexts":{"get":{"tags":["A2A"],"summary":"List Sent A2A Contexts","operationId":"list_sent_a2a_contexts__agent_handle__a2a_sent_contexts_get","parameters":[{"name":"agent_handle","in":"path","required":true,"schema":{"type":"string","title":"Agent Handle"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/A2AContextPage"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/identities/{agent_handle}/a2a/sent/contexts/{context_id}":{"get":{"tags":["A2A"],"summary":"Get Sent A2A Context","operationId":"get_sent_a2a_context__agent_handle__a2a_sent_contexts__context_id__get","parameters":[{"name":"context_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Context Id"}},{"name":"agent_handle","in":"path","required":true,"schema":{"type":"string","title":"Agent Handle"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/A2AContextResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/identities/{agent_handle}/a2a/contexts/{context_id}":{"get":{"tags":["A2A"],"summary":"Get A2A Context","operationId":"get_a2a_context__agent_handle__a2a_contexts__context_id__get","parameters":[{"name":"context_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Context Id"}},{"name":"agent_handle","in":"path","required":true,"schema":{"type":"string","title":"Agent Handle"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/A2AContextResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"patch":{"tags":["A2A"],"summary":"Patch A2A Context","operationId":"patch_a2a_context__agent_handle__a2a_contexts__context_id__patch","parameters":[{"name":"context_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Context Id"}},{"name":"agent_handle","in":"path","required":true,"schema":{"type":"string","title":"Agent Handle"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/A2AContextPatchRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/A2AContextResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/identities/{agent_handle}/a2a/contact-rules":{"get":{"tags":["A2A"],"summary":"List A2A Contact Rules","operationId":"list_a2a_contact_rules__agent_handle__a2a_contact_rules_get","parameters":[{"name":"agent_handle","in":"path","required":true,"schema":{"type":"string","title":"Agent Handle"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/A2AContactRuleResponse"},"title":"Response List A2A Contact Rules  Agent Handle  A2A Contact Rules Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"post":{"tags":["A2A"],"summary":"Create A2A Contact Rule","operationId":"create_a2a_contact_rule__agent_handle__a2a_contact_rules_post","parameters":[{"name":"agent_handle","in":"path","required":true,"schema":{"type":"string","title":"Agent Handle"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/A2AContactRuleCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/A2AContactRuleResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/identities/{agent_handle}/a2a/contact-rules/{rule_id}":{"patch":{"tags":["A2A"],"summary":"Update A2A Contact Rule","operationId":"update_a2a_contact_rule__agent_handle__a2a_contact_rules__rule_id__patch","parameters":[{"name":"rule_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Rule Id"}},{"name":"agent_handle","in":"path","required":true,"schema":{"type":"string","title":"Agent Handle"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/A2AContactRuleUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/A2AContactRuleResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"delete":{"tags":["A2A"],"summary":"Delete A2A Contact Rule","operationId":"delete_a2a_contact_rule__agent_handle__a2a_contact_rules__rule_id__delete","parameters":[{"name":"rule_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Rule Id"}},{"name":"agent_handle","in":"path","required":true,"schema":{"type":"string","title":"Agent Handle"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/imessage/identities/{agent_handle}/contact-rules":{"post":{"tags":["iMessage Contact Rules"],"summary":"Create Imessage Contact Rule","operationId":"create_imessage_contact_rule_identities__agent_handle__contact_rules_post","parameters":[{"name":"agent_handle","in":"path","required":true,"schema":{"type":"string","title":"Agent Handle"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IMessageContactRuleCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IMessageContactRuleResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"get":{"tags":["iMessage Contact Rules"],"summary":"List Imessage Contact Rules","operationId":"list_imessage_contact_rules_identities__agent_handle__contact_rules_get","parameters":[{"name":"agent_handle","in":"path","required":true,"schema":{"type":"string","title":"Agent Handle"}},{"name":"action","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/IMessageRuleAction"},{"type":"null"}],"description":"Filter by allow or block.","title":"Action"},"description":"Filter by allow or block."},{"name":"match_type","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/IMessageRuleMatchType"},{"type":"null"}],"description":"Filter by match type (only 'exact_number' in v1).","title":"Match Type"},"description":"Filter by match type (only 'exact_number' in v1)."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IMessageContactRuleResponse"},"title":"Response List Imessage Contact Rules Identities  Agent Handle  Contact Rules Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/imessage/identities/{agent_handle}/contact-rules/{rule_id}":{"get":{"tags":["iMessage Contact Rules"],"summary":"Get Imessage Contact Rule","operationId":"get_imessage_contact_rule_identities__agent_handle__contact_rules__rule_id__get","parameters":[{"name":"rule_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Rule Id"}},{"name":"agent_handle","in":"path","required":true,"schema":{"type":"string","title":"Agent Handle"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IMessageContactRuleResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"patch":{"tags":["iMessage Contact Rules"],"summary":"Update Imessage Contact Rule","operationId":"update_imessage_contact_rule_identities__agent_handle__contact_rules__rule_id__patch","parameters":[{"name":"rule_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Rule Id"}},{"name":"agent_handle","in":"path","required":true,"schema":{"type":"string","title":"Agent Handle"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IMessageContactRuleUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IMessageContactRuleResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"delete":{"tags":["iMessage Contact Rules"],"summary":"Delete Imessage Contact Rule","operationId":"delete_imessage_contact_rule_identities__agent_handle__contact_rules__rule_id__delete","parameters":[{"name":"rule_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Rule Id"}},{"name":"agent_handle","in":"path","required":true,"schema":{"type":"string","title":"Agent Handle"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/imessage/contact-rules":{"get":{"tags":["iMessage Contact Rules"],"summary":"List Org Imessage Contact Rules","operationId":"list_org_imessage_contact_rules_contact_rules_get","parameters":[{"name":"agent_identity_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"Narrow to one agent identity. Omit to list across every visible identity.","title":"Agent Identity Id"},"description":"Narrow to one agent identity. Omit to list across every visible identity."},{"name":"action","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/IMessageRuleAction"},{"type":"null"}],"description":"Filter by allow or block.","title":"Action"},"description":"Filter by allow or block."},{"name":"match_type","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/IMessageRuleMatchType"},{"type":"null"}],"description":"Filter by match type (only 'exact_number' in v1).","title":"Match Type"},"description":"Filter by match type (only 'exact_number' in v1)."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IMessageContactRuleResponse"},"title":"Response List Org Imessage Contact Rules Contact Rules Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/imessage/check-messaging-capability":{"get":{"tags":["iMessage"],"summary":"Check Messaging Capability","operationId":"check_messaging_capability","parameters":[{"name":"number","in":"query","required":true,"schema":{"type":"string","description":"Phone number in E.164 format (e.g. '+15551234567').","examples":["+15551234567"],"title":"Number"},"description":"Recipient phone number in E.164 format."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagingCapability"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/imessage/onboarding":{"get":{"tags":["iMessage"],"summary":"Get Onboarding","operationId":"get_onboarding_onboarding_get","parameters":[{"name":"agent_identity_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Agent Identity Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Get Onboarding Onboarding Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/imessage/triage-number":{"get":{"tags":["iMessage"],"summary":"Get Triage Number","operationId":"get_triage_number_triage_number_get","parameters":[{"name":"agent_identity_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"Resolve the connect command + link/QR for this agent identity. Org-wide callers (admin keys / JWT) may pass any identity in the org; agent-scoped keys may only pass their own.","title":"Agent Identity Id"},"description":"Resolve the connect command + link/QR for this agent identity. Org-wide callers (admin keys / JWT) may pass any identity in the org; agent-scoped keys may only pass their own."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IMessageTriageNumberResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/imessage/numbers":{"get":{"tags":["iMessage"],"summary":"List Numbers","operationId":"list_numbers_numbers_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IMessageDedicatedNumberResponse"},"title":"Response List Numbers Numbers Get"}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"post":{"tags":["iMessage"],"summary":"Claim Number","operationId":"claim_number_numbers_post","parameters":[{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string","minLength":1,"maxLength":255,"description":"Unique key used to replay this claim without allocating twice.","title":"Idempotency-Key"},"description":"Unique key used to replay this claim without allocating twice."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClaimIMessageNumberRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IMessageDedicatedNumberResponse"}}}},"402":{"description":"The organization has no remaining quota for this number type.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/IMessageDedicatedNumberQuotaErrorResponse"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"409":{"description":"The Idempotency-Key was reused for an incompatible claim.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/IMessageDedicatedNumberIdempotencyErrorResponse"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"503":{"description":"No reserve number of the requested type is currently available.","headers":{"Retry-After":{"description":"Seconds to wait before retrying the claim.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/IMessageDedicatedNumberInventoryErrorResponse"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/imessage/messages":{"post":{"tags":["iMessage"],"summary":"Send Message","operationId":"send_message_messages_post","parameters":[{"name":"agent_identity_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"Agent identity to send as. Required for org-wide callers when sending by `to`; ignored for agent-scoped keys.","title":"Agent Identity Id"},"description":"Agent identity to send as. Required for org-wide callers when sending by `to`; ignored for agent-scoped keys."},{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Idempotency-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendIMessageRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/SendIMessageResponse"},{"$ref":"#/components/schemas/IMessageSendCommandResponse"},{"$ref":"#/components/schemas/IMessageGroupSendCommandResponse"}],"title":"Response Send Message Messages Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"get":{"tags":["iMessage"],"summary":"List Messages","operationId":"list_messages_messages_get","parameters":[{"name":"agent_identity_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Agent Identity Id"}},{"name":"conversation_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Conversation Id"}},{"name":"include_groups","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Include Groups"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}},{"name":"is_read","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Read"}},{"name":"is_blocked","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Blocked"}},{"name":"start_datetime","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter created_at >= this date/datetime. Bare date => whole day in tz.","title":"Start Datetime"},"description":"Filter created_at >= this date/datetime. Bare date => whole day in tz."},{"name":"end_datetime","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter created_at <= this date/datetime. Bare date => whole day inclusive.","title":"End Datetime"},"description":"Filter created_at <= this date/datetime. Bare date => whole day inclusive."},{"name":"tz","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"IANA zone (e.g. America/New_York) for zone-less values; default UTC.","title":"Tz"},"description":"IANA zone (e.g. America/New_York) for zone-less values; default UTC."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IMessageMessageResponse"},"title":"Response List Messages Messages Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/imessage/conversations":{"get":{"tags":["iMessage"],"summary":"List Conversations","operationId":"list_conversations_conversations_get","parameters":[{"name":"agent_identity_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Agent Identity Id"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}},{"name":"is_blocked","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Blocked"}},{"name":"include_groups","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Include Groups"}},{"name":"start_datetime","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter created_at >= this date/datetime. Bare date => whole day in tz.","title":"Start Datetime"},"description":"Filter created_at >= this date/datetime. Bare date => whole day in tz."},{"name":"end_datetime","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter created_at <= this date/datetime. Bare date => whole day inclusive.","title":"End Datetime"},"description":"Filter created_at <= this date/datetime. Bare date => whole day inclusive."},{"name":"tz","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"IANA zone (e.g. America/New_York) for zone-less values; default UTC.","title":"Tz"},"description":"IANA zone (e.g. America/New_York) for zone-less values; default UTC."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IMessageConversationSummary"},"title":"Response List Conversations Conversations Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/imessage/conversations/{conversation_id}":{"get":{"tags":["iMessage"],"summary":"Get Conversation","operationId":"get_conversation_conversations__conversation_id__get","parameters":[{"name":"conversation_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Conversation Id"}},{"name":"agent_identity_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Agent Identity Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IMessageConversationResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/imessage/assignments":{"get":{"tags":["iMessage"],"summary":"List Assignments","operationId":"list_assignments_assignments_get","parameters":[{"name":"agent_identity_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"Narrow to one agent identity. Ignored for agent-scoped keys (always their own identity).","title":"Agent Identity Id"},"description":"Narrow to one agent identity. Ignored for agent-scoped keys (always their own identity)."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IMessageAssignmentResponse"},"title":"Response List Assignments Assignments Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/imessage/reactions":{"post":{"tags":["iMessage"],"summary":"Send Reaction","operationId":"send_reaction_reactions_post","parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Idempotency-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendIMessageReactionRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/IMessageReactionResponse"},{"$ref":"#/components/schemas/IMessageReactionCommandResponse"}],"title":"Response Send Reaction Reactions Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/imessage/reactions/{reaction_id}":{"delete":{"tags":["iMessage"],"summary":"Remove Reaction","operationId":"remove_reaction_reactions__reaction_id__delete","parameters":[{"name":"reaction_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Reaction Id"}},{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Idempotency-Key"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/imessage/mark-read":{"post":{"tags":["iMessage"],"summary":"Mark Read","operationId":"mark_read_mark_read_post","parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Idempotency-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkIMessageReadRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/MarkIMessageReadResponse"},{"$ref":"#/components/schemas/IMessageReadCommandResponse"}],"title":"Response Mark Read Mark Read Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/imessage/media":{"post":{"tags":["iMessage"],"summary":"Upload Media","operationId":"upload_media_media_post","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_upload_media_media_post"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadIMessageMediaResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/imessage/typing":{"post":{"tags":["iMessage"],"summary":"Send Typing","operationId":"send_typing_typing_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendIMessageTypingRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":{"type":"string"},"type":"object","title":"Response Send Typing Typing Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/imessage/router":{"get":{"tags":["iMessage Router"],"summary":"Get Router","operationId":"get_router_router_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IMessageRouterResponse"}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"patch":{"tags":["iMessage Router"],"summary":"Update Router","operationId":"update_router_router_patch","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateIMessageRouterConfigRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IMessageRouterResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/imessage/router/connect-onboarding":{"patch":{"tags":["iMessage Router"],"summary":"Update Router Connect Onboarding","operationId":"update_router_connect_onboarding_router_connect_onboarding_patch","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateIMessageRouterConnectOnboardingRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IMessageRouterResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/imessage/router/avatar":{"get":{"tags":["iMessage Router"],"summary":"Get Router Avatar","operationId":"get_router_avatar_router_avatar_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"put":{"tags":["iMessage Router"],"summary":"Upload Router Avatar","operationId":"upload_router_avatar_router_avatar_put","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_upload_router_avatar_router_avatar_put"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IMessageRouterResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"BearerAuth":[]}]},"delete":{"tags":["iMessage Router"],"summary":"Delete Router Avatar","operationId":"delete_router_avatar_router_avatar_delete","responses":{"204":{"description":"Successful Response"},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/imessage/router/conversations":{"get":{"tags":["iMessage Router"],"summary":"List Router Conversations","operationId":"list_router_conversations_router_conversations_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IMessageRouterConversationPage"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/imessage/router/conversations/{conversation_id}":{"get":{"tags":["iMessage Router"],"summary":"Get Router Conversation","operationId":"get_router_conversation_router_conversations__conversation_id__get","parameters":[{"name":"conversation_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Conversation Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IMessageRouterConversationResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/imessage/router/conversations/{conversation_id}/messages":{"get":{"tags":["iMessage Router"],"summary":"List Router Messages","operationId":"list_router_messages_router_conversations__conversation_id__messages_get","parameters":[{"name":"conversation_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Conversation Id"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":100,"title":"Limit"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IMessageRouterMessagePage"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/imessage/admin/numbers":{"get":{"tags":["iMessage Admin"],"summary":"List Admin Numbers","operationId":"list_admin_numbers_admin_numbers_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/AdminIMessageNumberResponse"},"type":"array","title":"Response List Admin Numbers Admin Numbers Get"}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}}},"post":{"tags":["iMessage Admin"],"summary":"Create Admin Number","operationId":"create_admin_number_admin_numbers_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateIMessageNumberRequest"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminIMessageNumberResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}}}},"/api/v1/imessage/admin/numbers/{number_id}":{"patch":{"tags":["iMessage Admin"],"summary":"Update Admin Number","operationId":"update_admin_number_admin_numbers__number_id__patch","parameters":[{"name":"number_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Number Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateIMessageNumberRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminIMessageNumberResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}}},"delete":{"tags":["iMessage Admin"],"summary":"Release Admin Number","operationId":"release_admin_number_admin_numbers__number_id__delete","parameters":[{"name":"number_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Number Id"}},{"name":"release_vendor","in":"query","required":false,"schema":{"type":"boolean","default":true,"title":"Release Vendor"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}}}},"/api/v1/mail/search":{"get":{"tags":["Search"],"summary":"Search Messages Org Wide","operationId":"search_messages_org_wide_search_get","parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":500,"description":"Search query","title":"Q"},"description":"Search query"},{"name":"mailbox_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Mailbox Id"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CursorPage_MessageResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/mail/messages":{"get":{"tags":["Messages"],"summary":"List Messages By Visibility","operationId":"list_messages_by_visibility_messages_get","parameters":[{"name":"mailbox_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Mailbox Id"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Limit"}},{"name":"direction","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/MessageDirection"},{"type":"null"}],"title":"Direction"}},{"name":"folder","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/ThreadFolder"},{"type":"null"}],"title":"Folder"}},{"name":"unread_only","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Unread Only"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CursorPage_SafeMessageResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/mail/messages/{message_id}":{"get":{"tags":["Messages"],"summary":"Get Message By Visibility","operationId":"get_message_by_visibility_messages__message_id__get","parameters":[{"name":"message_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Message Id"}},{"name":"max_body_chars","in":"query","required":false,"schema":{"type":"integer","maximum":100000,"minimum":1,"default":50000,"title":"Max Body Chars"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BoundedMessageDetailResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}]},"patch":{"tags":["Messages"],"summary":"Update Visible Message Flags","operationId":"update_visible_message_flags_messages__message_id__patch","parameters":[{"name":"message_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Message Id"}},{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Idempotency-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageFlagsUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"delete":{"tags":["Messages"],"summary":"Delete Visible Message","operationId":"delete_visible_message_messages__message_id__delete","parameters":[{"name":"message_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Message Id"}},{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Idempotency-Key"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/mail/messages/{message_id}/attachments/{attachment_ref}":{"get":{"tags":["Messages"],"summary":"Get Attachment By Reference","operationId":"get_attachment_by_reference_messages__message_id__attachments__attachment_ref__get","parameters":[{"name":"message_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Message Id"}},{"name":"attachment_ref","in":"path","required":true,"schema":{"type":"string","title":"Attachment Ref"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachmentDownloadResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}]}},"/api/v1/mail/threads":{"get":{"tags":["Threads"],"summary":"List Threads By Visibility","operationId":"list_threads_by_visibility_threads_get","parameters":[{"name":"mailbox_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Mailbox Id"}},{"name":"folder","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/ThreadFolder"},{"type":"null"}],"title":"Folder"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CursorPage_ThreadResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}]}},"/api/v1/mail/threads/{thread_id}":{"get":{"tags":["Threads"],"summary":"Get Thread By Visibility","operationId":"get_thread_by_visibility_threads__thread_id__get","parameters":[{"name":"thread_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Thread Id"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BoundedThreadDetailResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}]},"patch":{"tags":["Threads"],"summary":"Update Visible Thread","operationId":"update_visible_thread_threads__thread_id__patch","parameters":[{"name":"thread_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Thread Id"}},{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Idempotency-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThreadUpdateRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThreadResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"delete":{"tags":["Threads"],"summary":"Delete Visible Thread","operationId":"delete_visible_thread_threads__thread_id__delete","parameters":[{"name":"thread_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Thread Id"}},{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Idempotency-Key"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/mail/mailboxes":{"get":{"tags":["Mailboxes"],"summary":"List Mailboxes","operationId":"list_mailboxes_mailboxes_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":101,"minimum":1},{"type":"null"}],"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","maximum":10000,"minimum":0,"default":0,"title":"Offset"}},{"name":"include_unread_count","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Include Unread Count"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MailboxResponse"},"title":"Response List Mailboxes Mailboxes Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}]}},"/api/v1/mail/mailboxes/by-id/{mailbox_id}":{"get":{"tags":["Mailboxes"],"summary":"Get Mailbox By Id","operationId":"get_mailbox_by_id_mailboxes_by_id__mailbox_id__get","parameters":[{"name":"mailbox_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Mailbox Id"}},{"name":"include_unread_count","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Include Unread Count"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailboxResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}]}},"/api/v1/mail/mailboxes/{email_address}":{"get":{"tags":["Mailboxes"],"summary":"Get Mailbox","operationId":"get_mailbox_mailboxes__email_address__get","parameters":[{"name":"email_address","in":"path","required":true,"schema":{"type":"string","title":"Email Address"}},{"name":"include_unread_count","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Include Unread Count"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailboxResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}]},"patch":{"tags":["Mailboxes"],"summary":"Update Mailbox","operationId":"update_mailbox_mailboxes__email_address__patch","parameters":[{"name":"email_address","in":"path","required":true,"schema":{"type":"string","title":"Email Address"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailboxUpdateRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailboxResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/mail/mailboxes/{email_address}/messages":{"get":{"tags":["Messages"],"summary":"List Messages","operationId":"list_messages_mailboxes__email_address__messages_get","parameters":[{"name":"email_address","in":"path","required":true,"schema":{"type":"string","title":"Email Address"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Limit"}},{"name":"direction","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/MessageDirection"},{"type":"null"}],"title":"Direction"}},{"name":"folder","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/ThreadFolder"},{"type":"null"}],"description":"Filter by thread folder. Omit to list all.","title":"Folder"},"description":"Filter by thread folder. Omit to list all."},{"name":"start_datetime","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter created_at >= this date/datetime. Bare date => whole day in tz.","title":"Start Datetime"},"description":"Filter created_at >= this date/datetime. Bare date => whole day in tz."},{"name":"end_datetime","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter created_at <= this date/datetime. Bare date => whole day inclusive.","title":"End Datetime"},"description":"Filter created_at <= this date/datetime. Bare date => whole day inclusive."},{"name":"tz","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"IANA zone (e.g. America/New_York) for zone-less values; default UTC.","title":"Tz"},"description":"IANA zone (e.g. America/New_York) for zone-less values; default UTC."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CursorPage_MessageResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"post":{"tags":["Messages"],"summary":"Send Message","operationId":"send_message_mailboxes__email_address__messages_post","parameters":[{"name":"email_address","in":"path","required":true,"schema":{"type":"string","title":"Email Address"}},{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Idempotency-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageSend"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/mail/mailboxes/{email_address}/messages/{message_id}":{"get":{"tags":["Messages"],"summary":"Get Message","operationId":"get_message_mailboxes__email_address__messages__message_id__get","parameters":[{"name":"message_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Message Id"}},{"name":"email_address","in":"path","required":true,"schema":{"type":"string","title":"Email Address"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageDetailResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}]},"patch":{"tags":["Messages"],"summary":"Update Message Flags","operationId":"update_message_flags_mailboxes__email_address__messages__message_id__patch","parameters":[{"name":"message_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Message Id"}},{"name":"email_address","in":"path","required":true,"schema":{"type":"string","title":"Email Address"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageFlagsUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"delete":{"tags":["Messages"],"summary":"Delete Message","operationId":"delete_message_mailboxes__email_address__messages__message_id__delete","parameters":[{"name":"message_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Message Id"}},{"name":"email_address","in":"path","required":true,"schema":{"type":"string","title":"Email Address"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/mail/mailboxes/{email_address}/messages/{message_id}/reply-all":{"post":{"tags":["Messages"],"summary":"Reply All Message","operationId":"reply_all_message_mailboxes__email_address__messages__message_id__reply_all_post","parameters":[{"name":"message_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Message Id"}},{"name":"email_address","in":"path","required":true,"schema":{"type":"string","title":"Email Address"}},{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Idempotency-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageReplyAll"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}]}},"/api/v1/mail/mailboxes/{email_address}/messages/{message_id}/forward":{"post":{"tags":["Messages"],"summary":"Forward Message","operationId":"forward_message_mailboxes__email_address__messages__message_id__forward_post","parameters":[{"name":"message_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Message Id"}},{"name":"email_address","in":"path","required":true,"schema":{"type":"string","title":"Email Address"}},{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Idempotency-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageForward"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}]}},"/api/v1/mail/mailboxes/{email_address}/messages/{message_id}/attachments/{filename}":{"get":{"tags":["Messages"],"summary":"Get Attachment","operationId":"get_attachment_mailboxes__email_address__messages__message_id__attachments__filename__get","parameters":[{"name":"message_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Message Id"}},{"name":"filename","in":"path","required":true,"schema":{"type":"string","title":"Filename"}},{"name":"email_address","in":"path","required":true,"schema":{"type":"string","title":"Email Address"}},{"name":"redirect","in":"query","required":false,"schema":{"type":"boolean","description":"If true (default), 302 redirect to presigned URL; if false, return JSON with the URL.","default":true,"title":"Redirect"},"description":"If true (default), 302 redirect to presigned URL; if false, return JSON with the URL."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}]}},"/api/v1/mail/mailboxes/{email_address}/drafts":{"post":{"tags":["Drafts"],"summary":"Create Draft","operationId":"create_draft_mailboxes__email_address__drafts_post","parameters":[{"name":"email_address","in":"path","required":true,"schema":{"type":"string","title":"Email Address"}},{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}],"title":"Idempotency-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DraftCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DraftDetailResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}]},"get":{"tags":["Drafts"],"summary":"List Drafts","operationId":"list_drafts_mailboxes__email_address__drafts_get","parameters":[{"name":"email_address","in":"path","required":true,"schema":{"type":"string","title":"Email Address"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DraftListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}]}},"/api/v1/mail/mailboxes/{email_address}/drafts/{draft_id}":{"get":{"tags":["Drafts"],"summary":"Get Draft","operationId":"get_draft_mailboxes__email_address__drafts__draft_id__get","parameters":[{"name":"draft_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Draft Id"}},{"name":"email_address","in":"path","required":true,"schema":{"type":"string","title":"Email Address"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DraftDetailResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}]},"patch":{"tags":["Drafts"],"summary":"Update Draft","operationId":"update_draft_mailboxes__email_address__drafts__draft_id__patch","parameters":[{"name":"draft_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Draft Id"}},{"name":"email_address","in":"path","required":true,"schema":{"type":"string","title":"Email Address"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DraftUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DraftDetailResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}]},"delete":{"tags":["Drafts"],"summary":"Delete Draft","operationId":"delete_draft_mailboxes__email_address__drafts__draft_id__delete","parameters":[{"name":"draft_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Draft Id"}},{"name":"email_address","in":"path","required":true,"schema":{"type":"string","title":"Email Address"}},{"name":"generation","in":"query","required":true,"schema":{"type":"integer","minimum":1,"title":"Generation"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}]}},"/api/v1/mail/mailboxes/{email_address}/drafts/{draft_id}/attachments":{"post":{"tags":["Drafts"],"summary":"Add Attachments","operationId":"add_attachments_mailboxes__email_address__drafts__draft_id__attachments_post","parameters":[{"name":"draft_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Draft Id"}},{"name":"email_address","in":"path","required":true,"schema":{"type":"string","title":"Email Address"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DraftAttachmentAdd"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DraftDetailResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}]}},"/api/v1/mail/mailboxes/{email_address}/drafts/{draft_id}/attachments/{part_index}":{"delete":{"tags":["Drafts"],"summary":"Remove Attachment","operationId":"remove_attachment_mailboxes__email_address__drafts__draft_id__attachments__part_index__delete","parameters":[{"name":"draft_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Draft Id"}},{"name":"part_index","in":"path","required":true,"schema":{"type":"integer","title":"Part Index"}},{"name":"email_address","in":"path","required":true,"schema":{"type":"string","title":"Email Address"}},{"name":"generation","in":"query","required":true,"schema":{"type":"integer","minimum":1,"title":"Generation"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DraftDetailResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}]},"get":{"tags":["Drafts"],"summary":"Get Attachment","operationId":"get_attachment_mailboxes__email_address__drafts__draft_id__attachments__part_index__get","parameters":[{"name":"draft_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Draft Id"}},{"name":"part_index","in":"path","required":true,"schema":{"type":"integer","title":"Part Index"}},{"name":"email_address","in":"path","required":true,"schema":{"type":"string","title":"Email Address"}},{"name":"generation","in":"query","required":true,"schema":{"type":"integer","minimum":1,"title":"Generation"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}]}},"/api/v1/mail/mailboxes/{email_address}/drafts/{draft_id}/duplicate":{"post":{"tags":["Drafts"],"summary":"Duplicate Draft","operationId":"duplicate_draft_mailboxes__email_address__drafts__draft_id__duplicate_post","parameters":[{"name":"draft_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Draft Id"}},{"name":"email_address","in":"path","required":true,"schema":{"type":"string","title":"Email Address"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DraftGenerationRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DraftDetailResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}]}},"/api/v1/mail/mailboxes/{email_address}/drafts/{draft_id}/send":{"post":{"tags":["Drafts"],"summary":"Send Draft","operationId":"send_draft_mailboxes__email_address__drafts__draft_id__send_post","parameters":[{"name":"draft_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Draft Id"}},{"name":"email_address","in":"path","required":true,"schema":{"type":"string","title":"Email Address"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DraftGenerationRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}]}},"/api/v1/mail/mailboxes/{email_address}/threads/folders":{"get":{"tags":["Threads"],"summary":"List Folders","operationId":"list_folders_mailboxes__email_address__threads_folders_get","parameters":[{"name":"email_address","in":"path","required":true,"schema":{"type":"string","title":"Email Address"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ThreadFolder"},"title":"Response List Folders Mailboxes  Email Address  Threads Folders Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}]}},"/api/v1/mail/mailboxes/{email_address}/threads":{"get":{"tags":["Threads"],"summary":"List Threads","operationId":"list_threads_mailboxes__email_address__threads_get","parameters":[{"name":"email_address","in":"path","required":true,"schema":{"type":"string","title":"Email Address"}},{"name":"folder","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/ThreadFolder"},{"type":"null"}],"description":"Filter by folder. Omit to list all.","title":"Folder"},"description":"Filter by folder. Omit to list all."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CursorPage_ThreadResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}]}},"/api/v1/mail/mailboxes/{email_address}/threads/{thread_id}":{"get":{"tags":["Threads"],"summary":"Get Thread","operationId":"get_thread_mailboxes__email_address__threads__thread_id__get","parameters":[{"name":"thread_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Thread Id"}},{"name":"email_address","in":"path","required":true,"schema":{"type":"string","title":"Email Address"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThreadDetailResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}]},"patch":{"tags":["Threads"],"summary":"Update Thread","operationId":"update_thread_mailboxes__email_address__threads__thread_id__patch","parameters":[{"name":"thread_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Thread Id"}},{"name":"email_address","in":"path","required":true,"schema":{"type":"string","title":"Email Address"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThreadUpdateRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThreadResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"delete":{"tags":["Threads"],"summary":"Delete Thread","operationId":"delete_thread_mailboxes__email_address__threads__thread_id__delete","parameters":[{"name":"thread_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Thread Id"}},{"name":"email_address","in":"path","required":true,"schema":{"type":"string","title":"Email Address"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/mail/mailboxes/{email_address}/contact-rules":{"post":{"tags":["Contact Rules"],"summary":"Create Contact Rule","operationId":"create_contact_rule_mailboxes__email_address__contact_rules_post","deprecated":true,"parameters":[{"name":"email_address","in":"path","required":true,"schema":{"type":"string","title":"Email Address"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailContactRuleCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailContactRuleResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"get":{"tags":["Contact Rules"],"summary":"List Mail Contact Rules","operationId":"list_mail_contact_rules_mailboxes__email_address__contact_rules_get","deprecated":true,"parameters":[{"name":"email_address","in":"path","required":true,"schema":{"type":"string","title":"Email Address"}},{"name":"action","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/MailRuleAction"},{"type":"null"}],"description":"Filter by allow or block.","title":"Action"},"description":"Filter by allow or block."},{"name":"match_type","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/MailRuleMatchType"},{"type":"null"}],"description":"Filter by exact_email or domain.","title":"Match Type"},"description":"Filter by exact_email or domain."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Max rules to return.","default":50,"title":"Limit"},"description":"Max rules to return."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Number of rules to skip.","default":0,"title":"Offset"},"description":"Number of rules to skip."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MailContactRuleResponse"},"title":"Response List Mail Contact Rules Mailboxes  Email Address  Contact Rules Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/mail/mailboxes/{email_address}/contact-rules/{rule_id}":{"get":{"tags":["Contact Rules"],"summary":"Get Contact Rule","operationId":"get_contact_rule_mailboxes__email_address__contact_rules__rule_id__get","deprecated":true,"parameters":[{"name":"rule_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Rule Id"}},{"name":"email_address","in":"path","required":true,"schema":{"type":"string","title":"Email Address"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailContactRuleResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"patch":{"tags":["Contact Rules"],"summary":"Update Contact Rule","operationId":"update_contact_rule_mailboxes__email_address__contact_rules__rule_id__patch","deprecated":true,"parameters":[{"name":"rule_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Rule Id"}},{"name":"email_address","in":"path","required":true,"schema":{"type":"string","title":"Email Address"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailContactRuleUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailContactRuleResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"delete":{"tags":["Contact Rules"],"summary":"Delete Contact Rule","operationId":"delete_contact_rule_mailboxes__email_address__contact_rules__rule_id__delete","deprecated":true,"parameters":[{"name":"rule_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Rule Id"}},{"name":"email_address","in":"path","required":true,"schema":{"type":"string","title":"Email Address"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/mail/contact-rules":{"get":{"tags":["Contact Rules"],"summary":"List Org Mail Contact Rules","operationId":"list_org_mail_contact_rules_contact_rules_get","parameters":[{"name":"agent_identity_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"Narrow to a single agent identity. Omit to list across every identity in the org.","title":"Agent Identity Id"},"description":"Narrow to a single agent identity. Omit to list across every identity in the org."},{"name":"action","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/MailRuleAction"},{"type":"null"}],"description":"Filter by allow or block.","title":"Action"},"description":"Filter by allow or block."},{"name":"match_type","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/MailRuleMatchType"},{"type":"null"}],"description":"Filter by exact_email or domain.","title":"Match Type"},"description":"Filter by exact_email or domain."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Max rules to return.","default":50,"title":"Limit"},"description":"Max rules to return."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Number of rules to skip.","default":0,"title":"Offset"},"description":"Number of rules to skip."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MailIdentityContactRuleResponse"},"title":"Response List Org Mail Contact Rules Contact Rules Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/mail/mailboxes/{email_address}/search":{"get":{"tags":["Search"],"summary":"Search Messages","operationId":"search_messages_mailboxes__email_address__search_get","parameters":[{"name":"email_address","in":"path","required":true,"schema":{"type":"string","title":"Email Address"}},{"name":"q","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":500,"description":"Search query","title":"Q"},"description":"Search query"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CursorPage_MessageResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/mail/mailboxes/{email_address}/imports":{"post":{"tags":["Imports"],"summary":"Create Import Job","operationId":"create_import_job_mailboxes__email_address__imports_post","parameters":[{"name":"email_address","in":"path","required":true,"schema":{"type":"string","title":"Email Address"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailImportJobCreateRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailImportJobCreateResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"get":{"tags":["Imports"],"summary":"List Import Jobs","operationId":"list_import_jobs_mailboxes__email_address__imports_get","parameters":[{"name":"email_address","in":"path","required":true,"schema":{"type":"string","title":"Email Address"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CursorPage_MailImportJobResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}]}},"/api/v1/mail/mailboxes/{email_address}/imports/{job_id}/upload-url":{"post":{"tags":["Imports"],"summary":"Reissue Upload Url","operationId":"reissue_upload_url_mailboxes__email_address__imports__job_id__upload_url_post","parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Job Id"}},{"name":"email_address","in":"path","required":true,"schema":{"type":"string","title":"Email Address"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailImportUploadTarget"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/mail/mailboxes/{email_address}/imports/{job_id}/start":{"post":{"tags":["Imports"],"summary":"Start Import Job","operationId":"start_import_job_mailboxes__email_address__imports__job_id__start_post","parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Job Id"}},{"name":"email_address","in":"path","required":true,"schema":{"type":"string","title":"Email Address"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailImportJobResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/mail/mailboxes/{email_address}/imports/{job_id}":{"get":{"tags":["Imports"],"summary":"Get Import Job","operationId":"get_import_job_mailboxes__email_address__imports__job_id__get","parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Job Id"}},{"name":"email_address","in":"path","required":true,"schema":{"type":"string","title":"Email Address"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailImportJobResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}]}},"/api/v1/mail/mailboxes/{email_address}/imports/{job_id}/cancel":{"post":{"tags":["Imports"],"summary":"Cancel Import Job","operationId":"cancel_import_job_mailboxes__email_address__imports__job_id__cancel_post","parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Job Id"}},{"name":"email_address","in":"path","required":true,"schema":{"type":"string","title":"Email Address"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailImportJobResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/mail/mock-webhook":{"post":{"tags":["Mock"],"summary":"Mock Mail Webhook","operationId":"mock_mail_webhook_mock_webhook_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}}}},"/api/v1/notes/":{"post":{"tags":["Notes"],"summary":"Create Note","operationId":"create_note__post","parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Idempotency-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoteCreateRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoteResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"get":{"tags":["Notes"],"summary":"List Notes","operationId":"list_notes__get","parameters":[{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"description":"Full-text query against title + body.","title":"Q"},"description":"Full-text query against title + body."},{"name":"identity_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"Filter to notes granted to this identity (joins against the note_access table).","title":"Identity Id"},"description":"Filter to notes granted to this identity (joins against the note_access table)."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","maximum":10000,"minimum":0,"default":0,"title":"Offset"}},{"name":"order","in":"query","required":false,"schema":{"enum":["recent","created"],"type":"string","default":"recent","title":"Order"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NoteResponse"},"title":"Response List Notes  Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/notes/{note_id}":{"get":{"tags":["Notes"],"summary":"Get Note","operationId":"get_note__note_id__get","parameters":[{"name":"note_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Note Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoteResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"patch":{"tags":["Notes"],"summary":"Update Note","operationId":"update_note__note_id__patch","parameters":[{"name":"note_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Note Id"}},{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Idempotency-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoteUpdateRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoteResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"delete":{"tags":["Notes"],"summary":"Delete Note","operationId":"delete_note__note_id__delete","parameters":[{"name":"note_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Note Id"}},{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Idempotency-Key"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/notes/{note_id}/access":{"post":{"tags":["Note Access"],"summary":"Grant Note Access","operationId":"grant_note_access__note_id__access_post","parameters":[{"name":"note_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Note Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoteAccessGrantRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoteAccessResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"get":{"tags":["Note Access"],"summary":"List Note Access","operationId":"list_note_access__note_id__access_get","parameters":[{"name":"note_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Note Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NoteAccessResponse"},"title":"Response List Note Access  Note Id  Access Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/notes/{note_id}/access/{identity_id}":{"delete":{"tags":["Note Access"],"summary":"Revoke Note Access","operationId":"revoke_note_access__note_id__access__identity_id__delete","parameters":[{"name":"note_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Note Id"}},{"name":"identity_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Identity Id"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/phone/numbers":{"get":{"tags":["Phone Numbers"],"summary":"List Phone Numbers","operationId":"list_phone_numbers_numbers_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":200,"minimum":1},{"type":"null"}],"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","maximum":10000,"minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumberResponse"},"title":"Response List Phone Numbers Numbers Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"post":{"tags":["Phone Numbers"],"summary":"Provision Phone Number","operationId":"provision_phone_number_numbers_post","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProvisionPhoneNumberRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhoneNumberResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/phone/numbers/{phone_number_id}":{"get":{"tags":["Phone Numbers"],"summary":"Get Phone Number","operationId":"get_phone_number_numbers__phone_number_id__get","parameters":[{"name":"phone_number_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Phone Number Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhoneNumberResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"patch":{"tags":["Phone Numbers"],"summary":"Update Phone Number","operationId":"update_phone_number_numbers__phone_number_id__patch","parameters":[{"name":"phone_number_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Phone Number Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhoneNumberUpdateRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhoneNumberResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"delete":{"tags":["Phone Numbers"],"summary":"Release Phone Number","operationId":"release_phone_number_numbers__phone_number_id__delete","parameters":[{"name":"phone_number_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Phone Number Id"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/phone/numbers/{phone_number_id}/calls":{"get":{"tags":["Phone Calls"],"summary":"List Calls","operationId":"list_calls_numbers__phone_number_id__calls_get","deprecated":true,"parameters":[{"name":"phone_number_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Phone Number Id"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}},{"name":"is_blocked","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Filter by blocked state: true for only blocked, false for only non-blocked, omit for all. Agent-scoped callers never see blocked rows regardless of this filter (enforced at the access-policy layer).","title":"Is Blocked"},"description":"Filter by blocked state: true for only blocked, false for only non-blocked, omit for all. Agent-scoped callers never see blocked rows regardless of this filter (enforced at the access-policy layer)."},{"name":"start_datetime","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter created_at >= this date/datetime. Bare date => whole day in tz.","title":"Start Datetime"},"description":"Filter created_at >= this date/datetime. Bare date => whole day in tz."},{"name":"end_datetime","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter created_at <= this date/datetime. Bare date => whole day inclusive.","title":"End Datetime"},"description":"Filter created_at <= this date/datetime. Bare date => whole day inclusive."},{"name":"tz","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"IANA zone (e.g. America/New_York) for zone-less values; default UTC.","title":"Tz"},"description":"IANA zone (e.g. America/New_York) for zone-less values; default UTC."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PhoneCallResponse"},"title":"Response List Calls Numbers  Phone Number Id  Calls Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/phone/numbers/{phone_number_id}/calls/{call_id}":{"get":{"tags":["Phone Calls"],"summary":"Get Call","operationId":"get_call_numbers__phone_number_id__calls__call_id__get","deprecated":true,"parameters":[{"name":"phone_number_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Phone Number Id"}},{"name":"call_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Call Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhoneCallResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/phone/calls":{"get":{"tags":["Phone Calls"],"summary":"List Agent Calls","operationId":"list_agent_calls_calls_get","parameters":[{"name":"agent_identity_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"Agent identity to list calls for. Agent-scoped keys resolve their own; required for admin/JWT.","title":"Agent Identity Id"},"description":"Agent identity to list calls for. Agent-scoped keys resolve their own; required for admin/JWT."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}},{"name":"is_blocked","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Blocked"}},{"name":"start_datetime","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter created_at >= this date/datetime. Bare date => whole day in tz.","title":"Start Datetime"},"description":"Filter created_at >= this date/datetime. Bare date => whole day in tz."},{"name":"end_datetime","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter created_at <= this date/datetime. Bare date => whole day inclusive.","title":"End Datetime"},"description":"Filter created_at <= this date/datetime. Bare date => whole day inclusive."},{"name":"tz","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"IANA zone (e.g. America/New_York) for zone-less values; default UTC.","title":"Tz"},"description":"IANA zone (e.g. America/New_York) for zone-less values; default UTC."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PhoneCallResponse"},"title":"Response List Agent Calls Calls Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/phone/calls/{call_id}/tool-invocations":{"get":{"tags":["Phone Calls"],"summary":"List Hosted Agent Tool Invocation Projections","operationId":"list_hosted_agent_tool_invocation_projections_calls__call_id__tool_invocations_get","parameters":[{"name":"call_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Call Id"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","maximum":10000,"minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HostedAgentToolInvocationProjectionPage"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/phone/call-settings":{"get":{"tags":["Phone Calls"],"summary":"Get Call Settings Projection","operationId":"get_call_settings_projection_call_settings_get","parameters":[{"name":"agent_identity_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Agent Identity Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CallSettingsProjection"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/phone/calls/{call_id}":{"get":{"tags":["Phone Calls"],"summary":"Get Agent Call","operationId":"get_agent_call_calls__call_id__get","parameters":[{"name":"call_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Call Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhoneCallResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/phone/calls/{call_id}/transcripts":{"get":{"tags":["Phone Calls"],"summary":"List Agent Call Transcripts","operationId":"list_agent_call_transcripts_calls__call_id__transcripts_get","parameters":[{"name":"call_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Call Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PhoneTranscriptResponse"},"title":"Response List Agent Call Transcripts Calls  Call Id  Transcripts Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/phone/calls/{call_id}/hangup":{"post":{"tags":["Phone Calls"],"summary":"Hangup Call","operationId":"hangup_call_calls__call_id__hangup_post","parameters":[{"name":"call_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Call Id"}},{"name":"async_command","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Async Command"}},{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Idempotency-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/PhoneCallResponse"},{"$ref":"#/components/schemas/CallCommandResponse"}],"title":"Response Hangup Call Calls  Call Id  Hangup Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/phone/place-call":{"post":{"tags":["Phone Calls"],"summary":"Place Call","operationId":"place_call_place_call_post","parameters":[{"name":"async_command","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Async Command"}},{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Idempotency-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlaceCallRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/PhoneCallWithRateLimitResponse"},{"$ref":"#/components/schemas/CallCommandResponse"}],"title":"Response Place Call Place Call Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/phone/incoming-call-action":{"put":{"tags":["Phone Calls"],"summary":"Set Agent Incoming Call Action","operationId":"set_agent_incoming_call_action_incoming_call_action_put","parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Idempotency-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IncomingCallActionRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IncomingCallActionResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"get":{"tags":["Phone Calls"],"summary":"Get Agent Incoming Call Action","operationId":"get_agent_incoming_call_action_incoming_call_action_get","parameters":[{"name":"agent_identity_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Agent Identity Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IncomingCallActionResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/phone/hosted-agent-config":{"get":{"tags":["Hosted Call Agent"],"summary":"Get Hosted Agent Config","operationId":"get_hosted_agent_config_hosted_agent_config_get","parameters":[{"name":"agent_identity_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"Target identity. Agent-scoped keys resolve their own; required for admin/JWT.","title":"Agent Identity Id"},"description":"Target identity. Agent-scoped keys resolve their own; required for admin/JWT."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HostedAgentConfig"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"put":{"tags":["Hosted Call Agent"],"summary":"Put Hosted Agent Config","operationId":"put_hosted_agent_config_hosted_agent_config_put","parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Idempotency-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HostedAgentConfigInput"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HostedAgentConfig"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/phone/hosted-agent-config/authority-mode":{"put":{"tags":["Hosted Call Agent"],"summary":"Put Hosted Agent Authority Mode","operationId":"put_hosted_agent_authority_mode_hosted_agent_config_authority_mode_put","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HostedAgentAuthorityModeInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HostedAgentConfig"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/phone/numbers/{phone_number_id}/calls/{call_id}/transcripts":{"get":{"tags":["Phone Transcripts"],"summary":"List Transcripts","operationId":"list_transcripts_numbers__phone_number_id__calls__call_id__transcripts_get","deprecated":true,"parameters":[{"name":"phone_number_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Phone Number Id"}},{"name":"call_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Call Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PhoneTranscriptResponse"},"title":"Response List Transcripts Numbers  Phone Number Id  Calls  Call Id  Transcripts Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/phone/numbers/{phone_number_id}/search":{"get":{"tags":["Phone Transcripts"],"summary":"Search Transcripts","operationId":"search_transcripts_numbers__phone_number_id__search_get","parameters":[{"name":"phone_number_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Phone Number Id"}},{"name":"q","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":500,"title":"Q"}},{"name":"party","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by party: local or remote","title":"Party"},"description":"Filter by party: local or remote"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PhoneTranscriptResponse"},"title":"Response Search Transcripts Numbers  Phone Number Id  Search Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/phone/numbers/{phone_number_id}/texts":{"get":{"tags":["Text Messages"],"summary":"List Texts","operationId":"list_texts_numbers__phone_number_id__texts_get","parameters":[{"name":"phone_number_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Phone Number Id"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}},{"name":"is_read","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Filter by read state: true for read, false for unread, omit for all.","title":"Is Read"},"description":"Filter by read state: true for read, false for unread, omit for all."},{"name":"is_blocked","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Filter by blocked state: true for only blocked, false for only non-blocked, omit for all. Agent-scoped callers never see blocked rows regardless of this filter.","title":"Is Blocked"},"description":"Filter by blocked state: true for only blocked, false for only non-blocked, omit for all. Agent-scoped callers never see blocked rows regardless of this filter."},{"name":"start_datetime","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter created_at >= this date/datetime. Bare date => whole day in tz.","title":"Start Datetime"},"description":"Filter created_at >= this date/datetime. Bare date => whole day in tz."},{"name":"end_datetime","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter created_at <= this date/datetime. Bare date => whole day inclusive.","title":"End Datetime"},"description":"Filter created_at <= this date/datetime. Bare date => whole day inclusive."},{"name":"tz","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"IANA zone (e.g. America/New_York) for zone-less values; default UTC.","title":"Tz"},"description":"IANA zone (e.g. America/New_York) for zone-less values; default UTC."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TextMessageResponse"},"title":"Response List Texts Numbers  Phone Number Id  Texts Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"post":{"tags":["Text Messages"],"summary":"Send Text","operationId":"send_text_numbers__phone_number_id__texts_post","parameters":[{"name":"phone_number_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Phone Number Id"}},{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Idempotency-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendTextRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/TextMessageResponse"},{"$ref":"#/components/schemas/TextSendCommandResponse"}],"title":"Response Send Text Numbers  Phone Number Id  Texts Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/phone/numbers/{phone_number_id}/texts/search":{"get":{"tags":["Text Messages"],"summary":"Search Texts","operationId":"search_texts_numbers__phone_number_id__texts_search_get","parameters":[{"name":"phone_number_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Phone Number Id"}},{"name":"q","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":500,"title":"Q"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}},{"name":"is_blocked","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Blocked"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TextMessageResponse"},"title":"Response Search Texts Numbers  Phone Number Id  Texts Search Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/phone/numbers/{phone_number_id}/texts/conversations":{"get":{"tags":["Text Messages"],"summary":"List Conversations","operationId":"list_conversations_numbers__phone_number_id__texts_conversations_get","parameters":[{"name":"phone_number_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Phone Number Id"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}},{"name":"include_groups","in":"query","required":false,"schema":{"type":"boolean","description":"Default ``false`` hides group conversations from the listing — old clients see only 1:1 threads, byte-for-byte the same as before. Pass ``true`` to also include group threads.","default":false,"title":"Include Groups"},"description":"Default ``false`` hides group conversations from the listing — old clients see only 1:1 threads, byte-for-byte the same as before. Pass ``true`` to also include group threads."},{"name":"is_blocked","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Blocked"}},{"name":"start_datetime","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter created_at >= this date/datetime. Bare date => whole day in tz.","title":"Start Datetime"},"description":"Filter created_at >= this date/datetime. Bare date => whole day in tz."},{"name":"end_datetime","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter created_at <= this date/datetime. Bare date => whole day inclusive.","title":"End Datetime"},"description":"Filter created_at <= this date/datetime. Bare date => whole day inclusive."},{"name":"tz","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"IANA zone (e.g. America/New_York) for zone-less values; default UTC.","title":"Tz"},"description":"IANA zone (e.g. America/New_York) for zone-less values; default UTC."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TextConversationSummary"},"title":"Response List Conversations Numbers  Phone Number Id  Texts Conversations Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/phone/numbers/{phone_number_id}/texts/conversations/{key}":{"get":{"tags":["Text Messages"],"summary":"Get Conversation","operationId":"get_conversation_numbers__phone_number_id__texts_conversations__key__get","parameters":[{"name":"phone_number_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Phone Number Id"}},{"name":"key","in":"path","required":true,"schema":{"type":"string","description":"Conversation UUID (canonical for 1:1 + group threads) or a remote phone number / short code / sender ID (transitional fallback — 1:1 only).","title":"Key"},"description":"Conversation UUID (canonical for 1:1 + group threads) or a remote phone number / short code / sender ID (transitional fallback — 1:1 only)."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TextMessageResponse"},"title":"Response Get Conversation Numbers  Phone Number Id  Texts Conversations  Key  Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"patch":{"tags":["Text Messages"],"summary":"Update Conversation","operationId":"update_conversation_numbers__phone_number_id__texts_conversations__key__patch","parameters":[{"name":"phone_number_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Phone Number Id"}},{"name":"key","in":"path","required":true,"schema":{"type":"string","title":"Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TextConversationUpdateRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TextConversationUpdateResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/phone/numbers/{phone_number_id}/texts/{text_id}":{"get":{"tags":["Text Messages"],"summary":"Get Text","operationId":"get_text_numbers__phone_number_id__texts__text_id__get","parameters":[{"name":"phone_number_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Phone Number Id"}},{"name":"text_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Text Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TextMessageResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"patch":{"tags":["Text Messages"],"summary":"Update Text","operationId":"update_text_numbers__phone_number_id__texts__text_id__patch","parameters":[{"name":"phone_number_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Phone Number Id"}},{"name":"text_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Text Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TextMessageUpdateRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TextMessageResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/phone/text-conversations/{conversation_id}":{"patch":{"tags":["Text Messages"],"summary":"Update Text Conversation By Id","operationId":"update_text_conversation_by_id_text_conversations__conversation_id__patch","parameters":[{"name":"conversation_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Conversation Id"}},{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Idempotency-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TextConversationUpdateRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Update Text Conversation By Id Text Conversations  Conversation Id  Patch"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/phone/texts/{message_id}":{"delete":{"tags":["Text Messages"],"summary":"Delete Text By Id","operationId":"delete_text_by_id_texts__message_id__delete","parameters":[{"name":"message_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Message Id"}},{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Idempotency-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Delete Text By Id Texts  Message Id  Delete"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/phone/numbers/{phone_number_id}/contact-rules":{"post":{"tags":["Contact Rules"],"summary":"Create Contact Rule","operationId":"create_contact_rule_numbers__phone_number_id__contact_rules_post","deprecated":true,"parameters":[{"name":"phone_number_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Phone Number Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhoneContactRuleCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhoneContactRuleResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"get":{"tags":["Contact Rules"],"summary":"List Phone Contact Rules","operationId":"list_phone_contact_rules_numbers__phone_number_id__contact_rules_get","deprecated":true,"parameters":[{"name":"phone_number_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Phone Number Id"}},{"name":"action","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/PhoneRuleAction"},{"type":"null"}],"description":"Filter by allow or block.","title":"Action"},"description":"Filter by allow or block."},{"name":"match_type","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/PhoneRuleMatchType"},{"type":"null"}],"description":"Filter by match type (only 'exact_number' in v1).","title":"Match Type"},"description":"Filter by match type (only 'exact_number' in v1)."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Max rules to return.","default":50,"title":"Limit"},"description":"Max rules to return."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Number of rules to skip.","default":0,"title":"Offset"},"description":"Number of rules to skip."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PhoneContactRuleResponse"},"title":"Response List Phone Contact Rules Numbers  Phone Number Id  Contact Rules Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/phone/numbers/{phone_number_id}/contact-rules/{rule_id}":{"get":{"tags":["Contact Rules"],"summary":"Get Contact Rule","operationId":"get_contact_rule_numbers__phone_number_id__contact_rules__rule_id__get","deprecated":true,"parameters":[{"name":"phone_number_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Phone Number Id"}},{"name":"rule_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Rule Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhoneContactRuleResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"patch":{"tags":["Contact Rules"],"summary":"Update Contact Rule","operationId":"update_contact_rule_numbers__phone_number_id__contact_rules__rule_id__patch","deprecated":true,"parameters":[{"name":"phone_number_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Phone Number Id"}},{"name":"rule_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Rule Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhoneContactRuleUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhoneContactRuleResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"delete":{"tags":["Contact Rules"],"summary":"Delete Contact Rule","operationId":"delete_contact_rule_numbers__phone_number_id__contact_rules__rule_id__delete","deprecated":true,"parameters":[{"name":"phone_number_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Phone Number Id"}},{"name":"rule_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Rule Id"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/phone/contact-rules":{"get":{"tags":["Contact Rules"],"summary":"List Org Phone Contact Rules","operationId":"list_org_phone_contact_rules_contact_rules_get","parameters":[{"name":"agent_identity_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"Narrow to a single agent identity. Omit to list across every identity in the org.","title":"Agent Identity Id"},"description":"Narrow to a single agent identity. Omit to list across every identity in the org."},{"name":"action","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/PhoneRuleAction"},{"type":"null"}],"description":"Filter by allow or block.","title":"Action"},"description":"Filter by allow or block."},{"name":"match_type","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/PhoneRuleMatchType"},{"type":"null"}],"description":"Filter by match type (only 'exact_number' in v1).","title":"Match Type"},"description":"Filter by match type (only 'exact_number' in v1)."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Max rules to return.","default":50,"title":"Limit"},"description":"Max rules to return."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Number of rules to skip.","default":0,"title":"Offset"},"description":"Number of rules to skip."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PhoneIdentityContactRuleResponse"},"title":"Response List Org Phone Contact Rules Contact Rules Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/phone/sms-opt-ins":{"get":{"tags":["SMS Opt-Ins"],"summary":"List Sms Opt Ins","operationId":"list_sms_opt_ins_sms_opt_ins_get","parameters":[{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/SmsOptInStatus"},{"type":"null"}],"description":"Filter by consent state. Omit to return both.","title":"Status"},"description":"Filter by consent state. Omit to return both."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Max rows to return.","default":50,"title":"Limit"},"description":"Max rows to return."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Number of rows to skip.","default":0,"title":"Offset"},"description":"Number of rows to skip."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SmsOptInResponse"},"title":"Response List Sms Opt Ins Sms Opt Ins Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/phone/sms-opt-ins/{receiver_number}":{"get":{"tags":["SMS Opt-Ins"],"summary":"Get Sms Opt In","operationId":"get_sms_opt_in_sms_opt_ins__receiver_number__get","parameters":[{"name":"receiver_number","in":"path","required":true,"schema":{"type":"string","description":"Recipient phone number in E.164 format (e.g. +15551234567).","title":"Receiver Number"},"description":"Recipient phone number in E.164 format (e.g. +15551234567)."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmsOptInResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/phone/sms-opt-ins/{receiver_number}/opt-in":{"post":{"tags":["SMS Opt-Ins"],"summary":"Opt In Recipient","operationId":"opt_in_recipient_sms_opt_ins__receiver_number__opt_in_post","parameters":[{"name":"receiver_number","in":"path","required":true,"schema":{"type":"string","description":"Recipient phone number in E.164 format (e.g. +15551234567).","title":"Receiver Number"},"description":"Recipient phone number in E.164 format (e.g. +15551234567)."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmsOptInResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/phone/sms-opt-ins/{receiver_number}/opt-out":{"post":{"tags":["SMS Opt-Ins"],"summary":"Opt Out Recipient","operationId":"opt_out_recipient_sms_opt_ins__receiver_number__opt_out_post","parameters":[{"name":"receiver_number","in":"path","required":true,"schema":{"type":"string","description":"Recipient phone number in E.164 format (e.g. +15551234567).","title":"Receiver Number"},"description":"Recipient phone number in E.164 format (e.g. +15551234567)."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmsOptInResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/phone/mock-webhook/incoming-text":{"post":{"tags":["Phone Mock Webhooks"],"summary":"Mock Text Webhook","operationId":"mock_text_webhook_mock_webhook_incoming_text_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}}}},"/api/v1/phone/mock-webhook/incoming-call/answer":{"post":{"tags":["Phone Mock Webhooks"],"summary":"Mock Webhook Answer","operationId":"mock_webhook_answer_mock_webhook_incoming_call_answer_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}}}},"/api/v1/phone/mock-webhook/incoming-call/reject":{"post":{"tags":["Phone Mock Webhooks"],"summary":"Mock Webhook Reject","operationId":"mock_webhook_reject_mock_webhook_incoming_call_reject_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}}}},"/api/v1/privacy/account-delete":{"post":{"tags":["Privacy"],"summary":"Account Delete","operationId":"account_delete_account_delete_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountDeleteResponse"}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/tunnels/":{"get":{"tags":["Tunnels"],"summary":"List Tunnels","operationId":"list_tunnels__get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTunnelsResponse"}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/tunnels/{tunnel_id}":{"get":{"tags":["Tunnels"],"summary":"Get Tunnel","operationId":"get_tunnel__tunnel_id__get","parameters":[{"name":"tunnel_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Tunnel Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TunnelResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"patch":{"tags":["Tunnels"],"summary":"Update Tunnel","operationId":"update_tunnel__tunnel_id__patch","parameters":[{"name":"tunnel_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Tunnel Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTunnelRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TunnelResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/tunnels/{tunnel_id}/sign-csr":{"post":{"tags":["Tunnels"],"summary":"Sign Csr Endpoint","operationId":"sign_csr_endpoint__tunnel_id__sign_csr_post","parameters":[{"name":"tunnel_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Tunnel Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignCsrRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignCsrResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/vault/initialize":{"post":{"tags":["Vault"],"summary":"Initialize Vault","operationId":"initialize_vault_initialize_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VaultInitializeRequest"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VaultInitializeResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/vault/info":{"get":{"tags":["Vault"],"summary":"Get Vault","operationId":"get_vault_info_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VaultResponse"}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/vault/":{"delete":{"tags":["Vault"],"summary":"Delete Vault","operationId":"delete_vault__delete","responses":{"204":{"description":"Successful Response"},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/vault/keys":{"get":{"tags":["Vault Keys"],"summary":"List Vault Keys","operationId":"list_vault_keys_keys_get","parameters":[{"name":"type","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/VaultKeyType"},{"type":"null"}],"title":"Type"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VaultKeyResponse"},"title":"Response List Vault Keys Keys Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/vault/keys/primary":{"put":{"tags":["Vault Keys"],"summary":"Update Primary Vault Key","operationId":"update_primary_vault_key_keys_primary_put","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VaultKeyUpdateRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VaultKeyResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/vault/keys/{auth_hash}":{"delete":{"tags":["Vault Keys"],"summary":"Delete Vault Key","operationId":"delete_vault_key_keys__auth_hash__delete","parameters":[{"name":"auth_hash","in":"path","required":true,"schema":{"type":"string","title":"Auth Hash"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/vault/secrets":{"post":{"tags":["Vault Secrets"],"summary":"Create Vault Secret","operationId":"create_vault_secret_secrets_post","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VaultSecretCreateRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VaultSecretResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"get":{"tags":["Vault Secrets"],"summary":"List Vault Secrets","operationId":"list_vault_secrets_secrets_get","parameters":[{"name":"secret_type","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/VaultSecretType"},{"type":"null"}],"title":"Secret Type"}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":200,"minimum":1},{"type":"null"}],"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","maximum":10000,"minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VaultSecretResponse"},"title":"Response List Vault Secrets Secrets Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/vault/secrets/{secret_id}":{"get":{"tags":["Vault Secrets"],"summary":"Get Vault Secret","operationId":"get_vault_secret_secrets__secret_id__get","parameters":[{"name":"secret_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Secret Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VaultSecretDetailResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"patch":{"tags":["Vault Secrets"],"summary":"Update Vault Secret","operationId":"update_vault_secret_secrets__secret_id__patch","parameters":[{"name":"secret_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Secret Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VaultSecretUpdateRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VaultSecretResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"delete":{"tags":["Vault Secrets"],"summary":"Delete Vault Secret","operationId":"delete_vault_secret_secrets__secret_id__delete","parameters":[{"name":"secret_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Secret Id"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"BearerAuth":[]}]}},"/api/v1/vault/unlock":{"get":{"tags":["Vault"],"summary":"Fetch encrypted vault bundle for client-side decryption","operationId":"unlock_vault_unlock_get","parameters":[{"name":"auth_hash","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Auth Hash"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VaultUnlockResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/vault/secrets/{secret_id}/access":{"post":{"tags":["Vault Secret Access"],"summary":"Grant Access","operationId":"grant_access_secrets__secret_id__access_post","parameters":[{"name":"secret_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Secret Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VaultSecretAccessGrantRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VaultSecretAccessResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]},"get":{"tags":["Vault Secret Access"],"summary":"List Access","operationId":"list_access_secrets__secret_id__access_get","parameters":[{"name":"secret_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Secret Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VaultSecretAccessResponse"},"title":"Response List Access Secrets  Secret Id  Access Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/api/v1/vault/secrets/{secret_id}/access/{identity_id}":{"delete":{"tags":["Vault Secret Access"],"summary":"Revoke Access","operationId":"revoke_access_secrets__secret_id__access__identity_id__delete","parameters":[{"name":"secret_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Secret Id"}},{"name":"identity_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Identity Id"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HTTPValidationError"},{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}]}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}},"/health":{"get":{"summary":"Health","description":"Return a simple health-check response for ALB target groups.","operationId":"health_health_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":{"type":"boolean"},"type":"object","title":"Response Health Health Get"}}}}}}},"/api/whoami":{"get":{"summary":"Whoami","description":"Return the authenticated caller's identity and auth type.","operationId":"whoami_api_whoami_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Whoami Api Whoami Get"}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}]}},"/api/openapi.yaml":{"get":{"summary":"Openapi Yaml","description":"Serve the OpenAPI specification as YAML (YAML and YML are the same; YAML is the official extension).","operationId":"openapi_yaml_api_openapi_yaml_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"4XX":{"description":"Client error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}},"5XX":{"description":"Server error with Support Agent information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSupportErrorEnvelope"}}}}}}}},"webhooks":{"/mail-event":{"post":{"tags":["Webhooks"],"summary":"Mail Event","description":"Fired when a mail event occurs on a mailbox with an active mail-event subscription. Events include `message.received`, `message.sent`, `message.forwarded`, `message.delivered`, `message.bounced`, and `message.failed`. This is fire-and-forget: the response status is logged but does not affect mail processing.\n\nIf your organization has a signing key, every webhook includes three headers:\n- `X-Inkbox-Request-ID` — UUID for deduplication.\n- `X-Inkbox-Timestamp` — Unix timestamp in seconds.\n- `X-Inkbox-Signature` — `sha256={HMAC-SHA256 hex digest}` over `{request_id}.{timestamp}.{raw_body}`.","operationId":"mail_event_webhook_mail_event_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailWebhookPayload"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-webhook-headers":{"X-Inkbox-Request-ID":{"description":"UUID for deduplication.","required_when_signed":true},"X-Inkbox-Timestamp":{"description":"Unix timestamp in seconds.","required_when_signed":true},"X-Inkbox-Signature":{"description":"sha256={HMAC-SHA256 hex digest} over {request_id}.{timestamp}.{raw_body}.","required_when_signed":true}}}},"/phone-call":{"post":{"tags":["Webhooks"],"summary":"Phone Incoming Call","description":"Fired when an incoming call arrives on a phone number whose `incoming_call_action` is `webhook`. The request body is a flat call payload, not an `{event_type, timestamp, data}` envelope. Your endpoint must return a JSON body with `action` (`answer` or `reject`) within 10 seconds. Non-200 responses, invalid bodies, or timeouts are treated as `ignore`.\n\nIf your organization has a signing key, every webhook includes three headers:\n- `X-Inkbox-Request-ID` — UUID for deduplication.\n- `X-Inkbox-Timestamp` — Unix timestamp in seconds.\n- `X-Inkbox-Signature` — `sha256={HMAC-SHA256 hex digest}` over `{request_id}.{timestamp}.{raw_body}`.","operationId":"phone_call_webhook_phone_call_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhoneCallWebhookPayload"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IncomingCallWebhookResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-webhook-headers":{"X-Inkbox-Request-ID":{"description":"UUID for deduplication.","required_when_signed":true},"X-Inkbox-Timestamp":{"description":"Unix timestamp in seconds.","required_when_signed":true},"X-Inkbox-Signature":{"description":"sha256={HMAC-SHA256 hex digest} over {request_id}.{timestamp}.{raw_body}.","required_when_signed":true}}}},"/phone-text":{"post":{"tags":["Webhooks"],"summary":"Phone Text Event","description":"Fired for text-message lifecycle events on a phone number with an active text-event subscription. Covers inbound delivery (`text.received`) and outbound delivery state transitions (`text.sent`, `text.delivered`, `text.delivery_failed`, `text.delivery_unconfirmed`). The request body uses the standard `{event_type, timestamp, data}` envelope with `data.text_message`, `data.contacts`, and `data.agent_identities` (both lists, possibly empty). This is fire-and-forget: the response status is logged but does not affect text processing.\n\nIf your organization has a signing key, every webhook includes three headers:\n- `X-Inkbox-Request-ID` — UUID for deduplication.\n- `X-Inkbox-Timestamp` — Unix timestamp in seconds.\n- `X-Inkbox-Signature` — `sha256={HMAC-SHA256 hex digest}` over `{request_id}.{timestamp}.{raw_body}`.","operationId":"phone_text_webhook_phone_text_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhoneTextWebhookPayload"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-webhook-headers":{"X-Inkbox-Request-ID":{"description":"UUID for deduplication.","required_when_signed":true},"X-Inkbox-Timestamp":{"description":"Unix timestamp in seconds.","required_when_signed":true},"X-Inkbox-Signature":{"description":"sha256={HMAC-SHA256 hex digest} over {request_id}.{timestamp}.{raw_body}.","required_when_signed":true}}}},"/imessage":{"post":{"tags":["Webhooks"],"summary":"iMessage Event","description":"Fired for iMessage events on an agent identity with an active iMessage subscription. Covers inbound delivery (`imessage.received`) and inbound tapbacks (`imessage.reaction_received`) routed through the shared-number assignment table. The request body uses the standard `{event_type, timestamp, data}` envelope with `data.message` or `data.reaction`. Pool numbers are intentionally omitted from the payload; agents address iMessage by identity/conversation, not by the shared pool line. This is fire-and-forget: the response status is logged but does not affect iMessage processing.\n\nIf your organization has a signing key, every webhook includes three headers:\n- `X-Inkbox-Request-ID` — UUID for deduplication.\n- `X-Inkbox-Timestamp` — Unix timestamp in seconds.\n- `X-Inkbox-Signature` — `sha256={HMAC-SHA256 hex digest}` over `{request_id}.{timestamp}.{raw_body}`.","operationId":"imessage_webhook_imessage_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IMessageWebhookPayload"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-webhook-headers":{"X-Inkbox-Request-ID":{"description":"UUID for deduplication.","required_when_signed":true},"X-Inkbox-Timestamp":{"description":"Unix timestamp in seconds.","required_when_signed":true},"X-Inkbox-Signature":{"description":"sha256={HMAC-SHA256 hex digest} over {request_id}.{timestamp}.{raw_body}.","required_when_signed":true}}}},"/phone-call-lifecycle":{"post":{"tags":["Webhooks"],"summary":"Call Lifecycle Event","description":"Fired for post-call lifecycle events on an agent identity with an active call-lifecycle subscription. Covers `call.ended`, delivered once after a connected call terminates. The request body uses the standard `{event_type, timestamp, data}` envelope with `data.call`, `data.contacts`, `data.agent_identities`, and `data.transcript_url`. `data.transcript` (an abridged, middle-cut copy) is present only when the call has a persisted transcript; `data.transcript_url` is always present and authoritative. Unlike the synchronous `phone.incoming_call` callback, this is fire-and-forget and replayable: the response status is logged but does not affect call processing.\n\nIf your organization has a signing key, every webhook includes three headers:\n- `X-Inkbox-Request-ID` — UUID for deduplication.\n- `X-Inkbox-Timestamp` — Unix timestamp in seconds.\n- `X-Inkbox-Signature` — `sha256={HMAC-SHA256 hex digest}` over `{request_id}.{timestamp}.{raw_body}`.","operationId":"phone_call_lifecycle_webhook_phone_call_lifecycle_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhoneCallEndedWebhookPayload"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-webhook-headers":{"X-Inkbox-Request-ID":{"description":"UUID for deduplication.","required_when_signed":true},"X-Inkbox-Timestamp":{"description":"Unix timestamp in seconds.","required_when_signed":true},"X-Inkbox-Signature":{"description":"sha256={HMAC-SHA256 hex digest} over {request_id}.{timestamp}.{raw_body}.","required_when_signed":true}}}},"/a2a":{"post":{"tags":["Webhooks"],"summary":"A2A Task Event","description":"Fired for A2A task-ledger events on an agent identity with an active A2A subscription. Target identities receive `a2a.task.created`, `a2a.task.message`, and `a2a.task.canceled`; caller identities receive `a2a.sent_task.updated`. Automatic delivery retries are bounded and may deliver an event more than once, so consumers should deduplicate with the stable event `id`.\n\nIf your organization has a signing key, every webhook includes three headers:\n- `X-Inkbox-Request-ID` — UUID for deduplication.\n- `X-Inkbox-Timestamp` — Unix timestamp in seconds.\n- `X-Inkbox-Signature` — `sha256={HMAC-SHA256 hex digest}` over `{request_id}.{timestamp}.{raw_body}`.","operationId":"a2a_webhook_a2a_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/A2AWebhookPayload"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-webhook-headers":{"X-Inkbox-Request-ID":{"description":"UUID for deduplication.","required_when_signed":true},"X-Inkbox-Timestamp":{"description":"Unix timestamp in seconds.","required_when_signed":true},"X-Inkbox-Signature":{"description":"sha256={HMAC-SHA256 hex digest} over {request_id}.{timestamp}.{raw_body}.","required_when_signed":true}}}}},"components":{"schemas":{"A2ATaskState":{"type":"string","enum":["submitted","working","input_required","completed","failed","canceled"],"title":"A2ATaskState"},"A2AWebhookCaller":{"properties":{"identity_id":{"type":"string","format":"uuid","title":"Identity Id"},"organization_id":{"type":"string","title":"Organization Id"},"handle":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Handle"}},"type":"object","required":["identity_id","organization_id"],"title":"A2AWebhookCaller"},"A2AWebhookData":{"properties":{"task_id":{"type":"string","format":"uuid","title":"Task Id"},"context_id":{"type":"string","format":"uuid","title":"Context Id"},"state":{"$ref":"#/components/schemas/A2ATaskState"},"caller":{"$ref":"#/components/schemas/A2AWebhookCaller"},"message_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message Id"},"parts":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Parts"}},"type":"object","required":["task_id","context_id","state","caller"],"title":"A2AWebhookData"},"A2AWebhookEventType":{"type":"string","enum":["a2a.task.created","a2a.task.message","a2a.task.canceled","a2a.sent_task.updated"],"title":"A2AWebhookEventType"},"A2AWebhookPayload":{"properties":{"id":{"type":"string","title":"Id","description":"Stable per-event id (evt_...); idempotency key across retries."},"event_type":{"$ref":"#/components/schemas/A2AWebhookEventType"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"data":{"$ref":"#/components/schemas/A2AWebhookData"}},"type":"object","required":["id","event_type","timestamp","data"],"title":"A2AWebhookPayload"},"ApiKey":{"properties":{"id":{"type":"string","title":"Id"},"organization_id":{"type":"string","title":"Organization Id"},"created_by":{"type":"string","title":"Created By"},"creator_type":{"$ref":"#/components/schemas/ObjectCreatorType"},"scoped_identity_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Scoped Identity Id"},"label":{"type":"string","title":"Label"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"status":{"$ref":"#/components/schemas/ApiKeyStatus"},"last4":{"type":"string","title":"Last4"},"display_prefix":{"type":"string","title":"Display Prefix"},"last_used_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Used At"},"expires_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expires At"},"revoked_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Revoked At"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","organization_id","created_by","creator_type","scoped_identity_id","label","description","status","last4","display_prefix","last_used_at","expires_at","revoked_at","created_at","updated_at"],"title":"ApiKey"},"ApiKeyStatus":{"type":"string","enum":["active","revoked"],"title":"ApiKeyStatus"},"CallDirection":{"type":"string","enum":["outbound","inbound"],"title":"CallDirection"},"CallForwardingStatus":{"type":"string","enum":["requested","dialing","forwarded","failed"],"title":"CallForwardingStatus"},"CallForwardingTrigger":{"type":"string","enum":["incoming_action"],"title":"CallForwardingTrigger"},"CallMode":{"type":"string","enum":["client_websocket","hosted_agent"],"title":"CallMode"},"CallOrigin":{"type":"string","enum":["dedicated_number","shared_imessage_number","dedicated_imessage_number"],"title":"CallOrigin"},"CallOutcome":{"type":"string","enum":["completed","no_answer","declined","failed"],"title":"CallOutcome"},"CallResourceResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"parent":{"anyOf":[{"$ref":"#/components/schemas/ResourceParent"},{"type":"null"}]},"resource":{"additionalProperties":true,"type":"object","title":"Resource"},"type":{"type":"string","const":"calls","title":"Type"}},"type":"object","required":["id","resource","type"],"title":"CallResourceResponse"},"CallStatus":{"type":"string","enum":["initiated","ringing","answered","completed","failed","canceled"],"title":"CallStatus"},"CallTranscriptResourceResponse":{"properties":{"type":{"type":"string","const":"call-transcripts","title":"Type"},"id":{"type":"string","format":"uuid","title":"Id"},"parent":{"$ref":"#/components/schemas/ResourceParent"},"call":{"additionalProperties":true,"type":"object","title":"Call"},"transcript":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Transcript","description":"Ordered transcript segments, capped at 200 entries."},"transcript_truncated":{"type":"boolean","title":"Transcript Truncated","description":"True when additional transcript segments exist beyond this response."}},"type":"object","required":["type","id","parent","call","transcript","transcript_truncated"],"title":"CallTranscriptResourceResponse"},"ContactResourceResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"parent":{"anyOf":[{"$ref":"#/components/schemas/ResourceParent"},{"type":"null"}]},"resource":{"additionalProperties":true,"type":"object","title":"Resource"},"type":{"type":"string","const":"contacts","title":"Type"}},"type":"object","required":["id","resource","type"],"title":"ContactResourceResponse"},"CreateApiKeyRequest":{"properties":{"label":{"type":"string","maxLength":255,"minLength":1,"title":"Label"},"description":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}],"title":"Description"},"scoped_identity_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Scoped Identity Id","description":"Scope this key to a specific agent identity. Omit or null for an admin (unscoped) key with full org-wide authority."}},"type":"object","required":["label"],"title":"CreateApiKeyRequest"},"CreateApiKeyResponse":{"properties":{"api_key":{"type":"string","title":"Api Key","description":"Full API key string. Shown once, cannot be retrieved later."},"record":{"$ref":"#/components/schemas/ApiKey"}},"type":"object","required":["api_key","record"],"title":"CreateApiKeyResponse"},"EmailResourceResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"parent":{"anyOf":[{"$ref":"#/components/schemas/ResourceParent"},{"type":"null"}]},"resource":{"additionalProperties":true,"type":"object","title":"Resource"},"type":{"type":"string","const":"emails","title":"Type"}},"type":"object","required":["id","resource","type"],"title":"EmailResourceResponse"},"ForwardingTargetType":{"type":"string","enum":["phone","sip"],"title":"ForwardingTargetType"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"HangupReason":{"type":"string","enum":["local","remote","max_duration","voicemail","rejected","failed"],"title":"HangupReason"},"HostedAgentAuthorityMode":{"type":"string","enum":["contact_scoped","yolo"],"title":"HostedAgentAuthorityMode"},"IMessageConversationResourceResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"parent":{"anyOf":[{"$ref":"#/components/schemas/ResourceParent"},{"type":"null"}]},"resource":{"additionalProperties":true,"type":"object","title":"Resource"},"type":{"type":"string","const":"imessage-conversations","title":"Type"}},"type":"object","required":["id","resource","type"],"title":"IMessageConversationResourceResponse"},"IMessageDirection":{"type":"string","enum":["inbound","outbound"],"title":"IMessageDirection"},"IMessageMediaItem":{"properties":{"content_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Content Type"},"size":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Size"},"url":{"type":"string","title":"Url"}},"type":"object","required":["url"],"title":"IMessageMediaItem"},"IMessageMessageReaction":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"direction":{"$ref":"#/components/schemas/IMessageDirection"},"reaction":{"$ref":"#/components/schemas/IMessageReactionType"},"custom_emoji":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Custom Emoji"},"remote_number":{"type":"string","title":"Remote Number"},"part_index":{"type":"integer","minimum":0.0,"title":"Part Index","default":0},"created_at":{"type":"string","format":"date-time","title":"Created At"}},"type":"object","required":["id","direction","reaction","remote_number","created_at"],"title":"IMessageMessageReaction"},"IMessageReactionResponse":{"properties":{"provider_message_handle":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Provider Message Handle"},"id":{"type":"string","format":"uuid","title":"Id"},"conversation_id":{"type":"string","format":"uuid","title":"Conversation Id"},"assignment_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Assignment Id"},"target_message_id":{"type":"string","format":"uuid","title":"Target Message Id"},"direction":{"$ref":"#/components/schemas/IMessageDirection"},"reaction":{"$ref":"#/components/schemas/IMessageReactionType"},"custom_emoji":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Custom Emoji"},"remote_number":{"type":"string","title":"Remote Number"},"part_index":{"type":"integer","minimum":0.0,"title":"Part Index","default":0},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","conversation_id","assignment_id","target_message_id","direction","reaction","remote_number","created_at","updated_at"],"title":"IMessageReactionResponse"},"IMessageReactionType":{"type":"string","enum":["love","like","dislike","laugh","emphasize","question","eyes","custom"],"title":"IMessageReactionType"},"IMessageRecipientResponse":{"properties":{"remote_number":{"type":"string","title":"Remote Number"},"delivery_status":{"anyOf":[{"$ref":"#/components/schemas/IMessageStatus"},{"type":"null"}]},"service":{"anyOf":[{"$ref":"#/components/schemas/IMessageService"},{"type":"null"}]},"error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error Code"},"error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error Message"},"error_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error Reason"},"error_detail":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error Detail"},"sent_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Sent At"},"delivered_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Delivered At"},"failed_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Failed At"}},"type":"object","required":["remote_number"],"title":"IMessageRecipientResponse"},"IMessageSendStyle":{"type":"string","enum":["celebration","shooting_star","fireworks","lasers","love","confetti","balloons","spotlight","echo","invisible","gentle","loud","slam"],"title":"IMessageSendStyle"},"IMessageService":{"type":"string","enum":["imessage","sms","rcs"],"title":"IMessageService"},"IMessageStatus":{"type":"string","enum":["registered","pending","queued","accepted","sent","delivered","declined","error","received"],"title":"IMessageStatus"},"IMessageType":{"type":"string","enum":["message","carousel"],"title":"IMessageType"},"IMessageWebhookData":{"properties":{"message":{"anyOf":[{"$ref":"#/components/schemas/WebhookIMessageMessage"},{"type":"null"}]},"reaction":{"anyOf":[{"$ref":"#/components/schemas/IMessageReactionResponse"},{"type":"null"}]},"contacts":{"items":{"$ref":"#/components/schemas/WebhookContact"},"type":"array","title":"Contacts"},"agent_identities":{"items":{"$ref":"#/components/schemas/WebhookAgentIdentity"},"type":"array","title":"Agent Identities"}},"type":"object","title":"IMessageWebhookData"},"IMessageWebhookEventType":{"type":"string","enum":["imessage.received","imessage.reaction_received","imessage.sent","imessage.delivered","imessage.delivery_failed"],"title":"IMessageWebhookEventType"},"IMessageWebhookPayload":{"properties":{"id":{"type":"string","title":"Id","description":"Stable per-event id (evt_...); idempotency key, stable across replays."},"event_type":{"$ref":"#/components/schemas/IMessageWebhookEventType","description":"The type of iMessage event that triggered this webhook."},"timestamp":{"type":"string","format":"date-time","title":"Timestamp","description":"ISO 8601 timestamp of when the event occurred."},"data":{"$ref":"#/components/schemas/IMessageWebhookData"}},"type":"object","required":["id","event_type","timestamp","data"],"title":"IMessageWebhookPayload"},"IncomingCallWebhookResponse":{"properties":{"action":{"type":"string","enum":["answer","reject"],"title":"Action","description":"Whether to answer or reject the call"},"client_websocket_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Websocket Url","description":"WebSocket URL (wss://) for audio bridging. Falls back to the phone number's client_websocket_url."}},"type":"object","required":["action"],"title":"IncomingCallWebhookResponse"},"ListApiKeysResponse":{"properties":{"api_keys":{"items":{"$ref":"#/components/schemas/ApiKey"},"type":"array","title":"Api Keys"}},"type":"object","required":["api_keys"],"title":"ListApiKeysResponse"},"ListWebhookCatalogResponse":{"properties":{"events":{"items":{"$ref":"#/components/schemas/WebhookCatalogRow"},"type":"array","title":"Events"},"example_signature_headers":{"type":"string","title":"Example Signature Headers"}},"type":"object","required":["events","example_signature_headers"],"title":"ListWebhookCatalogResponse"},"MailBodyState":{"type":"string","enum":["complete","truncated","unavailable"],"title":"MailBodyState"},"MailWebhookData":{"properties":{"message":{"$ref":"#/components/schemas/MailWebhookMessageData"},"contacts":{"items":{"$ref":"#/components/schemas/WebhookMailContact"},"type":"array","title":"Contacts"},"agent_identities":{"items":{"$ref":"#/components/schemas/WebhookMailAgentIdentity"},"type":"array","title":"Agent Identities"}},"type":"object","required":["message"],"title":"MailWebhookData"},"MailWebhookEventType":{"type":"string","enum":["message.received","message.sent","message.forwarded","message.delivered","message.bounced","message.failed"],"title":"MailWebhookEventType"},"MailWebhookMessageData":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"mailbox_id":{"type":"string","format":"uuid","title":"Mailbox Id"},"thread_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Thread Id"},"message_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message Id"},"from_address":{"type":"string","title":"From Address"},"to_addresses":{"items":{"type":"string"},"type":"array","title":"To Addresses"},"cc_addresses":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Cc Addresses"},"bcc_addresses":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Bcc Addresses"},"subject":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subject"},"snippet":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Snippet"},"email_address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email Address"},"body":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Body"},"body_state":{"anyOf":[{"$ref":"#/components/schemas/MailBodyState"},{"type":"null"}]},"body_truncated":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Body Truncated"},"body_total_chars":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Body Total Chars"},"body_included_chars":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Body Included Chars"},"direction":{"$ref":"#/components/schemas/MessageDirection"},"status":{"$ref":"#/components/schemas/MessageStatus"},"has_attachments":{"type":"boolean","title":"Has Attachments"},"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"}},"type":"object","required":["id","mailbox_id","thread_id","message_id","from_address","to_addresses","cc_addresses","subject","snippet","direction","status","has_attachments","created_at"],"title":"MailWebhookMessageData"},"MailWebhookPayload":{"properties":{"id":{"type":"string","title":"Id","description":"Stable per-event id (evt_...); idempotency key, stable across replays."},"event_type":{"$ref":"#/components/schemas/MailWebhookEventType","description":"The type of mail event that triggered this webhook."},"timestamp":{"type":"string","format":"date-time","title":"Timestamp","description":"ISO 8601 timestamp of when the event occurred."},"data":{"$ref":"#/components/schemas/MailWebhookData"}},"type":"object","required":["id","event_type","timestamp","data"],"title":"MailWebhookPayload"},"MessageDirection":{"type":"string","enum":["inbound","outbound"],"title":"MessageDirection"},"MessageStatus":{"type":"string","enum":["queued","sent","delivered","bounced","failed","received","deleted"],"title":"MessageStatus"},"NoteResourceResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"parent":{"anyOf":[{"$ref":"#/components/schemas/ResourceParent"},{"type":"null"}]},"resource":{"additionalProperties":true,"type":"object","title":"Resource"},"type":{"type":"string","const":"notes","title":"Type"}},"type":"object","required":["id","resource","type"],"title":"NoteResourceResponse"},"ObjectCreatorType":{"type":"string","enum":["human","agent"],"title":"ObjectCreatorType"},"PhoneCallEndedWebhookData":{"properties":{"call":{"$ref":"#/components/schemas/WebhookPhoneCall"},"contacts":{"items":{"$ref":"#/components/schemas/WebhookContact"},"type":"array","title":"Contacts"},"agent_identities":{"items":{"$ref":"#/components/schemas/WebhookAgentIdentity"},"type":"array","title":"Agent Identities"},"transcript":{"anyOf":[{"$ref":"#/components/schemas/WebhookCallTranscript"},{"type":"null"}]},"transcript_url":{"type":"string","title":"Transcript Url"},"outcome":{"anyOf":[{"$ref":"#/components/schemas/CallOutcome"},{"type":"null"}]},"post_call_action_items":{"items":{"$ref":"#/components/schemas/WebhookPostCallAction"},"type":"array","title":"Post Call Action Items"}},"type":"object","required":["call","transcript_url"],"title":"PhoneCallEndedWebhookData"},"PhoneCallEndedWebhookPayload":{"properties":{"id":{"type":"string","title":"Id","description":"Stable per-event id (evt_...); idempotency key, stable across replays."},"event_type":{"$ref":"#/components/schemas/PhoneCallLifecycleWebhookEventType","description":"The type of call-lifecycle event that triggered this webhook."},"timestamp":{"type":"string","format":"date-time","title":"Timestamp","description":"ISO 8601 timestamp of when the event occurred."},"data":{"$ref":"#/components/schemas/PhoneCallEndedWebhookData"}},"type":"object","required":["id","event_type","timestamp","data"],"title":"PhoneCallEndedWebhookPayload"},"PhoneCallForwardingResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"trigger":{"$ref":"#/components/schemas/CallForwardingTrigger"},"status":{"$ref":"#/components/schemas/CallForwardingStatus"},"target_type":{"$ref":"#/components/schemas/ForwardingTargetType"},"target":{"type":"string","title":"Target"},"requested_at":{"type":"string","format":"date-time","title":"Requested At"},"dialing_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Dialing At"},"forwarded_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Forwarded At"},"ended_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Ended At"},"failure_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Failure Code"}},"type":"object","required":["id","trigger","status","target_type","target","requested_at"],"title":"PhoneCallForwardingResponse"},"PhoneCallLifecycleWebhookEventType":{"type":"string","enum":["call.ended"],"title":"PhoneCallLifecycleWebhookEventType"},"PhoneCallWebhookPayload":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"origin":{"$ref":"#/components/schemas/CallOrigin","default":"dedicated_number"},"local_phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Local Phone Number"},"remote_phone_number":{"type":"string","title":"Remote Phone Number"},"direction":{"type":"string","const":"inbound","title":"Direction"},"status":{"$ref":"#/components/schemas/CallStatus"},"client_websocket_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Websocket Url"},"use_inkbox_tts":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Use Inkbox Tts"},"use_inkbox_stt":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Use Inkbox Stt"},"hangup_reason":{"anyOf":[{"$ref":"#/components/schemas/HangupReason"},{"type":"null"}]},"started_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Started At"},"ended_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Ended At"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"rate_limit":{"anyOf":[{"$ref":"#/components/schemas/RateLimitInfo"},{"type":"null"}]},"contacts":{"items":{"$ref":"#/components/schemas/WebhookContact"},"type":"array","title":"Contacts"},"agent_identities":{"items":{"$ref":"#/components/schemas/WebhookAgentIdentity"},"type":"array","title":"Agent Identities"}},"type":"object","required":["id","remote_phone_number","direction","status","client_websocket_url","use_inkbox_tts","use_inkbox_stt","started_at","ended_at","created_at","updated_at"],"title":"PhoneCallWebhookPayload"},"PhoneTextWebhookData":{"properties":{"text_message":{"$ref":"#/components/schemas/WebhookTextMessage"},"contacts":{"items":{"$ref":"#/components/schemas/WebhookContact"},"type":"array","title":"Contacts"},"agent_identities":{"items":{"$ref":"#/components/schemas/WebhookAgentIdentity"},"type":"array","title":"Agent Identities"},"recipient_phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Recipient Phone Number"}},"type":"object","required":["text_message"],"title":"PhoneTextWebhookData"},"PhoneTextWebhookEventType":{"type":"string","enum":["text.received","text.sent","text.delivered","text.delivery_failed","text.delivery_unconfirmed"],"title":"PhoneTextWebhookEventType"},"PhoneTextWebhookPayload":{"properties":{"id":{"type":"string","title":"Id","description":"Stable per-event id (evt_...); idempotency key, stable across replays."},"event_type":{"$ref":"#/components/schemas/PhoneTextWebhookEventType","description":"The type of text event that triggered this webhook."},"timestamp":{"type":"string","format":"date-time","title":"Timestamp","description":"ISO 8601 timestamp of when the event occurred."},"data":{"$ref":"#/components/schemas/PhoneTextWebhookData"}},"type":"object","required":["id","event_type","timestamp","data"],"title":"PhoneTextWebhookPayload"},"PostCallActionStatus":{"type":"string","enum":["open","canceled"],"title":"PostCallActionStatus"},"RateLimitInfo":{"properties":{"calls_used":{"type":"integer","title":"Calls Used"},"calls_remaining":{"type":"integer","title":"Calls Remaining"},"calls_limit":{"type":"integer","title":"Calls Limit"},"minutes_used":{"type":"number","title":"Minutes Used"},"minutes_remaining":{"type":"number","title":"Minutes Remaining"},"minutes_limit":{"type":"integer","title":"Minutes Limit"}},"type":"object","required":["calls_used","calls_remaining","calls_limit","minutes_used","minutes_remaining","minutes_limit"],"title":"RateLimitInfo"},"ResourceParent":{"properties":{"type":{"type":"string","enum":["mailboxes","phone-numbers","calls"],"title":"Type"},"id":{"type":"string","format":"uuid","title":"Id"}},"type":"object","required":["type","id"],"title":"ResourceParent"},"SigningKeyCreateResponse":{"properties":{"signing_key":{"type":"string","title":"Signing Key","description":"Plaintext signing key (shown once — store it securely)"},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"When the key was created (or rotated)"}},"type":"object","required":["signing_key","created_at"],"title":"SigningKeyCreateResponse"},"SigningKeyStatusResponse":{"properties":{"configured":{"type":"boolean","title":"Configured","description":"Whether the caller's organization has a signing key configured"},"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At","description":"When the key was created (or last rotated), if configured"}},"type":"object","required":["configured","created_at"],"title":"SigningKeyStatusResponse"},"SmsDeliveryStatus":{"type":"string","enum":["queued","sent","delivered","delivery_failed","delivery_unconfirmed","sending_failed","blocked_spam_filter"],"title":"SmsDeliveryStatus"},"TextConversationResourceResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"parent":{"anyOf":[{"$ref":"#/components/schemas/ResourceParent"},{"type":"null"}]},"resource":{"additionalProperties":true,"type":"object","title":"Resource"},"type":{"type":"string","const":"text-conversations","title":"Type"}},"type":"object","required":["id","resource","type"],"title":"TextConversationResourceResponse"},"TextDirection":{"type":"string","enum":["inbound","outbound"],"title":"TextDirection"},"TextMediaItem":{"properties":{"content_type":{"type":"string","title":"Content Type"},"size":{"type":"integer","title":"Size"},"url":{"type":"string","title":"Url"}},"type":"object","required":["content_type","size","url"],"title":"TextMediaItem"},"TextMessageOrigin":{"type":"string","enum":["user_initiated","auto_reply"],"title":"TextMessageOrigin"},"TextType":{"type":"string","enum":["sms","mms"],"title":"TextType"},"UpdateApiKeyRequest":{"properties":{"label":{"type":"string","maxLength":255,"minLength":1,"title":"Label"},"description":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}],"title":"Description"}},"type":"object","required":["label"],"title":"UpdateApiKeyRequest"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"VoicemailDetection":{"type":"string","enum":["enabled","disabled"],"title":"VoicemailDetection"},"WebhookAgentIdentity":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"agent_handle":{"type":"string","title":"Agent Handle"},"display_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Name"}},"type":"object","required":["id","agent_handle"],"title":"WebhookAgentIdentity"},"WebhookCallTranscript":{"properties":{"entries":{"items":{"$ref":"#/components/schemas/WebhookTranscriptEntry"},"type":"array","title":"Entries"},"abridged":{"type":"boolean","title":"Abridged","default":false},"url":{"type":"string","title":"Url"}},"type":"object","required":["url"],"title":"WebhookCallTranscript"},"WebhookCatalogRow":{"properties":{"event_type":{"type":"string","title":"Event Type"},"resource_type":{"$ref":"#/components/schemas/WebhookDestinationResourceType"},"delivery_path":{"type":"string","title":"Delivery Path"},"payload_schema":{"type":"string","title":"Payload Schema"},"summary":{"type":"string","title":"Summary"},"description":{"type":"string","title":"Description"},"trigger_text":{"type":"string","title":"Trigger Text"},"delivery_text":{"type":"string","title":"Delivery Text"},"response_text":{"type":"string","title":"Response Text"},"response_required":{"type":"boolean","title":"Response Required"},"example_payload":{"type":"string","title":"Example Payload"},"example_response":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Example Response"}},"type":"object","required":["event_type","resource_type","delivery_path","payload_schema","summary","description","trigger_text","delivery_text","response_text","response_required","example_payload"],"title":"WebhookCatalogRow"},"WebhookContact":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"memories":{"items":{"type":"string"},"type":"array","title":"Memories"}},"type":"object","required":["id","name"],"title":"WebhookContact"},"WebhookDestinationResourceType":{"type":"string","enum":["mailbox","phone_number","agent_identity"],"title":"WebhookDestinationResourceType"},"WebhookIMessageMessage":{"properties":{"provider_message_handle":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Provider Message Handle"},"id":{"type":"string","format":"uuid","title":"Id"},"conversation_id":{"type":"string","format":"uuid","title":"Conversation Id"},"assignment_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Assignment Id"},"direction":{"$ref":"#/components/schemas/IMessageDirection"},"remote_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remote Number"},"sender_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sender Number"},"participants":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Participants"},"is_group":{"type":"boolean","title":"Is Group","default":false},"content":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Content"},"message_type":{"$ref":"#/components/schemas/IMessageType"},"service":{"$ref":"#/components/schemas/IMessageService"},"send_style":{"anyOf":[{"$ref":"#/components/schemas/IMessageSendStyle"},{"type":"null"}]},"media":{"anyOf":[{"items":{"$ref":"#/components/schemas/IMessageMediaItem"},"type":"array"},{"type":"null"}],"title":"Media"},"was_downgraded":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Was Downgraded"},"status":{"anyOf":[{"$ref":"#/components/schemas/IMessageStatus"},{"type":"null"}]},"error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error Code"},"error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error Message"},"error_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error Reason"},"error_detail":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error Detail"},"is_read":{"type":"boolean","title":"Is Read"},"is_blocked":{"type":"boolean","title":"Is Blocked","default":false},"recipients":{"anyOf":[{"items":{"$ref":"#/components/schemas/IMessageRecipientResponse"},"type":"array"},{"type":"null"}],"title":"Recipients"},"reactions":{"anyOf":[{"items":{"$ref":"#/components/schemas/IMessageMessageReaction"},"type":"array"},{"type":"null"}],"title":"Reactions"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","conversation_id","assignment_id","direction","remote_number","message_type","service","is_read","created_at","updated_at"],"title":"WebhookIMessageMessage"},"WebhookMailAgentIdentity":{"properties":{"bucket":{"type":"string","enum":["from","to","cc","bcc"],"title":"Bucket"},"address":{"type":"string","title":"Address"},"id":{"type":"string","format":"uuid","title":"Id"},"agent_handle":{"type":"string","title":"Agent Handle"},"display_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Name"}},"type":"object","required":["bucket","address","id","agent_handle"],"title":"WebhookMailAgentIdentity"},"WebhookMailContact":{"properties":{"bucket":{"type":"string","enum":["from","to","cc","bcc"],"title":"Bucket"},"address":{"type":"string","title":"Address"},"id":{"type":"string","format":"uuid","title":"Id"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"memories":{"items":{"type":"string"},"type":"array","title":"Memories"}},"type":"object","required":["bucket","address","id","name"],"title":"WebhookMailContact"},"WebhookPhoneCall":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"origin":{"$ref":"#/components/schemas/CallOrigin","default":"dedicated_number"},"local_phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Local Phone Number"},"remote_phone_number":{"type":"string","title":"Remote Phone Number"},"direction":{"$ref":"#/components/schemas/CallDirection"},"status":{"$ref":"#/components/schemas/CallStatus"},"mode":{"$ref":"#/components/schemas/CallMode","default":"client_websocket"},"hosted_agent_authority_mode":{"$ref":"#/components/schemas/HostedAgentAuthorityMode","default":"contact_scoped"},"voicemail_detection":{"$ref":"#/components/schemas/VoicemailDetection","default":"enabled"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"forwardings":{"items":{"$ref":"#/components/schemas/PhoneCallForwardingResponse"},"type":"array","title":"Forwardings"},"hangup_reason":{"anyOf":[{"$ref":"#/components/schemas/HangupReason"},{"type":"null"}]},"started_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Started At"},"ended_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Ended At"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"duration_seconds":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Duration Seconds"}},"type":"object","required":["id","remote_phone_number","direction","status","started_at","ended_at","created_at","updated_at"],"title":"WebhookPhoneCall"},"WebhookPostCallAction":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"seq":{"type":"integer","title":"Seq"},"action":{"type":"string","title":"Action"},"details":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Details"},"status":{"$ref":"#/components/schemas/PostCallActionStatus","default":"open"}},"type":"object","required":["id","seq","action"],"title":"WebhookPostCallAction"},"WebhookRecipient":{"properties":{"recipient_phone_number":{"type":"string","title":"Recipient Phone Number"},"delivery_status":{"anyOf":[{"$ref":"#/components/schemas/SmsDeliveryStatus"},{"type":"null"}]},"carrier":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Carrier"},"line_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line Type"},"error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error Code"},"error_detail":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error Detail"},"sent_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Sent At"},"delivered_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Delivered At"},"failed_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Failed At"}},"type":"object","required":["recipient_phone_number"],"title":"WebhookRecipient"},"WebhookTextMessage":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"direction":{"$ref":"#/components/schemas/TextDirection"},"local_phone_number":{"type":"string","title":"Local Phone Number"},"remote_phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remote Phone Number"},"text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Text"},"type":{"$ref":"#/components/schemas/TextType"},"media":{"anyOf":[{"items":{"$ref":"#/components/schemas/TextMediaItem"},"type":"array"},{"type":"null"}],"title":"Media"},"is_read":{"type":"boolean","title":"Is Read"},"delivery_status":{"anyOf":[{"$ref":"#/components/schemas/SmsDeliveryStatus"},{"type":"null"}]},"origin":{"$ref":"#/components/schemas/TextMessageOrigin","default":"user_initiated"},"error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error Code"},"error_detail":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error Detail"},"sent_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Sent At"},"delivered_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Delivered At"},"failed_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Failed At"},"conversation_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Conversation Id"},"sender_phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sender Phone Number"},"recipients":{"anyOf":[{"items":{"$ref":"#/components/schemas/WebhookRecipient"},"type":"array"},{"type":"null"}],"title":"Recipients"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","direction","local_phone_number","text","type","media","is_read","created_at","updated_at"],"title":"WebhookTextMessage"},"WebhookTranscriptEntry":{"properties":{"party":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Party"},"text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Text"},"ts_ms":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Ts Ms"},"truncated":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Truncated"},"marker":{"anyOf":[{"type":"string","const":"abridged"},{"type":"null"}],"title":"Marker"},"omitted_turns":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Omitted Turns"},"omitted_ms":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Omitted Ms"}},"type":"object","title":"WebhookTranscriptEntry"},"A2AInvitationAccept":{"properties":{"invitation_token":{"type":"string","maxLength":128,"minLength":1,"title":"Invitation Token"}},"additionalProperties":false,"type":"object","required":["invitation_token"],"title":"A2AInvitationAccept"},"A2AInvitationAcceptResponse":{"properties":{"invitation_id":{"type":"string","format":"uuid","title":"Invitation Id"},"invitee_identity_id":{"type":"string","format":"uuid","title":"Invitee Identity Id"},"invitee_agent_handle":{"type":"string","title":"Invitee Agent Handle"},"peer_agent_handles":{"items":{"type":"string"},"type":"array","title":"Peer Agent Handles"},"accepted_at":{"type":"string","format":"date-time","title":"Accepted At"},"status":{"type":"string","const":"accepted","title":"Status","default":"accepted"}},"type":"object","required":["invitation_id","invitee_identity_id","invitee_agent_handle","peer_agent_handles","accepted_at"],"title":"A2AInvitationAcceptResponse"},"A2AInvitationCreate":{"properties":{"peer_agent_handles":{"items":{"type":"string"},"type":"array","maxItems":25,"minItems":1,"title":"Peer Agent Handles"},"recipient_email":{"anyOf":[{"type":"string","format":"email"},{"type":"null"}],"title":"Recipient Email"},"expires_in_seconds":{"type":"integer","maximum":2592000.0,"minimum":3600.0,"title":"Expires In Seconds","default":604800}},"additionalProperties":false,"type":"object","required":["peer_agent_handles"],"title":"A2AInvitationCreate"},"A2AInvitationDecline":{"properties":{"invitation_token":{"type":"string","maxLength":128,"minLength":1,"title":"Invitation Token"}},"additionalProperties":false,"type":"object","required":["invitation_token"],"title":"A2AInvitationDecline"},"A2AInvitationDeclineResponse":{"properties":{"status":{"type":"string","const":"declined","title":"Status","default":"declined"}},"type":"object","title":"A2AInvitationDeclineResponse"},"A2AInvitationEmailStatus":{"type":"string","enum":["not_requested","pending","sent","failed","indeterminate"],"title":"A2AInvitationEmailStatus"},"A2AInvitationPage":{"properties":{"items":{"items":{"$ref":"#/components/schemas/A2AInvitationResponse"},"type":"array","title":"Items"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor"}},"type":"object","required":["items","next_cursor"],"title":"A2AInvitationPage"},"A2AInvitationPreview":{"properties":{"invitation_token":{"type":"string","maxLength":128,"minLength":1,"title":"Invitation Token"}},"additionalProperties":false,"type":"object","required":["invitation_token"],"title":"A2AInvitationPreview"},"A2AInvitationPreviewResponse":{"properties":{"inviter_email":{"type":"string","format":"email","title":"Inviter Email"},"peer_agent_handles":{"items":{"type":"string"},"type":"array","title":"Peer Agent Handles"},"expires_at":{"type":"string","format":"date-time","title":"Expires At"},"agent_handoff_prompt":{"type":"string","title":"Agent Handoff Prompt"}},"type":"object","required":["inviter_email","peer_agent_handles","expires_at","agent_handoff_prompt"],"title":"A2AInvitationPreviewResponse"},"A2AInvitationResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"issuer_organization_id":{"type":"string","title":"Issuer Organization Id"},"inviter_email":{"anyOf":[{"type":"string","format":"email"},{"type":"null"}],"title":"Inviter Email"},"peer_agent_handles":{"items":{"type":"string"},"type":"array","title":"Peer Agent Handles"},"recipient_email":{"anyOf":[{"type":"string","format":"email"},{"type":"null"}],"title":"Recipient Email"},"status":{"anyOf":[{"$ref":"#/components/schemas/A2AInvitationStatus"},{"type":"string","const":"expired"}],"title":"Status"},"invitee_identity_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Invitee Identity Id"},"invitee_agent_handle":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invitee Agent Handle"},"invitee_organization_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invitee Organization Id"},"email_status":{"$ref":"#/components/schemas/A2AInvitationEmailStatus"},"email_sent_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Email Sent At"},"expires_at":{"type":"string","format":"date-time","title":"Expires At"},"accepted_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Accepted At"},"declined_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Declined At"},"revoked_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Revoked At"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","issuer_organization_id","inviter_email","peer_agent_handles","recipient_email","status","invitee_identity_id","invitee_agent_handle","invitee_organization_id","email_status","email_sent_at","expires_at","accepted_at","declined_at","revoked_at","created_at","updated_at"],"title":"A2AInvitationResponse"},"A2AInvitationStatus":{"type":"string","enum":["pending","awaiting_verification","accepted","declined","revoked"],"title":"A2AInvitationStatus"},"A2AInvitationUnboundCreateResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"issuer_organization_id":{"type":"string","title":"Issuer Organization Id"},"inviter_email":{"anyOf":[{"type":"string","format":"email"},{"type":"null"}],"title":"Inviter Email"},"peer_agent_handles":{"items":{"type":"string"},"type":"array","title":"Peer Agent Handles"},"recipient_email":{"anyOf":[{"type":"string","format":"email"},{"type":"null"}],"title":"Recipient Email"},"status":{"anyOf":[{"$ref":"#/components/schemas/A2AInvitationStatus"},{"type":"string","const":"expired"}],"title":"Status"},"invitee_identity_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Invitee Identity Id"},"invitee_agent_handle":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invitee Agent Handle"},"invitee_organization_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invitee Organization Id"},"email_status":{"$ref":"#/components/schemas/A2AInvitationEmailStatus"},"email_sent_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Email Sent At"},"expires_at":{"type":"string","format":"date-time","title":"Expires At"},"accepted_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Accepted At"},"declined_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Declined At"},"revoked_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Revoked At"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"invitation_token":{"type":"string","title":"Invitation Token"},"invitation_url":{"type":"string","title":"Invitation Url"},"agent_handoff_prompt":{"type":"string","title":"Agent Handoff Prompt"}},"type":"object","required":["id","issuer_organization_id","inviter_email","peer_agent_handles","recipient_email","status","invitee_identity_id","invitee_agent_handle","invitee_organization_id","email_status","email_sent_at","expires_at","accepted_at","declined_at","revoked_at","created_at","updated_at","invitation_token","invitation_url","agent_handoff_prompt"],"title":"A2AInvitationUnboundCreateResponse"},"A2AInvitationSignupSummary":{"properties":{"invitation_id":{"type":"string","format":"uuid","title":"Invitation Id"},"status":{"$ref":"#/components/schemas/A2AInvitationStatus"},"invitee_identity_id":{"type":"string","format":"uuid","title":"Invitee Identity Id"},"invitee_agent_handle":{"type":"string","title":"Invitee Agent Handle"},"peer_agent_handles":{"items":{"type":"string"},"type":"array","title":"Peer Agent Handles"},"accepted_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Accepted At"}},"type":"object","required":["invitation_id","status","invitee_identity_id","invitee_agent_handle","peer_agent_handles","accepted_at"],"title":"A2AInvitationSignupSummary"},"AgentClaimRequest":{"properties":{"verification_code":{"type":"string","maxLength":6,"minLength":6,"pattern":"^\\d{6}$","title":"Verification Code","description":"6-digit verification code sent to the human's email."}},"type":"object","required":["verification_code"],"title":"AgentClaimRequest"},"AgentClaimResponse":{"properties":{"claim_status":{"$ref":"#/components/schemas/AgentClaimStatus"},"organization_id":{"type":"string","title":"Organization Id"},"message":{"type":"string","title":"Message"},"invitation":{"anyOf":[{"$ref":"#/components/schemas/A2AInvitationSignupSummary"},{"type":"null"}]}},"type":"object","required":["claim_status","organization_id","message"],"title":"AgentClaimResponse"},"AgentClaimStatus":{"type":"string","enum":["agent_unclaimed","agent_claimed","agent_rejected"],"title":"AgentClaimStatus"},"AgentRestrictions":{"properties":{"max_sends_per_day":{"type":"integer","title":"Max Sends Per Day"},"allowed_recipients":{"items":{"type":"string"},"type":"array","title":"Allowed Recipients"},"can_receive":{"type":"boolean","title":"Can Receive"},"can_create_mailboxes":{"type":"boolean","title":"Can Create Mailboxes"}},"type":"object","required":["max_sends_per_day","allowed_recipients","can_receive","can_create_mailboxes"],"title":"AgentRestrictions"},"AgentSignupRequest":{"properties":{"human_email":{"type":"string","format":"email","title":"Human Email","description":"Email address of the human who owns/oversees this agent."},"note_to_human":{"type":"string","maxLength":2000,"minLength":1,"title":"Note To Human","description":"Message from the agent to the human, included in the verification email."},"display_name":{"anyOf":[{"type":"string","maxLength":255,"minLength":1},{"type":"null"}],"title":"Display Name","description":"Display name for the agent's mailbox. Defaults to agent_handle when omitted."},"agent_handle":{"anyOf":[{"type":"string","maxLength":255,"minLength":1},{"type":"null"}],"title":"Agent Handle","description":"Optional agent handle. A leading '@' is stripped automatically. Must contain only lowercase letters, numbers, dashes, and underscores. Auto-generated from display_name if omitted."},"email_local_part":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email Local Part","description":"Optional email local part to use before the sending domain. If omitted, the server generates a random one."},"harness":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Harness","description":"Agent runtime/harness the signing-up agent runs on (e.g. 'claude-code', 'codex', 'cursor'). Free-form: unknown values are accepted, never rejected."},"invitation_token":{"anyOf":[{"type":"string","maxLength":128,"minLength":1},{"type":"null"}],"title":"Invitation Token","description":"Optional A2A connection invitation credential. Omit when signup is not part of an A2A invitation."}},"type":"object","required":["human_email","note_to_human"],"title":"AgentSignupRequest"},"AgentSignupResponse":{"properties":{"email_address":{"type":"string","title":"Email Address"},"organization_id":{"type":"string","title":"Organization Id"},"api_key":{"type":"string","title":"Api Key","description":"Full API key. Store securely, it will not be shown again."},"agent_handle":{"type":"string","title":"Agent Handle"},"claim_status":{"$ref":"#/components/schemas/AgentClaimStatus"},"human_email":{"type":"string","title":"Human Email"},"message":{"type":"string","title":"Message"},"invitation":{"anyOf":[{"$ref":"#/components/schemas/A2AInvitationSignupSummary"},{"type":"null"}]}},"type":"object","required":["email_address","organization_id","api_key","agent_handle","claim_status","human_email","message"],"title":"AgentSignupResponse"},"AgentSignupStatusResponse":{"properties":{"claim_status":{"$ref":"#/components/schemas/AgentClaimStatus"},"human_state":{"$ref":"#/components/schemas/HumanState"},"human_email":{"type":"string","title":"Human Email"},"restrictions":{"$ref":"#/components/schemas/AgentRestrictions"}},"type":"object","required":["claim_status","human_state","human_email","restrictions"],"title":"AgentSignupStatusResponse"},"ApproveAgentRequest":{"properties":{"organization_id":{"type":"string","title":"Organization Id","description":"Organization ID to assign the agent to. The caller must be a member of this organization."}},"type":"object","required":["organization_id"],"title":"ApproveAgentRequest"},"ApproveAgentResponse":{"properties":{"identity_id":{"type":"string","format":"uuid","title":"Identity Id"},"claim_status":{"$ref":"#/components/schemas/AgentClaimStatus"},"organization_id":{"type":"string","title":"Organization Id"},"message":{"type":"string","title":"Message"}},"type":"object","required":["identity_id","claim_status","organization_id","message"],"title":"ApproveAgentResponse"},"HumanState":{"type":"string","enum":["human_no_account","human_account_unverified","human_account_verified"],"title":"HumanState"},"PendingAgentIdentityResponse":{"properties":{"identity_id":{"type":"string","format":"uuid","title":"Identity Id"},"agent_handle":{"type":"string","title":"Agent Handle"},"display_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Name"},"email_address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email Address"},"organization_id":{"type":"string","title":"Organization Id"},"claim_status":{"$ref":"#/components/schemas/AgentClaimStatus"},"created_at":{"type":"string","format":"date-time","title":"Created At"}},"type":"object","required":["identity_id","agent_handle","display_name","email_address","organization_id","claim_status","created_at"],"title":"PendingAgentIdentityResponse"},"PendingAgentsResponse":{"properties":{"agents":{"items":{"$ref":"#/components/schemas/PendingAgentIdentityResponse"},"type":"array","title":"Agents"}},"type":"object","required":["agents"],"title":"PendingAgentsResponse"},"RejectAgentResponse":{"properties":{"identity_id":{"type":"string","format":"uuid","title":"Identity Id"},"message":{"type":"string","title":"Message"}},"type":"object","required":["identity_id","message"],"title":"RejectAgentResponse"},"BillingSettingsResponse":{"properties":{"overage_cap_cents":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Overage Cap Cents","description":"Monthly SMS+voice overage spend limit in cents; None = no limit. Once cycle-to-date overage spend reaches it, overage-incurring sends and calls are refused (402) until the cycle resets or the limit is raised. Usage within included allowances is never blocked; inbound and in-flight usage can exceed the limit slightly."},"remove_branding_footer":{"type":"boolean","title":"Remove Branding Footer","description":"When true and the organization is on a paid plan, outbound emails omit the 'Sent via Inkbox' footer. Takes effect only while the organization is on a paid plan; on the Free plan the footer always applies.","default":false}},"type":"object","title":"BillingSettingsResponse"},"ChangePlanRequest":{"properties":{"plan":{"$ref":"#/components/schemas/Plan","description":"Target plan: a self-serve plan or 'free' (cancel)."},"startup_variant":{"anyOf":[{"type":"string","const":"outbound"},{"type":"null"}],"title":"Startup Variant","description":"Startup only: pass the fixed value 'outbound' when selecting the supported $200 plan. Omit or pass null while keeping the current Startup subscription to clear a pending change without changing its legacy price."}},"type":"object","required":["plan"],"title":"ChangePlanRequest"},"ChannelUsageResponse":{"properties":{"event_type":{"type":"string","title":"Event Type","description":"Usage channel key (UsageEventType, e.g. 'sms_outbound')."},"count":{"type":"integer","title":"Count","description":"Total usage this cycle (messages, or call seconds for voice)."},"overage":{"type":"integer","title":"Overage","description":"Units beyond the included allowance this cycle."},"est_overage_cents":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Est Overage Cents","description":"Estimated overage cost in cents (from published rates). None for unpriced channels (email, iMessage)."},"own_campaign_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Own Campaign Count","description":"For SMS channels: portion of 'count' carried on the org's own 10DLC campaign (the rest rode the Inkbox-managed campaign). None on non-SMS channels."}},"type":"object","required":["event_type","count","overage"],"title":"ChannelUsageResponse"},"CheckoutSessionRequest":{"properties":{"plan":{"$ref":"#/components/schemas/Plan","description":"Plan to subscribe to. Must be a self-serve plan."},"startup_variant":{"type":"string","const":"outbound","title":"Startup Variant","description":"Startup only: the supported $200 dedicated-line option. The fixed value is 'outbound'; ignored for other plans.","default":"outbound"},"success_url":{"type":"string","title":"Success Url","description":"Absolute URL Stripe returns to after a completed checkout. Must be https on an inkbox.ai host (localhost allowed in dev)."},"cancel_url":{"type":"string","title":"Cancel Url","description":"Absolute URL Stripe returns to if the user cancels checkout. Same host restrictions as success_url."}},"type":"object","required":["plan","success_url","cancel_url"],"title":"CheckoutSessionRequest"},"CheckoutSessionResponse":{"properties":{"url":{"type":"string","title":"Url","description":"Stripe Checkout session URL."}},"type":"object","required":["url"],"title":"CheckoutSessionResponse"},"EntitlementsResponse":{"properties":{"is_custom":{"type":"boolean","title":"Is Custom","description":"True when the active subscription price matches a custom_plans row."},"display_name":{"type":"string","title":"Display Name","description":"Plan display name — the custom plan's name, else the tier name."},"plan_amount_cents":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Plan Amount Cents","description":"Flat recurring plan fee in cents; None when it can't be determined."},"phone_numbers":{"type":"integer","title":"Phone Numbers","description":"Phone-enabled identities cap (resolved PHONE_NUMBERS quota)."},"sending_domains":{"type":"integer","title":"Sending Domains","description":"Custom email domains cap (resolved MAIL_SENDING_DOMAINS_ACTIVE quota)."},"identities":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Identities","description":"Agent-identity cap (resolved IDENTITIES_ACTIVE quota)."},"mail_storage_bytes_per_identity":{"type":"integer","title":"Mail Storage Bytes Per Identity","description":"Stored-mail cap per mailbox in bytes (resolved MAIL_STORAGE_BYTES_PER_IDENTITY quota)."},"imessage_messages_per_org_per_cycle":{"type":"integer","title":"Imessage Messages Per Org Per Cycle","description":"Org-wide shared-pool iMessage messages per billing cycle (resolved IMESSAGE_MESSAGES_PER_ORG_PER_CYCLE quota; dedicated-line traffic has its own cap)."},"imessage_dedicated_messages_per_org_per_cycle":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Imessage Dedicated Messages Per Org Per Cycle","description":"Org-wide dedicated-line iMessage messages per billing cycle (resolved IMESSAGE_DEDICATED_MESSAGES_PER_ORG_PER_CYCLE quota); None/0 when the plan includes no dedicated lines."},"startup_variant":{"anyOf":[{"$ref":"#/components/schemas/StartupVariant"},{"type":"null"}],"description":"For Startup subscriptions: 'outbound' identifies the current $200 plan; 'inbound' identifies a grandfathered retired $180 price. None on other plans."},"imessage_unique_recipients_per_org_per_cycle":{"type":"integer","title":"Imessage Unique Recipients Per Org Per Cycle","description":"Org-wide unique iMessage recipients per billing cycle (resolved IMESSAGE_UNIQUE_RECIPIENTS_PER_ORG_PER_CYCLE quota)."},"sms_allowance_per_identity":{"type":"integer","title":"Sms Allowance Per Identity","description":"Included SMS allowance per phone-enabled identity per cycle."},"voice_sec_allowance_per_identity":{"type":"integer","title":"Voice Sec Allowance Per Identity","description":"Included voice allowance per phone-enabled identity per cycle, in seconds."},"imessage_enabled":{"type":"boolean","title":"Imessage Enabled","description":"Whether iMessage is included on the plan's identities."},"dedicated_imessage_inbound_lines":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Dedicated Imessage Inbound Lines","description":"Dedicated inbound (receive/reply-only) iMessage lines the org may claim (resolved IMESSAGE_DEDICATED_INBOUND_LINES quota; 0 when the plan includes none)."},"dedicated_imessage_outbound_lines":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Dedicated Imessage Outbound Lines","description":"Dedicated outbound (may initiate) iMessage lines the org may claim (resolved IMESSAGE_DEDICATED_OUTBOUND_LINES quota; 0 when the plan includes none)."},"imessage_included_messages_per_cycle":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Imessage Included Messages Per Cycle","description":"iMessage volume included per billing cycle before overage billing; None when the plan has no such term."},"imessage_overage_cents_per_million":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Imessage Overage Cents Per Million","description":"Price in cents per additional 1M iMessages (or portion thereof) beyond the included volume; None when the plan has no such term."},"campaign_fee_cents":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Campaign Fee Cents","description":"Monthly fee in cents per carrier-approved 10DLC campaign; None when the fee isn't offered in this environment."},"campaign_fee_active":{"type":"boolean","title":"Campaign Fee Active","description":"Whether the org is currently being billed the 10DLC campaign fee.","default":false}},"type":"object","required":["is_custom","display_name","phone_numbers","sending_domains","mail_storage_bytes_per_identity","imessage_messages_per_org_per_cycle","imessage_unique_recipients_per_org_per_cycle","sms_allowance_per_identity","voice_sec_allowance_per_identity","imessage_enabled"],"title":"EntitlementsResponse"},"IdentityChannelCountResponse":{"properties":{"event_type":{"type":"string","title":"Event Type","description":"Usage channel key (UsageEventType)."},"count":{"type":"integer","title":"Count","description":"This identity's usage on the channel this cycle."},"own_campaign_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Own Campaign Count","description":"For SMS channels: portion of 'count' carried on the org's own 10DLC campaign. None on non-SMS channels."}},"type":"object","required":["event_type","count"],"title":"IdentityChannelCountResponse"},"IdentityUsageResponse":{"properties":{"identity_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Identity Id","description":"Agent identity id, or None for the 'Unattributed' bucket (usage with no originating identity, e.g. outbound email)."},"handle":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Handle","description":"Agent handle, if the identity is known."},"display_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Name","description":"Identity display name, if set."},"channels":{"items":{"$ref":"#/components/schemas/IdentityChannelCountResponse"},"type":"array","title":"Channels","description":"Per-channel usage counts for this identity."},"sms_used":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Sms Used","description":"Combined in+out SMS drawn against this identity's allowance this cycle. None when the identity used no SMS."},"sms_limit":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Sms Limit","description":"Included SMS allowance for the identity."},"voice_sec_used":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Voice Sec Used","description":"Combined in+out call seconds drawn this cycle. None when unused."},"voice_sec_limit":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Voice Sec Limit","description":"Included voice allowance for the identity, in seconds."}},"type":"object","title":"IdentityUsageResponse"},"Plan":{"type":"string","enum":["free","hobbyist","developer","startup","enterprise"],"title":"Plan"},"PortalSessionRequest":{"properties":{"return_url":{"type":"string","title":"Return Url","description":"Absolute URL Stripe returns to when the user leaves the billing portal. Must be https on an inkbox.ai host (localhost allowed in dev)."}},"type":"object","required":["return_url"],"title":"PortalSessionRequest"},"PortalSessionResponse":{"properties":{"url":{"type":"string","title":"Url","description":"Stripe billing portal session URL."}},"type":"object","required":["url"],"title":"PortalSessionResponse"},"StartupVariant":{"type":"string","enum":["outbound","inbound"],"title":"StartupVariant"},"SubscriptionStatusResponse":{"properties":{"plan":{"$ref":"#/components/schemas/Plan","description":"Org's current plan; FREE when no paid subscription is active."},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status","description":"Stripe subscription status (active, past_due, ...) or None on Free."},"cancel_at_period_end":{"type":"boolean","title":"Cancel At Period End","description":"Whether the subscription is set to cancel at the period boundary.","default":false},"current_period_end":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Current Period End","description":"Unix seconds when the current billing period ends, if subscribed."},"pending_plan":{"anyOf":[{"$ref":"#/components/schemas/Plan"},{"type":"null"}],"description":"Plan the subscription will switch to at period end (FREE = scheduled cancel), if any."},"pending_change_date":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Pending Change Date","description":"Unix seconds when the pending plan change / cancellation takes effect."},"pending_startup_variant":{"anyOf":[{"$ref":"#/components/schemas/StartupVariant"},{"type":"null"}],"description":"When the pending plan is Startup: which flat-price variant the scheduled switch lands on. None otherwise."},"legacy_developer_price":{"type":"boolean","title":"Legacy Developer Price","description":"True when the subscription's flat price is the retired $25 Developer price (sunset migration pending); the console surfaces the phase-out banner from this.","default":false},"stripe_configured":{"type":"boolean","title":"Stripe Configured","description":"False when Stripe isn't configured server-side; the UI hides upgrade actions."},"balance":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Balance","description":"Stripe customer account balance in cents (negative = credit available, positive = amount owed). None on Free with no customer yet, or if the read failed."},"estimated_next_bill":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Estimated Next Bill","description":"Amount due in cents on the upcoming invoice (plan fee + metered overage accrued so far this cycle), net of any account credit. None when there's no subscription (Free) or the preview read failed."},"entitlements":{"anyOf":[{"$ref":"#/components/schemas/EntitlementsResponse"},{"type":"null"}],"description":"Plan entitlement details (price, caps, allowance, custom-plan flag) for paid plans; None on Free."}},"type":"object","required":["plan","stripe_configured"],"title":"SubscriptionStatusResponse"},"UpdateBillingSettingsRequest":{"properties":{"overage_cap_cents":{"anyOf":[{"type":"integer","maximum":10000000.0,"minimum":0.0},{"type":"null"}],"title":"Overage Cap Cents","description":"Monthly SMS+voice overage spend limit in cents. Omit to leave unchanged; null clears the limit; 0 blocks all overage-incurring sends and calls."},"remove_branding_footer":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Remove Branding Footer","description":"Set true to remove the 'Sent via Inkbox' footer from outbound emails (paid plans only; 403 on Free). Omit or null to leave unchanged."}},"type":"object","title":"UpdateBillingSettingsRequest"},"UsageSummaryResponse":{"properties":{"cycle_start":{"type":"integer","title":"Cycle Start","description":"Unix seconds for the start of the current usage cycle."},"cycle_end":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Cycle End","description":"Unix seconds for the end of the current usage cycle (Stripe period end, or the calendar-month boundary for orgs with no subscription)."},"plan":{"type":"string","title":"Plan","description":"Org's current plan (free/hobbyist/developer/startup/enterprise)."},"channels":{"items":{"$ref":"#/components/schemas/ChannelUsageResponse"},"type":"array","title":"Channels","description":"Org-wide totals, one per channel with usage this cycle."},"identities":{"items":{"$ref":"#/components/schemas/IdentityUsageResponse"},"type":"array","title":"Identities","description":"Per-identity usage breakdown."},"sms_allowance_per_identity":{"type":"integer","title":"Sms Allowance Per Identity","description":"Included SMS allowance per phone-enabled identity per cycle (0 on Free)."},"voice_sec_allowance_per_identity":{"type":"integer","title":"Voice Sec Allowance Per Identity","description":"Included voice allowance per phone-enabled identity per cycle, in seconds."},"overage_cap_cents":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Overage Cap Cents","description":"Org's monthly SMS+voice overage spend limit in cents; None when unset."},"overage_spend_cents":{"type":"integer","title":"Overage Spend Cents","description":"Estimated SMS+voice overage spend so far this cycle, in cents (the figure the overage spend limit is enforced against).","default":0},"imessage_shared_messages":{"type":"integer","title":"Imessage Shared Messages","description":"Shared-pool iMessage messages this cycle (both directions) — the count the plan's shared iMessage cap is enforced against.","default":0},"imessage_dedicated_messages":{"type":"integer","title":"Imessage Dedicated Messages","description":"Dedicated-line iMessage messages this cycle (both directions) — the count the dedicated-line cap is enforced against.","default":0},"imessage_unique_recipients":{"type":"integer","title":"Imessage Unique Recipients","description":"Unique shared-pool iMessage recipients this cycle — the count the plan's unique-recipient cap is enforced against.","default":0},"identities_used":{"type":"integer","title":"Identities Used","description":"Non-deleted agent identities in the org — the count the plan's identity cap is enforced against on create.","default":0},"identities_included":{"type":"integer","title":"Identities Included","description":"Agent identities included in the plan (resolved IDENTITIES_ACTIVE quota).","default":0}},"type":"object","required":["cycle_start","plan","sms_allowance_per_identity","voice_sec_allowance_per_identity"],"title":"UsageSummaryResponse"},"BrandAltBusinessIdType":{"type":"string","enum":["DUNS","GIIN","LEI"],"title":"BrandAltBusinessIdType"},"BrandCountry":{"type":"string","enum":["US","CA"],"title":"BrandCountry"},"BrandEntityType":{"type":"string","enum":["PRIVATE_PROFIT","PUBLIC_PROFIT","NON_PROFIT","GOVERNMENT","SOLE_PROPRIETOR"],"title":"BrandEntityType"},"BrandOptionalAttributes":{"properties":{"taxExemptStatus":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Taxexemptstatus"}},"additionalProperties":true,"type":"object","title":"BrandOptionalAttributes"},"BrandRegistrationRequest":{"properties":{"entity_type":{"$ref":"#/components/schemas/BrandEntityType"},"display_name":{"type":"string","maxLength":100,"minLength":1,"title":"Display Name"},"email":{"type":"string","maxLength":100,"minLength":1,"title":"Email"},"vertical":{"$ref":"#/components/schemas/BrandVertical"},"country":{"$ref":"#/components/schemas/BrandCountry"},"phone":{"type":"string","maxLength":20,"minLength":1,"title":"Phone"},"website":{"type":"string","maxLength":100,"minLength":1,"title":"Website"},"street":{"type":"string","maxLength":100,"minLength":1,"title":"Street"},"city":{"type":"string","maxLength":100,"minLength":1,"title":"City"},"state":{"type":"string","maxLength":8,"minLength":1,"title":"State"},"postal_code":{"type":"string","maxLength":10,"minLength":1,"title":"Postal Code"},"company_name":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Company Name"},"ein":{"anyOf":[{"type":"string","maxLength":9,"minLength":9,"pattern":"^\\d{9}$"},{"type":"null"}],"title":"Ein"},"first_name":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"First Name"},"last_name":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Last Name"},"mobile_phone":{"anyOf":[{"type":"string","maxLength":20},{"type":"null"}],"title":"Mobile Phone"},"business_contact_email":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Business Contact Email"},"stock_symbol":{"anyOf":[{"type":"string","maxLength":10},{"type":"null"}],"title":"Stock Symbol"},"stock_exchange":{"anyOf":[{"$ref":"#/components/schemas/BrandStockExchange"},{"type":"null"}]}},"additionalProperties":false,"type":"object","required":["entity_type","display_name","email","vertical","country","phone","website","street","city","state","postal_code"],"title":"BrandRegistrationRequest"},"BrandRegistrationResponse":{"properties":{"brandRelationship":{"type":"string","enum":["BASIC_ACCOUNT","SMALL_ACCOUNT","MEDIUM_ACCOUNT","LARGE_ACCOUNT","KEY_ACCOUNT"],"title":"Brandrelationship"},"country":{"type":"string","title":"Country"},"displayName":{"type":"string","title":"Displayname"},"email":{"type":"string","title":"Email"},"entityType":{"type":"string","enum":["PRIVATE_PROFIT","PUBLIC_PROFIT","NON_PROFIT","GOVERNMENT","SOLE_PROPRIETOR"],"title":"Entitytype"},"vertical":{"type":"string","title":"Vertical"},"altBusinessId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Altbusinessid"},"altBusinessIdType":{"anyOf":[{"type":"string","enum":["NONE","DUNS","GIIN","LEI"]},{"type":"null"}],"title":"Altbusinessidtype"},"brandId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Brandid"},"businessContactEmail":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Businesscontactemail"},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City"},"companyName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Companyname"},"createdAt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Createdat"},"cspId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cspid"},"ein":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ein"},"failureReasons":{"anyOf":[{"type":"string"},{"items":{"$ref":"#/components/schemas/RegistryFailureReason"},"type":"array"},{"type":"null"}],"title":"Failurereasons"},"firstName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Firstname"},"identityStatus":{"anyOf":[{"type":"string","enum":["VERIFIED","UNVERIFIED","SELF_DECLARED","VETTED_VERIFIED"]},{"type":"null"}],"title":"Identitystatus"},"ipAddress":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ipaddress"},"isReseller":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Isreseller"},"lastName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lastname"},"mobilePhone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mobilephone"},"mock":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Mock"},"optionalAttributes":{"anyOf":[{"$ref":"#/components/schemas/BrandOptionalAttributes"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone"},"postalCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Postalcode"},"referenceId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Referenceid"},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State"},"status":{"anyOf":[{"type":"string","enum":["OK","REGISTRATION_PENDING","REGISTRATION_FAILED"]},{"type":"null"}],"title":"Status"},"stockExchange":{"anyOf":[{"type":"string","enum":["NONE","NASDAQ","NYSE","AMEX","AMX","ASX","B3","BME","BSE","FRA","ICEX","JPX","JSE","KRX","LON","NSE","OMX","SEHK","SSE","STO","SWX","SZSE","TSX","TWSE","VSE"]},{"type":"null"}],"title":"Stockexchange"},"stockSymbol":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Stocksymbol"},"street":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Street"},"tcrBrandId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tcrbrandid"},"universalEin":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Universalein"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updatedat"},"webhookFailoverURL":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Webhookfailoverurl"},"webhookURL":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Webhookurl"},"website":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Website"}},"additionalProperties":true,"type":"object","required":["brandRelationship","country","displayName","email","entityType","vertical"],"title":"BrandRegistrationResponse"},"BrandSmsOtpTriggerResponse":{"properties":{"brand_id":{"type":"string","title":"Brand Id","description":"The registry-side brand UUID the OTP was triggered for."},"reference_id":{"type":"string","title":"Reference Id","description":"Carrier-registry reference id for this OTP attempt. Useful for debugging if a customer reports they never received the SMS."}},"type":"object","required":["brand_id","reference_id"],"title":"BrandSmsOtpTriggerResponse"},"BrandSmsOtpVerifyRequest":{"properties":{"otp_pin":{"type":"string","maxLength":10,"minLength":4,"title":"Otp Pin","description":"One-time PIN the customer received via SMS."}},"additionalProperties":false,"type":"object","required":["otp_pin"],"title":"BrandSmsOtpVerifyRequest"},"BrandStockExchange":{"type":"string","enum":["NYSE","NASDAQ","AMEX","AMX","ASX","B3","BME","BSE","FRA","ICEX","JPX","JSE","KRX","LON","NSE","OMX","SEHK","SSE","STO","SWX","SZSE","TSX","TWSE","VSE"],"title":"BrandStockExchange"},"BrandUpdateRequest":{"properties":{"country":{"$ref":"#/components/schemas/BrandCountry"},"display_name":{"type":"string","maxLength":100,"minLength":1,"title":"Display Name"},"email":{"type":"string","maxLength":100,"minLength":1,"title":"Email"},"entity_type":{"$ref":"#/components/schemas/BrandEntityType"},"vertical":{"$ref":"#/components/schemas/BrandVertical"},"phone":{"type":"string","maxLength":20,"minLength":1,"title":"Phone"},"website":{"type":"string","maxLength":100,"minLength":1,"title":"Website"},"street":{"type":"string","maxLength":100,"minLength":1,"title":"Street"},"city":{"type":"string","maxLength":100,"minLength":1,"title":"City"},"state":{"type":"string","maxLength":8,"minLength":1,"title":"State"},"postal_code":{"type":"string","maxLength":10,"minLength":1,"title":"Postal Code"},"alt_business_id":{"anyOf":[{"type":"string","maxLength":50},{"type":"null"}],"title":"Alt Business Id"},"alt_business_id_type":{"anyOf":[{"$ref":"#/components/schemas/BrandAltBusinessIdType"},{"type":"null"}]},"company_name":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Company Name"},"ein":{"anyOf":[{"type":"string","maxLength":9,"minLength":9,"pattern":"^\\d{9}$"},{"type":"null"}],"title":"Ein"},"first_name":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"First Name"},"last_name":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Last Name"},"business_contact_email":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Business Contact Email"},"stock_symbol":{"anyOf":[{"type":"string","maxLength":10},{"type":"null"}],"title":"Stock Symbol"},"stock_exchange":{"anyOf":[{"$ref":"#/components/schemas/BrandStockExchange"},{"type":"null"}]}},"additionalProperties":false,"type":"object","required":["country","display_name","email","entity_type","vertical","phone","website","street","city","state","postal_code"],"title":"BrandUpdateRequest"},"BrandVertical":{"type":"string","enum":["PROFESSIONAL","REAL_ESTATE","HEALTHCARE","HUMAN_RESOURCES","ENERGY","ENTERTAINMENT","RETAIL","TRANSPORTATION","AGRICULTURE","INSURANCE","POSTAL","EDUCATION","HOSPITALITY","FINANCIAL","POLITICAL","GAMBLING","LEGAL","CONSTRUCTION","NGO","MANUFACTURING","GOVERNMENT","TECHNOLOGY","COMMUNICATION"],"title":"BrandVertical"},"CampaignActiveStateResponse":{"properties":{"active":{"type":"boolean","title":"Active"}},"type":"object","required":["active"],"title":"CampaignActiveStateResponse"},"CampaignActiveToggleRequest":{"properties":{"active":{"type":"boolean","title":"Active"}},"type":"object","required":["active"],"title":"CampaignActiveToggleRequest"},"CampaignActiveToggleResponse":{"properties":{"active":{"type":"boolean","title":"Active"},"local_numbers_scheduled_for_migration":{"type":"integer","title":"Local Numbers Scheduled For Migration"}},"type":"object","required":["active","local_numbers_scheduled_for_migration"],"title":"CampaignActiveToggleResponse"},"CampaignRegistrationRequest":{"properties":{"brand_id":{"type":"string","maxLength":64,"minLength":1,"title":"Brand Id"},"usecase":{"$ref":"#/components/schemas/CampaignUseCase"},"description":{"type":"string","maxLength":4096,"minLength":40,"title":"Description"},"message_flow":{"type":"string","maxLength":2048,"minLength":40,"title":"Message Flow"},"help_message":{"type":"string","maxLength":320,"minLength":20,"title":"Help Message"},"sample1":{"type":"string","maxLength":320,"minLength":20,"title":"Sample1"},"sample2":{"type":"string","maxLength":320,"minLength":20,"title":"Sample2"},"sample3":{"type":"string","maxLength":320,"minLength":20,"title":"Sample3"},"sample4":{"type":"string","maxLength":320,"minLength":20,"title":"Sample4"},"sample5":{"anyOf":[{"type":"string","maxLength":320,"minLength":20},{"type":"null"}],"title":"Sample5"},"optin_keywords":{"type":"string","maxLength":320,"minLength":1,"title":"Optin Keywords"},"optout_keywords":{"type":"string","maxLength":320,"minLength":1,"title":"Optout Keywords"},"help_keywords":{"type":"string","maxLength":320,"minLength":1,"title":"Help Keywords"},"optin_message":{"type":"string","maxLength":320,"minLength":20,"title":"Optin Message"},"optout_message":{"type":"string","maxLength":320,"minLength":20,"title":"Optout Message"},"embedded_link":{"type":"boolean","title":"Embedded Link","default":false},"embedded_link_sample":{"anyOf":[{"type":"string","maxLength":320},{"type":"null"}],"title":"Embedded Link Sample"},"embedded_phone":{"type":"boolean","title":"Embedded Phone","default":false},"age_gated":{"type":"boolean","title":"Age Gated","default":false},"direct_lending":{"type":"boolean","title":"Direct Lending","default":false},"privacy_policy_link":{"type":"string","maxLength":512,"minLength":1,"title":"Privacy Policy Link"},"terms_and_conditions_link":{"type":"string","maxLength":512,"minLength":1,"title":"Terms And Conditions Link"},"sub_usecases":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Sub Usecases"}},"additionalProperties":false,"type":"object","required":["brand_id","usecase","description","message_flow","help_message","sample1","sample2","sample3","sample4","optin_keywords","optout_keywords","help_keywords","optin_message","optout_message","privacy_policy_link","terms_and_conditions_link"],"title":"CampaignRegistrationRequest"},"CampaignRegistrationResponse":{"properties":{"brandId":{"type":"string","title":"Brandid"},"campaignId":{"type":"string","title":"Campaignid"},"cspId":{"type":"string","title":"Cspid"},"description":{"type":"string","title":"Description"},"mock":{"type":"boolean","title":"Mock"},"subUsecases":{"items":{"type":"string"},"type":"array","title":"Subusecases"},"termsAndConditions":{"type":"boolean","title":"Termsandconditions"},"usecase":{"type":"string","title":"Usecase"},"ageGated":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Agegated"},"autoRenewal":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Autorenewal"},"billedDate":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Billeddate"},"brandDisplayName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Branddisplayname"},"campaignStatus":{"anyOf":[{"type":"string","enum":["TCR_PENDING","TCR_SUSPENDED","TCR_EXPIRED","TCR_ACCEPTED","TCR_FAILED","CSP_ACCEPTED","CSP_FAILED","MNO_PENDING","MNO_ACCEPTED","MNO_REJECTED","MNO_PROVISIONED","MNO_PROVISIONING_FAILED"]},{"type":"null"}],"title":"Campaignstatus","description":"Campaign status"},"createDate":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Createdate"},"directLending":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Directlending"},"embeddedLink":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Embeddedlink"},"embeddedLinkSample":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Embeddedlinksample"},"embeddedPhone":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Embeddedphone"},"failureReasons":{"anyOf":[{"type":"string"},{"items":{"$ref":"#/components/schemas/RegistryFailureReason"},"type":"array"},{"type":"null"}],"title":"Failurereasons"},"helpKeywords":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Helpkeywords"},"helpMessage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Helpmessage"},"isTMobileNumberPoolingEnabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Istmobilenumberpoolingenabled"},"isTMobileRegistered":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Istmobileregistered"},"isTMobileSuspended":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Istmobilesuspended"},"messageFlow":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Messageflow"},"nextRenewalOrExpirationDate":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nextrenewalorexpirationdate"},"numberPool":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Numberpool"},"optinKeywords":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Optinkeywords"},"optinMessage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Optinmessage"},"optoutKeywords":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Optoutkeywords"},"optoutMessage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Optoutmessage"},"privacyPolicyLink":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Privacypolicylink"},"referenceId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Referenceid"},"resellerId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Resellerid"},"sample1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sample1"},"sample2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sample2"},"sample3":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sample3"},"sample4":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sample4"},"sample5":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sample5"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"submissionStatus":{"anyOf":[{"type":"string","enum":["CREATED","FAILED","PENDING"]},{"type":"null"}],"title":"Submissionstatus"},"subscriberHelp":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Subscriberhelp"},"subscriberOptin":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Subscriberoptin"},"subscriberOptout":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Subscriberoptout"},"tcrBrandId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tcrbrandid"},"tcrCampaignId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tcrcampaignid"},"termsAndConditionsLink":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Termsandconditionslink"},"vertical":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vertical"},"webhookFailoverURL":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Webhookfailoverurl"},"webhookURL":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Webhookurl"}},"additionalProperties":true,"type":"object","required":["brandId","campaignId","cspId","description","mock","subUsecases","termsAndConditions","usecase"],"title":"CampaignRegistrationResponse"},"CampaignUpdateRequest":{"properties":{"help_message":{"anyOf":[{"type":"string","maxLength":320,"minLength":20},{"type":"null"}],"title":"Help Message"},"message_flow":{"anyOf":[{"type":"string","maxLength":2048,"minLength":40},{"type":"null"}],"title":"Message Flow"},"sample1":{"anyOf":[{"type":"string","maxLength":320,"minLength":20},{"type":"null"}],"title":"Sample1"},"sample2":{"anyOf":[{"type":"string","maxLength":320,"minLength":20},{"type":"null"}],"title":"Sample2"},"sample3":{"anyOf":[{"type":"string","maxLength":320,"minLength":20},{"type":"null"}],"title":"Sample3"},"sample4":{"anyOf":[{"type":"string","maxLength":320,"minLength":20},{"type":"null"}],"title":"Sample4"},"sample5":{"anyOf":[{"type":"string","maxLength":320,"minLength":20},{"type":"null"}],"title":"Sample5"}},"additionalProperties":false,"type":"object","title":"CampaignUpdateRequest"},"CampaignUseCase":{"type":"string","enum":["ACCOUNT_NOTIFICATION","AGENTS_FRANCHISES","CARRIER_EXEMPT","CHARITY","CUSTOMER_CARE","DELIVERY_NOTIFICATION","EMERGENCY","FRAUD_ALERT","HIGHER_EDUCATION","K12_EDUCATION","LOW_VOLUME","MARKETING","MIXED","POLITICAL","POLLING_VOTING","PROXY","PUBLIC_SAFETY_RESTRICTED","PUBLIC_SERVICE_ANNOUNCEMENT","SECURITY_ALERT","SOCIAL","SWEEPSTAKE","2FA","UCAAS_LOW","M2M","SOLE_PROPRIETOR","TRIAL","UCAAS_HIGH"],"title":"CampaignUseCase"},"RegistryFailureReason":{"properties":{"fields":{"items":{"type":"string"},"type":"array","title":"Fields"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"}},"additionalProperties":true,"type":"object","title":"RegistryFailureReason"},"ListWebhookDeliveriesResponse":{"properties":{"deliveries":{"items":{"$ref":"#/components/schemas/WebhookDeliveryResponse"},"type":"array","title":"Deliveries"}},"type":"object","required":["deliveries"],"title":"ListWebhookDeliveriesResponse"},"ListWebhookDestinationsResponse":{"properties":{"destinations":{"items":{"$ref":"#/components/schemas/WebhookDestinationRow"},"type":"array","title":"Destinations"}},"type":"object","required":["destinations"],"title":"ListWebhookDestinationsResponse"},"ListWebhookSubscriptionsResponse":{"properties":{"subscriptions":{"items":{"$ref":"#/components/schemas/WebhookSubscriptionResponse"},"type":"array","title":"Subscriptions"}},"type":"object","required":["subscriptions"],"title":"ListWebhookSubscriptionsResponse"},"WebhookContextConfig":{"properties":{"email":{"anyOf":[{"oneOf":[{"$ref":"#/components/schemas/WebhookContextCountConfig"},{"$ref":"#/components/schemas/WebhookContextWindowConfig"}],"discriminator":{"propertyName":"mode","mapping":{"count":"#/components/schemas/WebhookContextCountConfig","window":"#/components/schemas/WebhookContextWindowConfig"}}},{"type":"null"}],"title":"Email"},"texts":{"anyOf":[{"oneOf":[{"$ref":"#/components/schemas/WebhookContextCountConfig"},{"$ref":"#/components/schemas/WebhookContextWindowConfig"}],"discriminator":{"propertyName":"mode","mapping":{"count":"#/components/schemas/WebhookContextCountConfig","window":"#/components/schemas/WebhookContextWindowConfig"}}},{"type":"null"}],"title":"Texts"},"calls":{"anyOf":[{"oneOf":[{"$ref":"#/components/schemas/WebhookContextCountConfig"},{"$ref":"#/components/schemas/WebhookContextWindowConfig"}],"discriminator":{"propertyName":"mode","mapping":{"count":"#/components/schemas/WebhookContextCountConfig","window":"#/components/schemas/WebhookContextWindowConfig"}}},{"type":"null"}],"title":"Calls"}},"additionalProperties":false,"type":"object","title":"WebhookContextConfig"},"WebhookContextCountConfig":{"properties":{"mode":{"type":"string","const":"count","title":"Mode"},"count":{"type":"integer","maximum":50.0,"minimum":1.0,"title":"Count"}},"additionalProperties":false,"type":"object","required":["mode","count"],"title":"WebhookContextCountConfig"},"WebhookContextWindowConfig":{"properties":{"mode":{"type":"string","const":"window","title":"Mode"},"hours":{"type":"integer","maximum":168.0,"minimum":1.0,"title":"Hours"}},"additionalProperties":false,"type":"object","required":["mode","hours"],"title":"WebhookContextWindowConfig"},"WebhookDeliveryResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"organization_id":{"type":"string","title":"Organization Id"},"webhook_subscription_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Webhook Subscription Id","description":"Subscription this delivery targeted; null for incoming-call deliveries."},"phone_number_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Phone Number Id","description":"Phone number for incoming-call deliveries (which have no subscription)."},"event_id":{"type":"string","title":"Event Id","description":"Envelope event id (evt_...), or the call id for incoming-call rows."},"event_type":{"type":"string","title":"Event Type"},"url":{"type":"string","title":"Url"},"request_payload":{"type":"string","title":"Request Payload","description":"Raw signed request body that was delivered."},"response_status":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Response Status","description":"HTTP status returned by the endpoint; null on transport failure."},"response_body":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Body","description":"Truncated response body snippet."},"error_detail":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error Detail","description":"Transport error summary, if any."},"duration_ms":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Duration Ms"},"is_replay":{"type":"boolean","title":"Is Replay","description":"True if this row was produced by a manual replay."},"created_at":{"type":"string","format":"date-time","title":"Created At"}},"type":"object","required":["id","organization_id","event_id","event_type","url","request_payload","is_replay","created_at"],"title":"WebhookDeliveryResponse"},"WebhookDestinationRow":{"properties":{"resource_type":{"$ref":"#/components/schemas/WebhookDestinationResourceType"},"resource_id":{"type":"string","format":"uuid","title":"Resource Id"},"resource_label":{"type":"string","title":"Resource Label","description":"Human-readable resource identifier such as email address or phone number"},"resource_created_at":{"type":"string","format":"date-time","title":"Resource Created At"},"destination_type":{"$ref":"#/components/schemas/WebhookDestinationType"},"url":{"type":"string","title":"Url"},"identity_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Identity Id"}},"type":"object","required":["resource_type","resource_id","resource_label","resource_created_at","destination_type","url"],"title":"WebhookDestinationRow"},"WebhookDestinationType":{"type":"string","enum":["mail","phone_call","phone_text","imessage","phone_call_lifecycle","a2a"],"title":"WebhookDestinationType"},"WebhookSubscriptionCreateRequest":{"properties":{"mailbox_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Mailbox Id"},"phone_number_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Phone Number Id"},"agent_identity_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Agent Identity Id"},"url":{"type":"string","title":"Url"},"event_types":{"items":{"anyOf":[{"$ref":"#/components/schemas/MailWebhookEventType"},{"$ref":"#/components/schemas/PhoneTextWebhookEventType"},{"$ref":"#/components/schemas/PhoneCallLifecycleWebhookEventType"},{"$ref":"#/components/schemas/IMessageWebhookEventType"},{"$ref":"#/components/schemas/A2AWebhookEventType"}]},"type":"array","minItems":1,"title":"Event Types"},"context_config":{"anyOf":[{"$ref":"#/components/schemas/WebhookContextConfig"},{"type":"null"}],"description":"Optional per-class conversation context (email/texts/calls) included in received-event payloads. Omit or null for none."},"auth_token":{"anyOf":[{"type":"string","maxLength":4096,"minLength":8},{"type":"null"}],"title":"Auth Token","description":"Optional bearer token for endpoints that require it; sent as 'Authorization: Bearer <token>' on every delivery and returned on subscription reads."}},"additionalProperties":false,"type":"object","required":["url","event_types"],"title":"WebhookSubscriptionCreateRequest"},"WebhookSubscriptionCreateResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"organization_id":{"type":"string","title":"Organization Id"},"mailbox_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Mailbox Id"},"phone_number_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Phone Number Id"},"agent_identity_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Agent Identity Id"},"owner_identity_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Owner Identity Id"},"url":{"type":"string","title":"Url"},"event_types":{"items":{"anyOf":[{"$ref":"#/components/schemas/MailWebhookEventType"},{"$ref":"#/components/schemas/PhoneTextWebhookEventType"},{"$ref":"#/components/schemas/PhoneCallLifecycleWebhookEventType"},{"$ref":"#/components/schemas/IMessageWebhookEventType"},{"$ref":"#/components/schemas/A2AWebhookEventType"}]},"type":"array","title":"Event Types"},"context_config":{"anyOf":[{"$ref":"#/components/schemas/WebhookContextConfig"},{"type":"null"}]},"auth_token":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Auth Token"},"has_auth_token":{"type":"boolean","title":"Has Auth Token","default":false},"status":{"$ref":"#/components/schemas/WebhookSubscriptionStatus"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"signing_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Signing Key"}},"type":"object","required":["id","organization_id","mailbox_id","phone_number_id","url","event_types","status","created_at","updated_at"],"title":"WebhookSubscriptionCreateResponse"},"WebhookSubscriptionResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"organization_id":{"type":"string","title":"Organization Id"},"mailbox_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Mailbox Id"},"phone_number_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Phone Number Id"},"agent_identity_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Agent Identity Id"},"owner_identity_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Owner Identity Id"},"url":{"type":"string","title":"Url"},"event_types":{"items":{"anyOf":[{"$ref":"#/components/schemas/MailWebhookEventType"},{"$ref":"#/components/schemas/PhoneTextWebhookEventType"},{"$ref":"#/components/schemas/PhoneCallLifecycleWebhookEventType"},{"$ref":"#/components/schemas/IMessageWebhookEventType"},{"$ref":"#/components/schemas/A2AWebhookEventType"}]},"type":"array","title":"Event Types"},"context_config":{"anyOf":[{"$ref":"#/components/schemas/WebhookContextConfig"},{"type":"null"}]},"auth_token":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Auth Token"},"has_auth_token":{"type":"boolean","title":"Has Auth Token","default":false},"status":{"$ref":"#/components/schemas/WebhookSubscriptionStatus"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","organization_id","mailbox_id","phone_number_id","url","event_types","status","created_at","updated_at"],"title":"WebhookSubscriptionResponse"},"WebhookSubscriptionStatus":{"type":"string","enum":["active","deleted"],"title":"WebhookSubscriptionStatus"},"WebhookSubscriptionUpdateRequest":{"properties":{"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url"},"event_types":{"anyOf":[{"items":{"anyOf":[{"$ref":"#/components/schemas/MailWebhookEventType"},{"$ref":"#/components/schemas/PhoneTextWebhookEventType"},{"$ref":"#/components/schemas/PhoneCallLifecycleWebhookEventType"},{"$ref":"#/components/schemas/IMessageWebhookEventType"},{"$ref":"#/components/schemas/A2AWebhookEventType"}]},"type":"array","minItems":1},{"type":"null"}],"title":"Event Types"},"context_config":{"anyOf":[{"$ref":"#/components/schemas/WebhookContextConfig"},{"type":"null"}]},"auth_token":{"anyOf":[{"type":"string","maxLength":4096,"minLength":8},{"type":"null"}],"title":"Auth Token"}},"additionalProperties":false,"type":"object","title":"WebhookSubscriptionUpdateRequest"},"CallCorrespondenceItem":{"properties":{"source_id":{"type":"string","format":"uuid","title":"Source Id"},"direction":{"type":"string","enum":["inbound","outbound"],"title":"Direction"},"occurred_at":{"type":"string","format":"date-time","title":"Occurred At"},"identity_id":{"type":"string","format":"uuid","title":"Identity Id"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"detail_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Detail Url"},"channel":{"type":"string","const":"calls","title":"Channel","default":"calls"},"remote_phone_number":{"type":"string","title":"Remote Phone Number"},"local_phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Local Phone Number"},"started_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Started At"},"ended_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Ended At"},"duration_seconds":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Duration Seconds"},"transcript":{"anyOf":[{"items":{"$ref":"#/components/schemas/CorrespondenceTranscriptEntry"},"type":"array"},{"type":"null"}],"title":"Transcript"},"transcript_abridged":{"type":"boolean","title":"Transcript Abridged","default":false},"transcript_unavailable":{"type":"boolean","title":"Transcript Unavailable","default":false}},"type":"object","required":["source_id","direction","occurred_at","identity_id","remote_phone_number"],"title":"CallCorrespondenceItem"},"ContactAccessGrantRequest":{"properties":{"identity_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Identity Id"}},"additionalProperties":false,"type":"object","title":"ContactAccessGrantRequest"},"ContactAccessResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"contact_id":{"type":"string","format":"uuid","title":"Contact Id"},"identity_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Identity Id"},"created_at":{"type":"string","format":"date-time","title":"Created At"}},"type":"object","required":["id","contact_id","identity_id","created_at"],"title":"ContactAccessResponse"},"ContactAddressItem":{"properties":{"street":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Street"},"city":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"City"},"region":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"Region"},"postal":{"anyOf":[{"type":"string","maxLength":32},{"type":"null"}],"title":"Postal"},"country":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Country"},"label":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Label"}},"type":"object","title":"ContactAddressItem"},"ContactBulkDeleteRequest":{"properties":{"contact_ids":{"items":{"type":"string","format":"uuid"},"type":"array","maxItems":1000,"minItems":1,"title":"Contact Ids"}},"type":"object","required":["contact_ids"],"title":"ContactBulkDeleteRequest"},"ContactBulkDeleteResponse":{"properties":{"deleted_count":{"type":"integer","title":"Deleted Count"},"error_count":{"type":"integer","title":"Error Count"},"results":{"items":{"$ref":"#/components/schemas/ContactBulkDeleteResponseItem"},"type":"array","title":"Results"}},"type":"object","required":["deleted_count","error_count","results"],"title":"ContactBulkDeleteResponse"},"ContactBulkDeleteResponseItem":{"properties":{"contact_id":{"type":"string","format":"uuid","title":"Contact Id"},"status":{"type":"string","enum":["deleted","error"],"title":"Status"},"error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error"}},"type":"object","required":["contact_id","status"],"title":"ContactBulkDeleteResponseItem"},"ContactCorrespondenceResponse":{"properties":{"contact_id":{"type":"string","format":"uuid","title":"Contact Id"},"identity_id":{"type":"string","format":"uuid","title":"Identity Id"},"items":{"items":{"oneOf":[{"$ref":"#/components/schemas/EmailCorrespondenceItem"},{"$ref":"#/components/schemas/SmsCorrespondenceItem"},{"$ref":"#/components/schemas/IMessageCorrespondenceItem"},{"$ref":"#/components/schemas/CallCorrespondenceItem"}],"discriminator":{"propertyName":"channel","mapping":{"calls":"#/components/schemas/CallCorrespondenceItem","email":"#/components/schemas/EmailCorrespondenceItem","imessage":"#/components/schemas/IMessageCorrespondenceItem","sms":"#/components/schemas/SmsCorrespondenceItem"}}},"type":"array","title":"Items"},"channels":{"items":{"$ref":"#/components/schemas/CorrespondenceChannelResult"},"type":"array","title":"Channels"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor"}},"type":"object","required":["contact_id","identity_id","items","channels"],"title":"ContactCorrespondenceResponse"},"ContactCreate":{"properties":{"preferred_name":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Preferred Name"},"name_prefix":{"anyOf":[{"type":"string","maxLength":32},{"type":"null"}],"title":"Name Prefix"},"given_name":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"Given Name"},"middle_name":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"Middle Name"},"family_name":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"Family Name"},"name_suffix":{"anyOf":[{"type":"string","maxLength":32},{"type":"null"}],"title":"Name Suffix"},"company_name":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Company Name"},"job_title":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Job Title"},"birthday":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Birthday"},"notes":{"anyOf":[{"type":"string","maxLength":2000},{"type":"null"}],"title":"Notes"},"emails":{"items":{"$ref":"#/components/schemas/ContactEmailItem"},"type":"array","maxItems":50,"title":"Emails"},"phones":{"items":{"$ref":"#/components/schemas/ContactPhoneItemRequest"},"type":"array","maxItems":50,"title":"Phones"},"websites":{"items":{"$ref":"#/components/schemas/ContactWebsiteItem"},"type":"array","maxItems":25,"title":"Websites"},"dates":{"items":{"$ref":"#/components/schemas/ContactDateItem"},"type":"array","maxItems":25,"title":"Dates"},"addresses":{"items":{"$ref":"#/components/schemas/ContactAddressItem"},"type":"array","maxItems":10,"title":"Addresses"},"custom_fields":{"items":{"$ref":"#/components/schemas/ContactCustomFieldItem"},"type":"array","maxItems":50,"title":"Custom Fields"},"access_identity_ids":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array","maxItems":500},{"type":"null"}],"title":"Access Identity Ids","description":"Deprecated. Contacts are organization-wide; requests that supply this field are rejected."}},"type":"object","title":"ContactCreate"},"ContactCreationSource":{"type":"string","enum":["manual","vcard","communication","backfill"],"title":"ContactCreationSource"},"ContactCustomFieldItem":{"properties":{"label":{"type":"string","maxLength":128,"title":"Label"},"value":{"type":"string","maxLength":1024,"title":"Value"}},"type":"object","required":["label","value"],"title":"ContactCustomFieldItem"},"ContactDateItem":{"properties":{"date":{"type":"string","format":"date","title":"Date"},"label":{"type":"string","maxLength":64,"title":"Label"}},"type":"object","required":["date","label"],"title":"ContactDateItem"},"ContactEmailItem":{"properties":{"value":{"type":"string","format":"email","title":"Value"},"label":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Label"},"is_primary":{"type":"boolean","title":"Is Primary","default":false}},"type":"object","required":["value"],"title":"ContactEmailItem"},"ContactFactCitationDetailResponse":{"properties":{"source_type":{"type":"string","title":"Source Type"},"source_id":{"type":"string","format":"uuid","title":"Source Id"},"source_locator":{"additionalProperties":true,"type":"object","title":"Source Locator"},"source_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Url"}},"type":"object","required":["source_type","source_id","source_locator"],"title":"ContactFactCitationDetailResponse"},"ContactFactCitationResponse":{"properties":{"source_type":{"type":"string","title":"Source Type"},"availability":{"type":"string","enum":["available","purged","source_unavailable_to_caller"],"title":"Availability"},"source_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Source Id"},"source_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Url"},"source_locator":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Source Locator"}},"type":"object","required":["source_type","availability"],"title":"ContactFactCitationResponse"},"ContactFactCreate":{"properties":{"content":{"type":"string","maxLength":500,"minLength":1,"title":"Content"},"kind":{"type":"string","enum":["profile","preference","context"],"title":"Kind"}},"type":"object","required":["content","kind"],"title":"ContactFactCreate"},"ContactFactDeleteResponse":{"properties":{"deleted_fact_id":{"type":"string","format":"uuid","title":"Deleted Fact Id"},"memory_count":{"type":"integer","minimum":0.0,"title":"Memory Count"},"latest_memory":{"anyOf":[{"$ref":"#/components/schemas/ContactMemorySummary"},{"type":"null"}]}},"type":"object","required":["deleted_fact_id","memory_count","latest_memory"],"title":"ContactFactDeleteResponse"},"ContactFactResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"contact_id":{"type":"string","format":"uuid","title":"Contact Id"},"content":{"type":"string","title":"Content"},"confidence":{"anyOf":[{"type":"string","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$"},{"type":"null"}],"title":"Confidence"},"origin":{"type":"string","enum":["generated","user"],"title":"Origin"},"kind":{"anyOf":[{"type":"string","enum":["profile","preference","context"]},{"type":"null"}],"title":"Kind"},"expires_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expires At"},"locked_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Locked At"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"citations":{"items":{"$ref":"#/components/schemas/ContactFactCitationResponse"},"type":"array","title":"Citations"}},"type":"object","required":["id","contact_id","content","confidence","origin","locked_at","created_at","updated_at"],"title":"ContactFactResponse"},"ContactFactUpdate":{"properties":{"content":{"anyOf":[{"type":"string","maxLength":500,"minLength":1},{"type":"null"}],"title":"Content"},"kind":{"anyOf":[{"type":"string","enum":["profile","preference","context"]},{"type":"null"}],"title":"Kind"}},"type":"object","title":"ContactFactUpdate"},"ContactImportConflict":{"properties":{"index":{"type":"integer","minimum":0.0,"title":"Index"},"contact_ids":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Contact Ids"}},"type":"object","required":["index","contact_ids"],"title":"ContactImportConflict"},"ContactImportPreviewRequest":{"properties":{"vcard":{"type":"string","maxLength":10485760,"minLength":1,"title":"Vcard"}},"type":"object","required":["vcard"],"title":"ContactImportPreviewRequest"},"ContactImportPreviewResponse":{"properties":{"contact_count":{"type":"integer","maximum":2500.0,"minimum":1.0,"title":"Contact Count"},"conflicts":{"items":{"$ref":"#/components/schemas/ContactImportConflict"},"type":"array","title":"Conflicts"},"payload_hash":{"type":"string","pattern":"^[a-f0-9]{64}$","title":"Payload Hash"},"preview_hash":{"type":"string","pattern":"^[a-f0-9]{64}$","title":"Preview Hash"}},"type":"object","required":["contact_count","conflicts","payload_hash","preview_hash"],"title":"ContactImportPreviewResponse"},"ContactImportResponse":{"properties":{"created_count":{"type":"integer","title":"Created Count"},"error_count":{"type":"integer","title":"Error Count"},"results":{"items":{"$ref":"#/components/schemas/ContactImportResponseItem"},"type":"array","title":"Results"}},"type":"object","required":["created_count","error_count","results"],"title":"ContactImportResponse"},"ContactImportResponseItem":{"properties":{"index":{"type":"integer","title":"Index"},"status":{"type":"string","enum":["created","conflict","error"],"title":"Status"},"contact":{"anyOf":[{"$ref":"#/components/schemas/ContactResponse"},{"type":"null"}]},"error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error"},"conflicting_contact_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Conflicting Contact Id"}},"type":"object","required":["index","status"],"title":"ContactImportResponseItem"},"ContactListResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"organization_id":{"type":"string","title":"Organization Id"},"preferred_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Preferred Name"},"name_prefix":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name Prefix"},"given_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Given Name"},"middle_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Middle Name"},"family_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Family Name"},"name_suffix":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name Suffix"},"company_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Name"},"job_title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Job Title"},"birthday":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Birthday"},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notes"},"emails":{"items":{"$ref":"#/components/schemas/ContactEmailItem"},"type":"array","title":"Emails"},"phones":{"items":{"$ref":"#/components/schemas/ContactPhoneItemResponse"},"type":"array","title":"Phones"},"websites":{"items":{"$ref":"#/components/schemas/ContactWebsiteItem"},"type":"array","title":"Websites"},"dates":{"items":{"$ref":"#/components/schemas/ContactDateItem"},"type":"array","title":"Dates"},"addresses":{"items":{"$ref":"#/components/schemas/ContactAddressItem"},"type":"array","title":"Addresses"},"custom_fields":{"items":{"$ref":"#/components/schemas/ContactCustomFieldItem"},"type":"array","title":"Custom Fields"},"creation_source":{"$ref":"#/components/schemas/ContactCreationSource"},"review_status":{"$ref":"#/components/schemas/ContactReviewStatus"},"reviewed_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Reviewed At"},"reviewed_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reviewed By"},"preferred_name_source":{"$ref":"#/components/schemas/ContactNameSource"},"preferred_name_locked_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Preferred Name Locked At"},"created_by_identity_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Created By Identity Id"},"merged_into_contact_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Merged Into Contact Id"},"is_auto_created":{"type":"boolean","title":"Is Auto Created"},"is_confirmed":{"type":"boolean","title":"Is Confirmed"},"status":{"$ref":"#/components/schemas/ResourceStatus"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"access":{"items":{"$ref":"#/components/schemas/ContactAccessResponse"},"type":"array","title":"Access","description":"Raw ``contact_access`` rows for this contact, inlined so the console can skip a follow-up ``GET /contacts/{id}/access`` per row. Either a single wildcard row (``identity_id=null``), an explicit per-identity list, or empty when the contact has zero grants (human-only via ``access_identity_ids=[]``). Always populated by the list and single-contact read paths; empty does not mean 'not loaded'."},"memory_count":{"type":"integer","minimum":0.0,"title":"Memory Count"},"latest_memory":{"anyOf":[{"$ref":"#/components/schemas/ContactMemorySummary"},{"type":"null"}]}},"type":"object","required":["id","organization_id","preferred_name","name_prefix","given_name","middle_name","family_name","name_suffix","company_name","job_title","birthday","notes","emails","phones","websites","dates","addresses","custom_fields","creation_source","review_status","reviewed_at","reviewed_by","preferred_name_source","preferred_name_locked_at","created_by_identity_id","merged_into_contact_id","is_auto_created","is_confirmed","status","created_at","updated_at","memory_count","latest_memory"],"title":"ContactListResponse"},"ContactMemorySummary":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"content":{"type":"string","title":"Content"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","content","updated_at"],"title":"ContactMemorySummary"},"ContactMergeRequest":{"properties":{"losing_contact_ids":{"items":{"type":"string","format":"uuid"},"type":"array","maxItems":100,"minItems":1,"title":"Losing Contact Ids"},"field_sources":{"additionalProperties":{"type":"string","format":"uuid"},"type":"object","title":"Field Sources"}},"additionalProperties":false,"type":"object","required":["losing_contact_ids"],"title":"ContactMergeRequest"},"ContactMutationResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"organization_id":{"type":"string","title":"Organization Id"},"preferred_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Preferred Name"},"name_prefix":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name Prefix"},"given_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Given Name"},"middle_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Middle Name"},"family_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Family Name"},"name_suffix":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name Suffix"},"company_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Name"},"job_title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Job Title"},"birthday":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Birthday"},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notes"},"emails":{"items":{"$ref":"#/components/schemas/ContactEmailItem"},"type":"array","title":"Emails"},"phones":{"items":{"$ref":"#/components/schemas/ContactPhoneItemResponse"},"type":"array","title":"Phones"},"websites":{"items":{"$ref":"#/components/schemas/ContactWebsiteItem"},"type":"array","title":"Websites"},"dates":{"items":{"$ref":"#/components/schemas/ContactDateItem"},"type":"array","title":"Dates"},"addresses":{"items":{"$ref":"#/components/schemas/ContactAddressItem"},"type":"array","title":"Addresses"},"custom_fields":{"items":{"$ref":"#/components/schemas/ContactCustomFieldItem"},"type":"array","title":"Custom Fields"},"creation_source":{"$ref":"#/components/schemas/ContactCreationSource"},"review_status":{"$ref":"#/components/schemas/ContactReviewStatus"},"reviewed_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Reviewed At"},"reviewed_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reviewed By"},"preferred_name_source":{"$ref":"#/components/schemas/ContactNameSource"},"preferred_name_locked_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Preferred Name Locked At"},"created_by_identity_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Created By Identity Id"},"merged_into_contact_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Merged Into Contact Id"},"is_auto_created":{"type":"boolean","title":"Is Auto Created"},"is_confirmed":{"type":"boolean","title":"Is Confirmed"},"status":{"$ref":"#/components/schemas/ResourceStatus"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"access":{"items":{"$ref":"#/components/schemas/ContactAccessResponse"},"type":"array","title":"Access","description":"Raw ``contact_access`` rows for this contact, inlined so the console can skip a follow-up ``GET /contacts/{id}/access`` per row. Either a single wildcard row (``identity_id=null``), an explicit per-identity list, or empty when the contact has zero grants (human-only via ``access_identity_ids=[]``). Always populated by the list and single-contact read paths; empty does not mean 'not loaded'."},"memory_count":{"type":"integer","minimum":0.0,"title":"Memory Count"},"latest_memory":{"anyOf":[{"$ref":"#/components/schemas/ContactMemorySummary"},{"type":"null"}]}},"type":"object","required":["id","organization_id","preferred_name","name_prefix","given_name","middle_name","family_name","name_suffix","company_name","job_title","birthday","notes","emails","phones","websites","dates","addresses","custom_fields","creation_source","review_status","reviewed_at","reviewed_by","preferred_name_source","preferred_name_locked_at","created_by_identity_id","merged_into_contact_id","is_auto_created","is_confirmed","status","created_at","updated_at","memory_count","latest_memory"],"title":"ContactMutationResponse"},"ContactNameSource":{"type":"string","enum":["manual","vcard","provider","mail_header","identifier_fallback"],"title":"ContactNameSource"},"ContactPhoneItemRequest":{"properties":{"value_e164":{"type":"string","title":"Value E164","description":"Phone number in E.164 format (e.g. '+15551234567').","examples":["+15551234567"]},"label":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Label"},"is_primary":{"type":"boolean","title":"Is Primary","default":false}},"type":"object","required":["value_e164"],"title":"ContactPhoneItemRequest"},"ContactPhoneItemResponse":{"properties":{"value_e164":{"type":"string","title":"Value E164"},"label":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Label"},"is_primary":{"type":"boolean","title":"Is Primary","default":false}},"type":"object","required":["value_e164"],"title":"ContactPhoneItemResponse"},"ContactResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"organization_id":{"type":"string","title":"Organization Id"},"preferred_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Preferred Name"},"name_prefix":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name Prefix"},"given_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Given Name"},"middle_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Middle Name"},"family_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Family Name"},"name_suffix":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name Suffix"},"company_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Name"},"job_title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Job Title"},"birthday":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Birthday"},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notes"},"emails":{"items":{"$ref":"#/components/schemas/ContactEmailItem"},"type":"array","title":"Emails"},"phones":{"items":{"$ref":"#/components/schemas/ContactPhoneItemResponse"},"type":"array","title":"Phones"},"websites":{"items":{"$ref":"#/components/schemas/ContactWebsiteItem"},"type":"array","title":"Websites"},"dates":{"items":{"$ref":"#/components/schemas/ContactDateItem"},"type":"array","title":"Dates"},"addresses":{"items":{"$ref":"#/components/schemas/ContactAddressItem"},"type":"array","title":"Addresses"},"custom_fields":{"items":{"$ref":"#/components/schemas/ContactCustomFieldItem"},"type":"array","title":"Custom Fields"},"creation_source":{"$ref":"#/components/schemas/ContactCreationSource"},"review_status":{"$ref":"#/components/schemas/ContactReviewStatus"},"reviewed_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Reviewed At"},"reviewed_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reviewed By"},"preferred_name_source":{"$ref":"#/components/schemas/ContactNameSource"},"preferred_name_locked_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Preferred Name Locked At"},"created_by_identity_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Created By Identity Id"},"merged_into_contact_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Merged Into Contact Id"},"is_auto_created":{"type":"boolean","title":"Is Auto Created"},"is_confirmed":{"type":"boolean","title":"Is Confirmed"},"status":{"$ref":"#/components/schemas/ResourceStatus"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"access":{"items":{"$ref":"#/components/schemas/ContactAccessResponse"},"type":"array","title":"Access","description":"Raw ``contact_access`` rows for this contact, inlined so the console can skip a follow-up ``GET /contacts/{id}/access`` per row. Either a single wildcard row (``identity_id=null``), an explicit per-identity list, or empty when the contact has zero grants (human-only via ``access_identity_ids=[]``). Always populated by the list and single-contact read paths; empty does not mean 'not loaded'."}},"type":"object","required":["id","organization_id","preferred_name","name_prefix","given_name","middle_name","family_name","name_suffix","company_name","job_title","birthday","notes","emails","phones","websites","dates","addresses","custom_fields","creation_source","review_status","reviewed_at","reviewed_by","preferred_name_source","preferred_name_locked_at","created_by_identity_id","merged_into_contact_id","is_auto_created","is_confirmed","status","created_at","updated_at"],"title":"ContactResponse"},"ContactReviewStatus":{"type":"string","enum":["unreviewed","confirmed"],"title":"ContactReviewStatus"},"ContactUpdate":{"properties":{"preferred_name":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Preferred Name"},"name_prefix":{"anyOf":[{"type":"string","maxLength":32},{"type":"null"}],"title":"Name Prefix"},"given_name":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"Given Name"},"middle_name":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"Middle Name"},"family_name":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"Family Name"},"name_suffix":{"anyOf":[{"type":"string","maxLength":32},{"type":"null"}],"title":"Name Suffix"},"company_name":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Company Name"},"job_title":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Job Title"},"birthday":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Birthday"},"notes":{"anyOf":[{"type":"string","maxLength":2000},{"type":"null"}],"title":"Notes"},"emails":{"anyOf":[{"items":{"$ref":"#/components/schemas/ContactEmailItem"},"type":"array","maxItems":50},{"type":"null"}],"title":"Emails"},"phones":{"anyOf":[{"items":{"$ref":"#/components/schemas/ContactPhoneItemRequest"},"type":"array","maxItems":50},{"type":"null"}],"title":"Phones"},"websites":{"anyOf":[{"items":{"$ref":"#/components/schemas/ContactWebsiteItem"},"type":"array","maxItems":25},{"type":"null"}],"title":"Websites"},"dates":{"anyOf":[{"items":{"$ref":"#/components/schemas/ContactDateItem"},"type":"array","maxItems":25},{"type":"null"}],"title":"Dates"},"addresses":{"anyOf":[{"items":{"$ref":"#/components/schemas/ContactAddressItem"},"type":"array","maxItems":10},{"type":"null"}],"title":"Addresses"},"custom_fields":{"anyOf":[{"items":{"$ref":"#/components/schemas/ContactCustomFieldItem"},"type":"array","maxItems":50},{"type":"null"}],"title":"Custom Fields"},"review_status":{"anyOf":[{"$ref":"#/components/schemas/ContactReviewStatus"},{"type":"null"}]}},"type":"object","title":"ContactUpdate"},"ContactVCardExportRequest":{"properties":{"contact_ids":{"items":{"type":"string","format":"uuid"},"type":"array","maxItems":25,"minItems":1,"title":"Contact Ids"}},"type":"object","required":["contact_ids"],"title":"ContactVCardExportRequest"},"ContactVCardExportResponse":{"properties":{"content_type":{"type":"string","const":"text/vcard; charset=utf-8","title":"Content Type"},"contact_count":{"type":"integer","maximum":25.0,"minimum":1.0,"title":"Contact Count"},"vcard":{"type":"string","maxLength":1000000,"title":"Vcard"}},"type":"object","required":["content_type","contact_count","vcard"],"title":"ContactVCardExportResponse"},"ContactWebsiteItem":{"properties":{"url":{"type":"string","maxLength":2048,"pattern":"^https?://","title":"Url"},"label":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Label"}},"type":"object","required":["url"],"title":"ContactWebsiteItem"},"CorrespondenceAttachmentMetadata":{"properties":{"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Filename"},"content_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Content Type"},"size":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Size"}},"type":"object","title":"CorrespondenceAttachmentMetadata"},"CorrespondenceChannel":{"type":"string","enum":["email","sms","imessage","calls"],"title":"CorrespondenceChannel"},"CorrespondenceChannelResult":{"properties":{"channel":{"$ref":"#/components/schemas/CorrespondenceChannel"},"status":{"$ref":"#/components/schemas/CorrespondenceChannelStatus"},"returned":{"type":"integer","minimum":0.0,"title":"Returned"}},"type":"object","required":["channel","status","returned"],"title":"CorrespondenceChannelResult"},"CorrespondenceChannelStatus":{"type":"string","enum":["available","no_identifier","no_resource"],"title":"CorrespondenceChannelStatus"},"CorrespondenceContentMode":{"type":"string","enum":["metadata","preview","full"],"title":"CorrespondenceContentMode"},"CorrespondenceMediaMetadata":{"properties":{"count":{"type":"integer","minimum":0.0,"title":"Count"}},"type":"object","required":["count"],"title":"CorrespondenceMediaMetadata"},"CorrespondenceOrder":{"type":"string","enum":["asc","desc"],"title":"CorrespondenceOrder"},"CorrespondenceTranscriptEntry":{"properties":{"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id"},"seq":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Seq"},"party":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Party"},"text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Text"},"ts_ms":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Ts Ms"},"marker":{"anyOf":[{"type":"string","const":"abridged"},{"type":"null"}],"title":"Marker"},"omitted_turns":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Omitted Turns"},"omitted_ms":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Omitted Ms"}},"type":"object","title":"CorrespondenceTranscriptEntry"},"CorrespondenceTranscriptMode":{"type":"string","enum":["none","abridged","full"],"title":"CorrespondenceTranscriptMode"},"EmailCorrespondenceItem":{"properties":{"source_id":{"type":"string","format":"uuid","title":"Source Id"},"direction":{"type":"string","enum":["inbound","outbound"],"title":"Direction"},"occurred_at":{"type":"string","format":"date-time","title":"Occurred At"},"identity_id":{"type":"string","format":"uuid","title":"Identity Id"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"detail_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Detail Url"},"channel":{"type":"string","const":"email","title":"Channel","default":"email"},"mailbox_email":{"type":"string","title":"Mailbox Email"},"thread_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Thread Id"},"from_address":{"type":"string","title":"From Address"},"to_addresses":{"items":{"type":"string"},"type":"array","title":"To Addresses"},"cc_addresses":{"items":{"type":"string"},"type":"array","title":"Cc Addresses"},"bcc_addresses":{"items":{"type":"string"},"type":"array","title":"Bcc Addresses"},"subject":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subject"},"snippet":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Snippet"},"body_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Body Text"},"content_unavailable":{"type":"boolean","title":"Content Unavailable","default":false},"attachments":{"items":{"$ref":"#/components/schemas/CorrespondenceAttachmentMetadata"},"type":"array","title":"Attachments"}},"type":"object","required":["source_id","direction","occurred_at","identity_id","mailbox_email","from_address","to_addresses"],"title":"EmailCorrespondenceItem"},"IMessageCorrespondenceItem":{"properties":{"source_id":{"type":"string","format":"uuid","title":"Source Id"},"direction":{"type":"string","enum":["inbound","outbound"],"title":"Direction"},"occurred_at":{"type":"string","format":"date-time","title":"Occurred At"},"identity_id":{"type":"string","format":"uuid","title":"Identity Id"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"detail_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Detail Url"},"channel":{"type":"string","const":"imessage","title":"Channel","default":"imessage"},"conversation_id":{"type":"string","format":"uuid","title":"Conversation Id"},"remote_handle":{"type":"string","title":"Remote Handle"},"sender_handle":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sender Handle"},"participants":{"items":{"type":"string"},"type":"array","title":"Participants"},"is_group":{"type":"boolean","title":"Is Group","default":false},"service":{"type":"string","title":"Service"},"text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Text"},"media":{"anyOf":[{"$ref":"#/components/schemas/CorrespondenceMediaMetadata"},{"type":"null"}]}},"type":"object","required":["source_id","direction","occurred_at","identity_id","conversation_id","remote_handle","service"],"title":"IMessageCorrespondenceItem"},"ResourceStatus":{"type":"string","enum":["active","paused","deleted"],"title":"ResourceStatus"},"SmsCorrespondenceItem":{"properties":{"source_id":{"type":"string","format":"uuid","title":"Source Id"},"direction":{"type":"string","enum":["inbound","outbound"],"title":"Direction"},"occurred_at":{"type":"string","format":"date-time","title":"Occurred At"},"identity_id":{"type":"string","format":"uuid","title":"Identity Id"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"detail_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Detail Url"},"channel":{"type":"string","const":"sms","title":"Channel","default":"sms"},"conversation_id":{"type":"string","format":"uuid","title":"Conversation Id"},"local_resource_id":{"type":"string","format":"uuid","title":"Local Resource Id"},"local_phone_number":{"type":"string","title":"Local Phone Number"},"sender_phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sender Phone Number"},"participants":{"items":{"type":"string"},"type":"array","title":"Participants"},"matched_contact_phone":{"type":"string","title":"Matched Contact Phone"},"is_group":{"type":"boolean","title":"Is Group"},"text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Text"},"media":{"anyOf":[{"$ref":"#/components/schemas/CorrespondenceMediaMetadata"},{"type":"null"}]}},"type":"object","required":["source_id","direction","occurred_at","identity_id","conversation_id","local_resource_id","local_phone_number","participants","matched_contact_phone","is_group"],"title":"SmsCorrespondenceItem"},"ApexMxWarning":{"properties":{"current_mx_targets":{"items":{"type":"string"},"type":"array","title":"Current Mx Targets"},"acknowledged":{"type":"boolean","title":"Acknowledged"}},"type":"object","required":["current_mx_targets","acknowledged"],"title":"ApexMxWarning"},"CreateDomainRequest":{"properties":{"domain":{"type":"string","maxLength":255,"minLength":3,"title":"Domain"},"apex_mx_acknowledged":{"type":"boolean","title":"Apex Mx Acknowledged","default":false}},"type":"object","required":["domain"],"title":"CreateDomainRequest"},"CreateDomainResponse":{"properties":{"domain":{"$ref":"#/components/schemas/DomainResponse"},"dns_records":{"items":{"$ref":"#/components/schemas/DnsRecordResponse"},"type":"array","title":"Dns Records"},"apex_mx_warning":{"anyOf":[{"$ref":"#/components/schemas/ApexMxWarning"},{"type":"null"}]},"spf_lookup_report":{"anyOf":[{"$ref":"#/components/schemas/SpfLookupReportResponse"},{"type":"null"}]}},"type":"object","required":["domain","dns_records"],"title":"CreateDomainResponse"},"DnsRecordHealthSummary":{"properties":{"type":{"type":"string","title":"Type"},"host":{"type":"string","title":"Host"},"purpose":{"$ref":"#/components/schemas/DnsRecordPurpose"},"status":{"$ref":"#/components/schemas/DnsRecordStatus"},"required":{"type":"boolean","title":"Required"}},"type":"object","required":["type","host","purpose","status","required"],"title":"DnsRecordHealthSummary"},"DnsRecordPurpose":{"type":"string","enum":["ownership-precheck","verification","dkim","dkim-rotation-pending","mail-from-mx","mail-from-spf","inbound-mx","dmarc"],"title":"DnsRecordPurpose"},"DnsRecordResponse":{"properties":{"type":{"type":"string","title":"Type"},"host":{"type":"string","title":"Host"},"value":{"type":"string","title":"Value"},"ttl":{"type":"integer","title":"Ttl"},"purpose":{"$ref":"#/components/schemas/DnsRecordPurpose"},"status":{"$ref":"#/components/schemas/DnsRecordStatus"},"is_required":{"type":"boolean","title":"Is Required"},"is_inkbox_branded":{"type":"boolean","title":"Is Inkbox Branded"}},"type":"object","required":["type","host","value","ttl","purpose","status","is_required","is_inkbox_branded"],"title":"DnsRecordResponse"},"DnsRecordStatus":{"type":"string","enum":["unknown","ok","missing","mismatch"],"title":"DnsRecordStatus"},"DnsRecordsResponse":{"properties":{"dns_records":{"items":{"$ref":"#/components/schemas/DnsRecordResponse"},"type":"array","title":"Dns Records"}},"type":"object","required":["dns_records"],"title":"DnsRecordsResponse"},"DomainHealthResponse":{"properties":{"domain":{"$ref":"#/components/schemas/DomainHealthSummary"},"dns_records":{"items":{"$ref":"#/components/schemas/DnsRecordHealthSummary"},"type":"array","title":"Dns Records"}},"type":"object","required":["domain","dns_records"],"title":"DomainHealthResponse"},"DomainHealthSummary":{"properties":{"id":{"type":"string","title":"Id"},"domain":{"type":"string","title":"Domain"},"mail_from_subdomain":{"type":"string","title":"Mail From Subdomain"},"is_default":{"type":"boolean","title":"Is Default"},"status":{"$ref":"#/components/schemas/SendingDomainStatus"},"ownership_validated":{"type":"boolean","title":"Ownership Validated"},"verified_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Verified At"},"last_checked_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Checked At"},"degraded_since":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Degraded Since"}},"type":"object","required":["id","domain","mail_from_subdomain","is_default","status","ownership_validated","verified_at","last_checked_at","degraded_since"],"title":"DomainHealthSummary"},"DomainResponse":{"properties":{"id":{"type":"string","title":"Id"},"organization_id":{"type":"string","title":"Organization Id"},"domain":{"type":"string","title":"Domain"},"mail_from_subdomain":{"type":"string","title":"Mail From Subdomain"},"is_default":{"type":"boolean","title":"Is Default"},"status":{"$ref":"#/components/schemas/SendingDomainStatus"},"failure_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Failure Reason"},"verified_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Verified At"},"last_checked_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Checked At"},"dkim_selector":{"type":"string","title":"Dkim Selector"},"ownership_token":{"type":"string","title":"Ownership Token"}},"type":"object","required":["id","organization_id","domain","mail_from_subdomain","is_default","status","failure_reason","verified_at","last_checked_at","dkim_selector","ownership_token"],"title":"DomainResponse"},"DomainWithDnsRecordsResponse":{"properties":{"domain":{"$ref":"#/components/schemas/DomainResponse"},"dns_records":{"items":{"$ref":"#/components/schemas/DnsRecordResponse"},"type":"array","title":"Dns Records"}},"type":"object","required":["domain","dns_records"],"title":"DomainWithDnsRecordsResponse"},"RotateDkimResponse":{"properties":{"domain":{"$ref":"#/components/schemas/DomainResponse"},"new_selector":{"type":"string","title":"New Selector"},"new_dkim_txt_value":{"type":"string","title":"New Dkim Txt Value"}},"type":"object","required":["domain","new_selector","new_dkim_txt_value"],"title":"RotateDkimResponse"},"SendingDomainStatus":{"type":"string","enum":["not_started","awaiting_ownership","pending","dns_invalid","verifying","verified","failed","pending_dkim_rotation","degraded","pending_deletion"],"title":"SendingDomainStatus"},"SetDefaultResponse":{"properties":{"default_domain":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Default Domain","description":"Bare domain name now serving as the org's default for new mailbox creations. ``None`` means no custom default is set and mailboxes fall back to the platform domain."}},"type":"object","required":["default_domain"],"title":"SetDefaultResponse"},"SpfLookupReportResponse":{"properties":{"current":{"type":"integer","title":"Current"},"limit":{"type":"integer","title":"Limit","default":10},"mechanisms":{"items":{"type":"string"},"type":"array","title":"Mechanisms"}},"type":"object","required":["current","mechanisms"],"title":"SpfLookupReportResponse"},"A2ACallerResponse":{"properties":{"identity_id":{"type":"string","format":"uuid","title":"Identity Id"},"organization_id":{"type":"string","title":"Organization Id"},"handle":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Handle"},"trust_tier":{"type":"string","const":"inkbox_verified","title":"Trust Tier","default":"inkbox_verified"}},"type":"object","required":["identity_id","organization_id","handle"],"title":"A2ACallerResponse"},"A2AContactRuleCreate":{"properties":{"action":{"$ref":"#/components/schemas/A2ARuleAction"},"match_type":{"type":"string","const":"handle","title":"Match Type","default":"handle"},"match_target":{"type":"string","title":"Match Target"},"direction":{"type":"string","enum":["inbound","outbound","both"],"title":"Direction","default":"inbound"}},"additionalProperties":false,"type":"object","required":["action","match_target"],"title":"A2AContactRuleCreate"},"A2AContactRuleResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"action":{"$ref":"#/components/schemas/A2ARuleAction"},"match_type":{"$ref":"#/components/schemas/A2ARuleMatchType"},"match_target":{"type":"string","title":"Match Target"},"direction":{"$ref":"#/components/schemas/A2ARuleDirection"},"status":{"$ref":"#/components/schemas/ResourceStatus"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","action","match_type","match_target","direction","status","created_at","updated_at"],"title":"A2AContactRuleResponse"},"A2AContactRuleUpdate":{"properties":{"action":{"anyOf":[{"$ref":"#/components/schemas/A2ARuleAction"},{"type":"null"}]},"direction":{"anyOf":[{"type":"string","enum":["inbound","outbound","both"]},{"type":"null"}],"title":"Direction"}},"additionalProperties":false,"type":"object","title":"A2AContactRuleUpdate"},"A2AContextPage":{"properties":{"items":{"items":{"$ref":"#/components/schemas/A2AContextResponse"},"type":"array","title":"Items"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor"}},"type":"object","required":["items"],"title":"A2AContextPage"},"A2AContextPatchRequest":{"properties":{"name":{"type":"string","title":"Name"}},"additionalProperties":false,"type":"object","required":["name"],"title":"A2AContextPatchRequest"},"A2AContextResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"caller":{"$ref":"#/components/schemas/A2ACallerResponse"},"target":{"$ref":"#/components/schemas/A2ATargetResponse"},"tasks":{"items":{"$ref":"#/components/schemas/A2ATaskResponse"},"type":"array","title":"Tasks"},"tasks_truncated":{"type":"boolean","title":"Tasks Truncated","default":false},"created_at":{"type":"string","format":"date-time","title":"Created At"},"last_activity_at":{"type":"string","format":"date-time","title":"Last Activity At"}},"type":"object","required":["id","name","caller","target","created_at","last_activity_at"],"title":"A2AContextResponse"},"A2ADataPart":{"properties":{"data":{"title":"Data"},"metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metadata"}},"additionalProperties":false,"type":"object","required":["data"],"title":"A2ADataPart"},"A2ADirectoryItem":{"properties":{"card_url":{"type":"string","title":"Card Url"},"card":{"additionalProperties":true,"type":"object","title":"Card"},"visibility":{"$ref":"#/components/schemas/A2ADirectoryVisibility"}},"type":"object","required":["card_url","card","visibility"],"title":"A2ADirectoryItem"},"A2ADirectoryPage":{"properties":{"items":{"items":{"$ref":"#/components/schemas/A2ADirectoryItem"},"type":"array","title":"Items"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor"}},"type":"object","required":["items"],"title":"A2ADirectoryPage"},"A2ADirectoryVisibility":{"type":"string","enum":["organization","public"],"title":"A2ADirectoryVisibility"},"A2AHistoryDirection":{"type":"string","enum":["inbound","outbound","both"],"title":"A2AHistoryDirection"},"A2AHistoryMessagePage":{"properties":{"items":{"items":{"$ref":"#/components/schemas/A2AHistoryMessageResponse"},"type":"array","title":"Items"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor"}},"type":"object","required":["items"],"title":"A2AHistoryMessagePage"},"A2AHistoryMessageResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"message_id":{"type":"string","title":"Message Id"},"role":{"$ref":"#/components/schemas/A2AMessageRole"},"parts":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Parts"},"metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metadata"},"extensions":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Extensions"},"reference_task_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Reference Task Ids"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"task_id":{"type":"string","format":"uuid","title":"Task Id"},"context_id":{"type":"string","format":"uuid","title":"Context Id"},"task_state":{"$ref":"#/components/schemas/A2ATaskState"},"caller":{"$ref":"#/components/schemas/A2ACallerResponse"},"target":{"$ref":"#/components/schemas/A2ATargetResponse"}},"type":"object","required":["id","message_id","role","parts","metadata","extensions","reference_task_ids","created_at","task_id","context_id","task_state","caller","target"],"title":"A2AHistoryMessageResponse"},"A2AIdentityContactRuleResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"action":{"$ref":"#/components/schemas/A2ARuleAction"},"match_type":{"$ref":"#/components/schemas/A2ARuleMatchType"},"match_target":{"type":"string","title":"Match Target"},"direction":{"$ref":"#/components/schemas/A2ARuleDirection"},"status":{"$ref":"#/components/schemas/ResourceStatus"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"agent_identity_id":{"type":"string","format":"uuid","title":"Agent Identity Id"}},"type":"object","required":["id","action","match_type","match_target","direction","status","created_at","updated_at","agent_identity_id"],"title":"A2AIdentityContactRuleResponse"},"A2AMessageResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"message_id":{"type":"string","title":"Message Id"},"role":{"$ref":"#/components/schemas/A2AMessageRole"},"parts":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Parts"},"metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metadata"},"extensions":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Extensions"},"reference_task_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Reference Task Ids"},"created_at":{"type":"string","format":"date-time","title":"Created At"}},"type":"object","required":["id","message_id","role","parts","metadata","extensions","reference_task_ids","created_at"],"title":"A2AMessageResponse"},"A2AMessageRole":{"type":"string","enum":["caller","agent"],"title":"A2AMessageRole"},"A2AReplyIntent":{"type":"string","enum":["progress","ask_caller","complete","fail"],"title":"A2AReplyIntent"},"A2AReplyRequest":{"properties":{"intent":{"$ref":"#/components/schemas/A2AReplyIntent"},"parts":{"items":{"anyOf":[{"$ref":"#/components/schemas/A2ATextPart"},{"$ref":"#/components/schemas/A2ADataPart"}]},"type":"array","maxItems":64,"minItems":1,"title":"Parts"}},"additionalProperties":false,"type":"object","required":["intent","parts"],"title":"A2AReplyRequest"},"A2ARuleAction":{"type":"string","enum":["allow","block"],"title":"A2ARuleAction"},"A2ARuleDirection":{"type":"string","enum":["inbound","outbound","both"],"title":"A2ARuleDirection"},"A2ARuleMatchType":{"type":"string","enum":["handle"],"title":"A2ARuleMatchType"},"A2ASettingsIdentityResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"agent_handle":{"type":"string","title":"Agent Handle"}},"type":"object","required":["id","agent_handle"],"title":"A2ASettingsIdentityResponse"},"A2ASettingsListItem":{"properties":{"identity":{"$ref":"#/components/schemas/A2ASettingsIdentityResponse"},"settings":{"$ref":"#/components/schemas/A2ASettingsResponse"}},"type":"object","required":["identity","settings"],"title":"A2ASettingsListItem"},"A2ASettingsListResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/A2ASettingsListItem"},"type":"array","title":"Items"}},"type":"object","required":["items"],"title":"A2ASettingsListResponse"},"A2ASettingsResponse":{"properties":{"enabled":{"type":"boolean","title":"Enabled"},"publicly_discoverable":{"type":"boolean","title":"Publicly Discoverable"},"allow_public_egress":{"type":"boolean","title":"Allow Public Egress"},"filter_mode":{"$ref":"#/components/schemas/FilterMode"},"skills":{"anyOf":[{"items":{"$ref":"#/components/schemas/A2ASkill"},"type":"array"},{"type":"null"}],"title":"Skills"},"card_url":{"type":"string","title":"Card Url"},"inbound_task_count":{"type":"integer","minimum":0.0,"title":"Inbound Task Count"},"outbound_task_count":{"type":"integer","minimum":0.0,"title":"Outbound Task Count"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"}},"type":"object","required":["enabled","publicly_discoverable","allow_public_egress","filter_mode","skills","card_url","inbound_task_count","outbound_task_count","updated_at"],"title":"A2ASettingsResponse"},"A2ASettingsUpdate":{"properties":{"enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Enabled"},"publicly_discoverable":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Publicly Discoverable"},"allow_public_egress":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Allow Public Egress"},"filter_mode":{"anyOf":[{"$ref":"#/components/schemas/FilterMode"},{"type":"null"}]},"skills":{"anyOf":[{"items":{"$ref":"#/components/schemas/A2ASkill"},"type":"array","maxItems":32},{"type":"null"}],"title":"Skills"}},"additionalProperties":false,"type":"object","title":"A2ASettingsUpdate"},"A2ASkill":{"properties":{"id":{"type":"string","maxLength":128,"minLength":1,"title":"Id"},"name":{"type":"string","maxLength":255,"minLength":1,"title":"Name"},"description":{"type":"string","maxLength":2000,"minLength":1,"title":"Description"},"tags":{"items":{"type":"string"},"type":"array","maxItems":32,"minItems":1,"title":"Tags"},"examples":{"items":{"type":"string"},"type":"array","maxItems":20,"title":"Examples"},"inputModes":{"items":{"type":"string"},"type":"array","title":"Inputmodes"},"outputModes":{"items":{"type":"string"},"type":"array","title":"Outputmodes"}},"additionalProperties":false,"type":"object","required":["id","name","description","tags"],"title":"A2ASkill"},"A2ATargetResponse":{"properties":{"identity_id":{"type":"string","format":"uuid","title":"Identity Id"},"organization_id":{"type":"string","title":"Organization Id"},"handle":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Handle"}},"type":"object","required":["identity_id","organization_id","handle"],"title":"A2ATargetResponse"},"A2ATaskPage":{"properties":{"items":{"items":{"$ref":"#/components/schemas/A2ATaskResponse"},"type":"array","title":"Items"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor"}},"type":"object","required":["items"],"title":"A2ATaskPage"},"A2ATaskResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"context_id":{"type":"string","format":"uuid","title":"Context Id"},"state":{"$ref":"#/components/schemas/A2ATaskState"},"caller":{"$ref":"#/components/schemas/A2ACallerResponse"},"target":{"$ref":"#/components/schemas/A2ATargetResponse"},"messages":{"items":{"$ref":"#/components/schemas/A2AMessageResponse"},"type":"array","title":"Messages"},"history_truncated":{"type":"boolean","title":"History Truncated","default":false},"completed_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Completed At"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","context_id","state","caller","target","completed_at","created_at","updated_at"],"title":"A2ATaskResponse"},"A2ATextPart":{"properties":{"text":{"type":"string","maxLength":262144,"minLength":1,"title":"Text"},"metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metadata"}},"additionalProperties":false,"type":"object","required":["text"],"title":"A2ATextPart"},"AgentIdentityCreateRequest":{"properties":{"agent_handle":{"type":"string","title":"Agent Handle","description":"Agent handle for the identity. A leading '@' is stripped automatically and the handle must be globally unique."},"display_name":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Display Name","description":"Human-readable display name for the identity. Defaults to agent_handle if omitted."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Free-form description of what the identity is. Visible only to your org."},"imessage_enabled":{"type":"boolean","title":"Imessage Enabled","description":"Whether this identity can be reached through the shared iMessage service. Defaults to false; set true to opt in.","default":false},"contact_sharing_enabled":{"type":"boolean","title":"Contact Sharing Enabled","description":"Whether an attached dedicated iMessage line automatically shares this identity's name and optional avatar. Defaults to true.","default":true},"claim_imessage_number":{"anyOf":[{"type":"boolean","const":true},{"type":"null"}],"title":"Claim Imessage Number","description":"Claim and attach a dedicated iMessage line during identity creation. Requires imessage_enabled=true."},"mailbox":{"anyOf":[{"$ref":"#/components/schemas/AgentIdentityMailboxCreateRequest"},{"type":"null"}],"description":"Optional mailbox-spec; the mailbox is always created. Omit to default to the org's sending domain with a server-chosen local part."},"tunnel":{"anyOf":[{"$ref":"#/components/schemas/AgentIdentityTunnelCreateRequest"},{"type":"null"}],"description":"Optional tunnel-spec. The tunnel is always provisioned with name = agent_handle; this body only opts into PASSTHROUGH or sets a description."},"phone_number":{"anyOf":[{"$ref":"#/components/schemas/AgentIdentityPhoneNumberCreateRequest"},{"type":"null"}],"description":"Optional phone-number provisioning payload to create and link a phone number to the identity during identity creation."},"vault_secret_ids":{"anyOf":[{"type":"string","format":"uuid"},{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"string","enum":["*","all"]},{"type":"null"}],"title":"Vault Secret Ids","description":"Optional vault secret attachment request to scope vault secret access to the newly created agent identity."}},"type":"object","required":["agent_handle"],"title":"AgentIdentityCreateRequest"},"AgentIdentityDetailResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"organization_id":{"type":"string","title":"Organization Id"},"agent_handle":{"type":"string","title":"Agent Handle"},"display_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"status":{"$ref":"#/components/schemas/ResourceStatus","default":"active"},"imessage_enabled":{"type":"boolean","title":"Imessage Enabled","default":false},"contact_sharing_enabled":{"type":"boolean","title":"Contact Sharing Enabled","default":true},"imessage_filter_mode":{"$ref":"#/components/schemas/FilterMode","default":"blacklist"},"mail_filter_mode":{"$ref":"#/components/schemas/FilterMode","default":"blacklist"},"phone_filter_mode":{"$ref":"#/components/schemas/FilterMode","default":"blacklist"},"email_address":{"anyOf":[{"type":"string","format":"email"},{"type":"null"}],"title":"Email Address"},"has_avatar":{"type":"boolean","title":"Has Avatar","default":false},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"signing_key_configured":{"type":"boolean","title":"Signing Key Configured","default":false},"signing_key_created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Signing Key Created At"},"mailbox":{"anyOf":[{"$ref":"#/components/schemas/MailboxResponse"},{"type":"null"}]},"phone_number":{"anyOf":[{"$ref":"#/components/schemas/PhoneNumberResponse"},{"type":"null"}]},"imessage_number":{"anyOf":[{"$ref":"#/components/schemas/AgentIdentityIMessageNumberResponse"},{"type":"null"}]},"tunnel":{"anyOf":[{"$ref":"#/components/schemas/TunnelSummaryResponse"},{"type":"null"}]}},"type":"object","required":["id","organization_id","agent_handle","created_at","updated_at"],"title":"AgentIdentityDetailResponse"},"AgentIdentityIMessageNumberResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"number":{"type":"string","title":"Number"},"type":{"type":"string","const":"dedicated_outbound","title":"Type"},"status":{"anyOf":[{"$ref":"#/components/schemas/IMessageNumberStatus"},{"type":"null"}]},"inbound_only":{"type":"boolean","const":false,"title":"Inbound Only","description":"Deprecated compatibility field; dedicated lines can initiate.","default":false,"deprecated":true}},"type":"object","required":["id","number","type"],"title":"AgentIdentityIMessageNumberResponse"},"AgentIdentityMailboxCreateRequest":{"properties":{"email_local_part":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email Local Part","description":"Optional mailbox email local part to use before the sending domain. On the platform domain it must equal agent_handle (the server forces it). Omit on the platform domain to use agent_handle automatically; supply for a custom domain to pick a specific local part."},"sending_domain":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sending Domain","description":"Optional sending-domain name (e.g. 'assistant.alexwilcox.io'). Omit to inherit the org's default (custom domain if verified, else inkboxmail.com); pass null to force the platform default; pass a verified custom-domain string to bind this mailbox to it."}},"additionalProperties":false,"type":"object","title":"AgentIdentityMailboxCreateRequest"},"AgentIdentityOperationErrorResponse":{"properties":{"detail":{"anyOf":[{"type":"string"},{"additionalProperties":true,"type":"object"}],"title":"Detail"}},"type":"object","required":["detail"],"title":"AgentIdentityOperationErrorResponse"},"AgentIdentityPhoneNumberCreateRequest":{"properties":{"type":{"$ref":"#/components/schemas/NumberType","description":"Type of phone number to provision. Only 'local' is supported; toll-free is no longer offered.","default":"local"},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"Optional US state abbreviation filter. Only used for local numbers."},"incoming_call_action":{"$ref":"#/components/schemas/IncomingCallAction","description":"How to handle inbound calls: hosted_agent (the platform voice agent answers, zero setup — the default wherever the hosted agent is available, so the number is callable right away), auto_accept, auto_reject, webhook, or forward with one phone or SIP destination."},"client_websocket_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Websocket Url","description":"WebSocket URL (wss://) for audio bridging. Required when incoming_call_action is 'auto_accept'."},"incoming_call_webhook_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Incoming Call Webhook Url","description":"Webhook URL (https://) for incoming call notifications. Required when incoming_call_action is 'webhook'."},"forwarding_target_type":{"anyOf":[{"$ref":"#/components/schemas/ForwardingTargetType"},{"type":"null"}]},"forwarding_phone_number":{"anyOf":[{"type":"string","description":"Phone number in E.164 format (e.g. '+15551234567').","examples":["+15551234567"]},{"type":"null"}],"title":"Forwarding Phone Number"},"forwarding_sip_uri":{"anyOf":[{"type":"string","maxLength":512,"description":"Complete SIP destination in sip:user@host format.","examples":["sip:line@voice.example.com"]},{"type":"null"}],"title":"Forwarding Sip Uri"}},"additionalProperties":false,"type":"object","title":"AgentIdentityPhoneNumberCreateRequest"},"AgentIdentityResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"organization_id":{"type":"string","title":"Organization Id"},"agent_handle":{"type":"string","title":"Agent Handle"},"display_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"status":{"$ref":"#/components/schemas/ResourceStatus","default":"active"},"imessage_enabled":{"type":"boolean","title":"Imessage Enabled","default":false},"contact_sharing_enabled":{"type":"boolean","title":"Contact Sharing Enabled","default":true},"imessage_filter_mode":{"$ref":"#/components/schemas/FilterMode","default":"blacklist"},"mail_filter_mode":{"$ref":"#/components/schemas/FilterMode","default":"blacklist"},"phone_filter_mode":{"$ref":"#/components/schemas/FilterMode","default":"blacklist"},"email_address":{"anyOf":[{"type":"string","format":"email"},{"type":"null"}],"title":"Email Address"},"has_avatar":{"type":"boolean","title":"Has Avatar","default":false},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"signing_key_configured":{"type":"boolean","title":"Signing Key Configured","default":false},"signing_key_created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Signing Key Created At"}},"type":"object","required":["id","organization_id","agent_handle","created_at","updated_at"],"title":"AgentIdentityResponse"},"AgentIdentityTunnelCreateRequest":{"properties":{"tls_mode":{"$ref":"#/components/schemas/TLSMode","description":"Where TLS terminates. Defaults to edge.","default":"edge"}},"type":"object","title":"AgentIdentityTunnelCreateRequest"},"AgentIdentityUpdateRequest":{"properties":{"agent_handle":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Agent Handle","description":"New handle for the identity. A leading '@' is stripped automatically. Omit to leave unchanged."},"display_name":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Display Name","description":"New human-readable display name for the identity. Omit to leave unchanged; send null to clear."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"New free-form description of what the identity is. Omit to leave unchanged; send null to clear."},"imessage_enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Imessage Enabled","description":"Whether this identity can be reached through the shared iMessage service. Omit to leave unchanged."},"contact_sharing_enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Contact Sharing Enabled","description":"Whether an attached dedicated iMessage line automatically shares this identity's name and optional avatar. Omit to leave unchanged."},"imessage_number_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Imessage Number Id","description":"Dedicated iMessage number to attach. Send a number UUID to attach or atomically swap from the current dedicated number, null to move to the shared service, or omit to leave unchanged. Available to admin-scoped API keys and JWT callers."},"claim_imessage_number":{"anyOf":[{"type":"boolean","const":true},{"type":"null"}],"title":"Claim Imessage Number","description":"Claim and attach a dedicated iMessage line. Omit to avoid provisioning. Requires an Idempotency-Key header when supplied."},"imessage_filter_mode":{"anyOf":[{"$ref":"#/components/schemas/FilterMode"},{"type":"null"}],"description":"Whitelist/blacklist mode for iMessage contact rules. Admin-only; omit to leave unchanged."},"mail_filter_mode":{"anyOf":[{"$ref":"#/components/schemas/FilterMode"},{"type":"null"}],"description":"Whitelist/blacklist mode for this identity's mail contact rules. Admin-only; omit to leave unchanged."},"phone_filter_mode":{"anyOf":[{"$ref":"#/components/schemas/FilterMode"},{"type":"null"}],"description":"Whitelist/blacklist mode for this identity's phone (call+SMS) contact rules. Admin-only; settable only when the identity has a phone number; omit to leave unchanged."}},"type":"object","title":"AgentIdentityUpdateRequest"},"Body_upload_identity_avatar__agent_handle__avatar_put":{"properties":{"file":{"type":"string","contentMediaType":"application/octet-stream","title":"File"}},"type":"object","required":["file"],"title":"Body_upload_identity_avatar__agent_handle__avatar_put"},"ConnectIMessageNumberRequest":{"properties":{"imessage_number_id":{"type":"string","format":"uuid","title":"Imessage Number Id"}},"additionalProperties":false,"type":"object","required":["imessage_number_id"],"title":"ConnectIMessageNumberRequest"},"FilterMode":{"type":"string","enum":["whitelist","blacklist"],"title":"FilterMode"},"FilterModeChangeNotice":{"properties":{"new_filter_mode":{"$ref":"#/components/schemas/FilterMode"},"redundant_rule_action":{"type":"string","title":"Redundant Rule Action","description":"'block' or 'allow'; the action whose rules are now redundant."},"redundant_rule_count":{"type":"integer","minimum":0.0,"title":"Redundant Rule Count","description":"Count of active rules whose action equals redundant_rule_action. 0 = clean flip; >0 = console UI should prompt the operator to review."}},"type":"object","required":["new_filter_mode","redundant_rule_action","redundant_rule_count"],"title":"FilterModeChangeNotice"},"IMessageDedicatedNumberIdempotencyErrorDetail":{"properties":{"error":{"type":"string","const":"idempotency_key_reused","title":"Error"},"message":{"type":"string","title":"Message"}},"type":"object","required":["error","message"],"title":"IMessageDedicatedNumberIdempotencyErrorDetail"},"IMessageDedicatedNumberIdempotencyErrorResponse":{"properties":{"detail":{"$ref":"#/components/schemas/IMessageDedicatedNumberIdempotencyErrorDetail"}},"type":"object","required":["detail"],"title":"IMessageDedicatedNumberIdempotencyErrorResponse"},"IMessageDedicatedNumberInventoryErrorDetail":{"properties":{"error":{"type":"string","const":"dedicated_imessage_number_inventory_pending","title":"Error"},"message":{"type":"string","title":"Message"},"number_type":{"type":"string","const":"dedicated_outbound","title":"Number Type"},"retry_after_seconds":{"type":"integer","title":"Retry After Seconds"}},"type":"object","required":["error","message","number_type","retry_after_seconds"],"title":"IMessageDedicatedNumberInventoryErrorDetail"},"IMessageDedicatedNumberInventoryErrorResponse":{"properties":{"detail":{"$ref":"#/components/schemas/IMessageDedicatedNumberInventoryErrorDetail"}},"type":"object","required":["detail"],"title":"IMessageDedicatedNumberInventoryErrorResponse"},"IMessageDedicatedNumberQuotaErrorDetail":{"properties":{"error":{"type":"string","const":"dedicated_imessage_number_quota_exceeded","title":"Error"},"message":{"type":"string","title":"Message"},"number_type":{"type":"string","const":"dedicated_outbound","title":"Number Type"},"limit":{"type":"integer","title":"Limit"},"current":{"type":"integer","title":"Current"},"upgrade_url":{"type":"string","title":"Upgrade Url"},"contact_email":{"type":"string","title":"Contact Email"}},"type":"object","required":["error","message","number_type","limit","current","upgrade_url","contact_email"],"title":"IMessageDedicatedNumberQuotaErrorDetail"},"IMessageDedicatedNumberQuotaErrorResponse":{"properties":{"detail":{"$ref":"#/components/schemas/IMessageDedicatedNumberQuotaErrorDetail"}},"type":"object","required":["detail"],"title":"IMessageDedicatedNumberQuotaErrorResponse"},"IMessageNumberClaimIdempotencyRequiredResponse":{"properties":{"detail":{"type":"string","const":"Idempotency-Key is required when claiming a new iMessage number","title":"Detail"}},"type":"object","required":["detail"],"title":"IMessageNumberClaimIdempotencyRequiredResponse"},"IMessageNumberStatus":{"type":"string","enum":["active","paused","released"],"title":"IMessageNumberStatus"},"IdentityAvatarChangeResponse":{"properties":{"identity_id":{"type":"string","format":"uuid","title":"Identity Id"},"agent_handle":{"type":"string","title":"Agent Handle"},"has_avatar":{"type":"boolean","title":"Has Avatar"},"sha256":{"anyOf":[{"type":"string","pattern":"^[0-9a-f]{64}$"},{"type":"null"}],"title":"Sha256"}},"type":"object","required":["identity_id","agent_handle","has_avatar"],"title":"IdentityAvatarChangeResponse"},"IdentityAvatarMetadataResponse":{"properties":{"agent_handle":{"type":"string","title":"Agent Handle"},"has_avatar":{"type":"boolean","title":"Has Avatar"},"content_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Content Type"},"authorized_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorized Url"},"expires_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expires At"}},"type":"object","required":["agent_handle","has_avatar"],"title":"IdentityAvatarMetadataResponse"},"IdentityChannelStatusResponse":{"properties":{"agent_handle":{"type":"string","title":"Agent Handle"},"email":{"$ref":"#/components/schemas/IdentityEmailChannelResponse"},"sending_domain":{"anyOf":[{"$ref":"#/components/schemas/IdentitySendingDomainStatusResponse"},{"type":"null"}]},"phone":{"$ref":"#/components/schemas/IdentityPhoneChannelResponse"},"imessage":{"$ref":"#/components/schemas/IdentityIMessageChannelResponse"},"calling_available":{"type":"boolean","title":"Calling Available"},"sms_available":{"type":"boolean","title":"Sms Available"}},"type":"object","required":["agent_handle","email","phone","imessage","calling_available","sms_available"],"title":"IdentityChannelStatusResponse"},"IdentityEmailChannelResponse":{"properties":{"assigned":{"type":"boolean","title":"Assigned"},"address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"}},"type":"object","required":["assigned"],"title":"IdentityEmailChannelResponse"},"IdentityIMessageChannelResponse":{"properties":{"enabled":{"type":"boolean","title":"Enabled"},"dedicated_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dedicated Number"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"}},"type":"object","required":["enabled"],"title":"IdentityIMessageChannelResponse"},"IdentityPhoneChannelResponse":{"properties":{"assigned":{"type":"boolean","title":"Assigned"},"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id"},"number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Number"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"sms_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sms Status"}},"type":"object","required":["assigned"],"title":"IdentityPhoneChannelResponse"},"IdentitySendingDomainStatusResponse":{"properties":{"kind":{"type":"string","enum":["platform","custom"],"title":"Kind"},"domain":{"type":"string","title":"Domain"},"status":{"type":"string","title":"Status"}},"type":"object","required":["kind","domain","status"],"title":"IdentitySendingDomainStatusResponse"},"IdentityStagedAvatarRequest":{"properties":{"staged_media_handle":{"type":"string","maxLength":36,"minLength":36,"title":"Staged Media Handle"}},"type":"object","required":["staged_media_handle"],"title":"IdentityStagedAvatarRequest"},"IncomingCallAction":{"type":"string","enum":["auto_accept","auto_reject","webhook","hosted_agent","forward"],"title":"IncomingCallAction"},"MailContactRuleCreate":{"properties":{"action":{"$ref":"#/components/schemas/MailRuleAction"},"match_type":{"$ref":"#/components/schemas/MailRuleMatchType"},"match_target":{"type":"string","maxLength":320,"title":"Match Target","description":"What the rule matches against. For EXACT_EMAIL: a full email address (stored lowercased). For DOMAIN: a bare domain like 'gmail.com'."}},"type":"object","required":["action","match_type","match_target"],"title":"MailContactRuleCreate"},"MailContactRuleUpdate":{"properties":{"action":{"anyOf":[{"$ref":"#/components/schemas/MailRuleAction"},{"type":"null"}]}},"type":"object","title":"MailContactRuleUpdate"},"MailIdentityContactRuleResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"agent_identity_id":{"type":"string","format":"uuid","title":"Agent Identity Id"},"action":{"$ref":"#/components/schemas/MailRuleAction"},"match_type":{"$ref":"#/components/schemas/MailRuleMatchType"},"match_target":{"type":"string","title":"Match Target"},"status":{"$ref":"#/components/schemas/ResourceStatus"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","agent_identity_id","action","match_type","match_target","status","created_at","updated_at"],"title":"MailIdentityContactRuleResponse"},"MailRuleAction":{"type":"string","enum":["allow","block"],"title":"MailRuleAction"},"MailRuleMatchType":{"type":"string","enum":["exact_email","domain"],"title":"MailRuleMatchType"},"MailboxResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"email_address":{"type":"string","title":"Email Address"},"status":{"$ref":"#/components/schemas/ResourceStatus","default":"active"},"sending_domain":{"type":"string","title":"Sending Domain","description":"Bare domain the mailbox sends from, derived from email_address. Matches the platform default (inkboxmail.com) or the customer's verified custom domain.","default":""},"filter_mode":{"$ref":"#/components/schemas/FilterMode"},"agent_identity_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Agent Identity Id","description":"ID of the agent identity that owns this mailbox, or null on tombstones / system mailboxes."},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"storage_used_bytes":{"type":"integer","title":"Storage Used Bytes","description":"Live storage used by this inbox, in bytes.","default":0},"storage_limit_bytes":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Storage Limit Bytes","description":"Resolved plan-tiered storage cap in bytes; null when the route did not resolve it (the ORM does not carry the cap)."},"filter_mode_change_notice":{"anyOf":[{"$ref":"#/components/schemas/FilterModeChangeNotice"},{"type":"null"}]},"unread_count":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Unread Count"}},"type":"object","required":["id","email_address","filter_mode","created_at","updated_at"],"title":"MailboxResponse"},"NumberType":{"type":"string","enum":["local","toll_free"],"title":"NumberType"},"PhoneContactRuleCreate":{"properties":{"action":{"$ref":"#/components/schemas/PhoneRuleAction"},"match_type":{"$ref":"#/components/schemas/PhoneRuleMatchType","description":"Match type (only 'exact_number' in v1).","default":"exact_number"},"match_target":{"type":"string","title":"Match Target","description":"Phone number to match, in E.164 format.","examples":["+15551234567"]}},"type":"object","required":["action","match_target"],"title":"PhoneContactRuleCreate"},"PhoneContactRuleUpdate":{"properties":{"action":{"anyOf":[{"$ref":"#/components/schemas/PhoneRuleAction"},{"type":"null"}]}},"type":"object","title":"PhoneContactRuleUpdate"},"PhoneIdentityContactRuleResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"agent_identity_id":{"type":"string","format":"uuid","title":"Agent Identity Id"},"action":{"$ref":"#/components/schemas/PhoneRuleAction"},"match_type":{"$ref":"#/components/schemas/PhoneRuleMatchType"},"match_target":{"type":"string","title":"Match Target"},"status":{"$ref":"#/components/schemas/ResourceStatus"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","agent_identity_id","action","match_type","match_target","status","created_at","updated_at"],"title":"PhoneIdentityContactRuleResponse"},"PhoneNumberResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"number":{"type":"string","title":"Number"},"type":{"$ref":"#/components/schemas/NumberType"},"status":{"$ref":"#/components/schemas/PhoneNumberStatus"},"sms_status":{"$ref":"#/components/schemas/SmsStatus"},"sms_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sms Error Code"},"sms_error_detail":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sms Error Detail"},"sms_ready_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Sms Ready At"},"incoming_call_action":{"$ref":"#/components/schemas/IncomingCallAction"},"client_websocket_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Websocket Url"},"incoming_call_webhook_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Incoming Call Webhook Url"},"forwarding_target_type":{"anyOf":[{"$ref":"#/components/schemas/ForwardingTargetType"},{"type":"null"}]},"forwarding_phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Forwarding Phone Number"},"forwarding_sip_uri":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Forwarding Sip Uri"},"filter_mode":{"$ref":"#/components/schemas/FilterMode"},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"2-letter US state abbreviation for LOCAL numbers (e.g. 'NY'). Null for toll-free numbers."},"agent_identity_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Agent Identity Id","description":"ID of the agent identity that owns this phone number, or null if the number is standalone (not tied to any agent)."},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"filter_mode_change_notice":{"anyOf":[{"$ref":"#/components/schemas/FilterModeChangeNotice"},{"type":"null"}]}},"type":"object","required":["id","number","type","status","sms_status","incoming_call_action","client_websocket_url","incoming_call_webhook_url","filter_mode","created_at","updated_at"],"title":"PhoneNumberResponse"},"PhoneNumberStatus":{"type":"string","enum":["active","paused","released"],"title":"PhoneNumberStatus"},"PhoneRuleAction":{"type":"string","enum":["allow","block"],"title":"PhoneRuleAction"},"PhoneRuleMatchType":{"type":"string","enum":["exact_number"],"title":"PhoneRuleMatchType"},"SmsStatus":{"type":"string","enum":["pending","ready","assignment_failed"],"title":"SmsStatus"},"TLSMode":{"type":"string","enum":["edge","passthrough"],"title":"TLSMode"},"TunnelStatus":{"type":"string","enum":["awaiting_cert","active","deleted"],"title":"TunnelStatus"},"TunnelSummaryResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"tunnel_name":{"type":"string","title":"Tunnel Name"},"agent_identity_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Agent Identity Id","description":"Identifier of the identity associated with this tunnel, when available."},"tls_mode":{"$ref":"#/components/schemas/TLSMode"},"status":{"$ref":"#/components/schemas/TunnelStatus"},"public_host":{"type":"string","title":"Public Host"},"zone":{"type":"string","title":"Zone"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","tunnel_name","tls_mode","status","public_host","zone","created_at","updated_at"],"title":"TunnelSummaryResponse"},"AdminIMessageNumberResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"number":{"type":"string","title":"Number"},"type":{"type":"string","enum":["triage","shared_inbound","dedicated_outbound","dedicated_triage"],"title":"Type"},"status":{"$ref":"#/components/schemas/IMessageNumberStatus"},"organization_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Organization Id"},"identity_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Identity Id"},"agent_handle":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Agent Handle"},"provider_line_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Provider Line Id"},"telnyx_did":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Telnyx Did"},"caller_id_verified_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Caller Id Verified At"},"inbound_forwarding_confirmed_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Inbound Forwarding Confirmed At"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","number","type","status","created_at","updated_at"],"title":"AdminIMessageNumberResponse"},"Body_upload_media_media_post":{"properties":{"file":{"type":"string","contentMediaType":"application/octet-stream","title":"File"}},"type":"object","required":["file"],"title":"Body_upload_media_media_post"},"Body_upload_router_avatar_router_avatar_put":{"properties":{"file":{"type":"string","contentMediaType":"application/octet-stream","title":"File"}},"type":"object","required":["file"],"title":"Body_upload_router_avatar_router_avatar_put"},"ClaimIMessageNumberRequest":{"properties":{},"additionalProperties":false,"type":"object","title":"ClaimIMessageNumberRequest"},"CreateIMessageNumberRequest":{"properties":{"number":{"type":"string","title":"Number","description":"Phone number in E.164 format (e.g. '+15551234567').","examples":["+15551234567"]},"type":{"anyOf":[{"type":"string","enum":["triage","shared_inbound","dedicated_outbound","dedicated_triage"]},{"type":"string","const":"dedicated"}],"title":"Type","default":"shared_inbound"},"status":{"type":"string","const":"active","title":"Status","default":"active"},"provider_line_id":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Provider Line Id"},"organization_id":{"anyOf":[{"type":"string","maxLength":255,"minLength":1},{"type":"null"}],"title":"Organization Id"}},"additionalProperties":false,"type":"object","required":["number"],"title":"CreateIMessageNumberRequest"},"IMessageAssignmentResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"remote_number":{"type":"string","title":"Remote Number"},"agent_identity_id":{"type":"string","format":"uuid","title":"Agent Identity Id"},"organization_id":{"type":"string","title":"Organization Id"},"status":{"$ref":"#/components/schemas/IMessageAssignmentStatus"},"released_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Released At"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","remote_number","agent_identity_id","organization_id","status","created_at","updated_at"],"title":"IMessageAssignmentResponse"},"IMessageAssignmentStatus":{"type":"string","enum":["active","released"],"title":"IMessageAssignmentStatus"},"IMessageContactRuleCreate":{"properties":{"action":{"$ref":"#/components/schemas/IMessageRuleAction"},"match_type":{"$ref":"#/components/schemas/IMessageRuleMatchType","description":"Match type (only 'exact_number' in v1).","default":"exact_number"},"match_target":{"type":"string","title":"Match Target","description":"Phone number to match, in E.164 format.","examples":["+15551234567"]}},"type":"object","required":["action","match_target"],"title":"IMessageContactRuleCreate"},"IMessageContactRuleResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"agent_identity_id":{"type":"string","format":"uuid","title":"Agent Identity Id"},"action":{"$ref":"#/components/schemas/IMessageRuleAction"},"match_type":{"$ref":"#/components/schemas/IMessageRuleMatchType"},"match_target":{"type":"string","title":"Match Target"},"status":{"$ref":"#/components/schemas/ResourceStatus"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","agent_identity_id","action","match_type","match_target","status","created_at","updated_at"],"title":"IMessageContactRuleResponse"},"IMessageContactRuleUpdate":{"properties":{"action":{"anyOf":[{"$ref":"#/components/schemas/IMessageRuleAction"},{"type":"null"}]}},"type":"object","title":"IMessageContactRuleUpdate"},"IMessageConversationResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"assignment_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Assignment Id"},"assignment_status":{"anyOf":[{"$ref":"#/components/schemas/IMessageAssignmentStatus"},{"type":"null"}]},"remote_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remote Number"},"participants":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Participants"},"is_group":{"type":"boolean","title":"Is Group","default":false},"group_creation_status":{"anyOf":[{"$ref":"#/components/schemas/IMessageGroupCreationStatus"},{"type":"null"}]},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","assignment_id","assignment_status","remote_number","created_at","updated_at"],"title":"IMessageConversationResponse"},"IMessageConversationSummary":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"assignment_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Assignment Id"},"assignment_status":{"anyOf":[{"$ref":"#/components/schemas/IMessageAssignmentStatus"},{"type":"null"}]},"remote_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remote Number"},"participants":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Participants"},"is_group":{"type":"boolean","title":"Is Group","default":false},"group_creation_status":{"anyOf":[{"$ref":"#/components/schemas/IMessageGroupCreationStatus"},{"type":"null"}]},"latest_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Latest Text"},"latest_message_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Latest Message At"},"latest_direction":{"anyOf":[{"$ref":"#/components/schemas/IMessageDirection"},{"type":"null"}]},"latest_has_media":{"type":"boolean","title":"Latest Has Media","default":false},"unread_count":{"type":"integer","minimum":0.0,"title":"Unread Count","default":0},"total_count":{"type":"integer","minimum":0.0,"title":"Total Count","default":0}},"type":"object","required":["id","assignment_id","assignment_status","remote_number"],"title":"IMessageConversationSummary"},"IMessageDedicatedNumberResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"number":{"type":"string","title":"Number"},"type":{"type":"string","const":"dedicated_outbound","title":"Type"},"status":{"type":"string","enum":["active","paused"],"title":"Status"},"inbound_only":{"type":"boolean","const":false,"title":"Inbound Only","description":"Deprecated compatibility field; dedicated lines can initiate.","default":false,"deprecated":true},"agent_identity_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Agent Identity Id"},"agent_handle":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Agent Handle"}},"type":"object","required":["id","number","type","status","agent_identity_id","agent_handle"],"title":"IMessageDedicatedNumberResponse"},"IMessageGroupCreationStatus":{"type":"string","enum":["creating","not_created","ready"],"title":"IMessageGroupCreationStatus"},"IMessageGroupSendCommandResponse":{"properties":{"message_id":{"type":"string","format":"uuid","title":"Message Id"},"conversation_id":{"type":"string","format":"uuid","title":"Conversation Id"},"recipients":{"items":{"type":"string"},"type":"array","maxItems":8,"minItems":2,"title":"Recipients"},"is_group":{"type":"boolean","title":"Is Group"},"group_creation_status":{"type":"string","title":"Group Creation Status"},"status":{"type":"string","title":"Status"}},"type":"object","required":["message_id","conversation_id","recipients","is_group","group_creation_status","status"],"title":"IMessageGroupSendCommandResponse"},"IMessageMessageResponse":{"properties":{"provider_message_handle":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Provider Message Handle"},"id":{"type":"string","format":"uuid","title":"Id"},"conversation_id":{"type":"string","format":"uuid","title":"Conversation Id"},"assignment_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Assignment Id"},"direction":{"$ref":"#/components/schemas/IMessageDirection"},"remote_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remote Number"},"sender_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sender Number"},"participants":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Participants"},"is_group":{"type":"boolean","title":"Is Group","default":false},"content":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Content"},"message_type":{"$ref":"#/components/schemas/IMessageType"},"service":{"$ref":"#/components/schemas/IMessageService"},"send_style":{"anyOf":[{"$ref":"#/components/schemas/IMessageSendStyle"},{"type":"null"}]},"media":{"anyOf":[{"items":{"$ref":"#/components/schemas/IMessageMediaItem"},"type":"array"},{"type":"null"}],"title":"Media"},"was_downgraded":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Was Downgraded"},"status":{"anyOf":[{"$ref":"#/components/schemas/IMessageStatus"},{"type":"null"}]},"error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error Code"},"error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error Message"},"error_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error Reason"},"error_detail":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error Detail"},"is_read":{"type":"boolean","title":"Is Read"},"is_blocked":{"type":"boolean","title":"Is Blocked","default":false},"recipients":{"anyOf":[{"items":{"$ref":"#/components/schemas/IMessageRecipientResponse"},"type":"array"},{"type":"null"}],"title":"Recipients"},"reactions":{"anyOf":[{"items":{"$ref":"#/components/schemas/IMessageMessageReaction"},"type":"array"},{"type":"null"}],"title":"Reactions"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","conversation_id","assignment_id","direction","remote_number","message_type","service","is_read","created_at","updated_at"],"title":"IMessageMessageResponse"},"IMessageReactionCommandResponse":{"properties":{"reaction_id":{"type":"string","format":"uuid","title":"Reaction Id"},"message_id":{"type":"string","format":"uuid","title":"Message Id"},"reaction":{"type":"string","title":"Reaction"}},"type":"object","required":["reaction_id","message_id","reaction"],"title":"IMessageReactionCommandResponse"},"IMessageReadCommandResponse":{"properties":{"conversation_id":{"type":"string","format":"uuid","title":"Conversation Id"},"recipient":{"type":"string","title":"Recipient"},"updated_count":{"type":"integer","minimum":0.0,"title":"Updated Count"}},"type":"object","required":["conversation_id","recipient","updated_count"],"title":"IMessageReadCommandResponse"},"IMessageRouterConfigResponse":{"properties":{"vcard_display_name":{"type":"string","title":"Vcard Display Name"},"vcard_company_name":{"type":"string","title":"Vcard Company Name"},"vcard_email_address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vcard Email Address"},"vcard_note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vcard Note"},"contact_sharing_enabled":{"type":"boolean","title":"Contact Sharing Enabled"},"welcome_message":{"type":"string","title":"Welcome Message"},"help_message":{"type":"string","title":"Help Message"},"send_first_contact_onboarding_on_connect":{"type":"boolean","title":"Send First Contact Onboarding On Connect"},"include_agent_email_in_contact_card":{"type":"boolean","title":"Include Agent Email In Contact Card"},"include_agent_note_in_contact_card":{"type":"boolean","title":"Include Agent Note In Contact Card"},"connect_reply_template":{"type":"string","title":"Connect Reply Template"},"reconnect_reply_template":{"type":"string","title":"Reconnect Reply Template"},"has_custom_avatar":{"type":"boolean","title":"Has Custom Avatar"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["vcard_display_name","vcard_company_name","contact_sharing_enabled","welcome_message","help_message","send_first_contact_onboarding_on_connect","include_agent_email_in_contact_card","include_agent_note_in_contact_card","connect_reply_template","reconnect_reply_template","has_custom_avatar","created_at","updated_at"],"title":"IMessageRouterConfigResponse"},"IMessageRouterConversationPage":{"properties":{"items":{"items":{"$ref":"#/components/schemas/IMessageRouterConversationSummary"},"type":"array","title":"Items"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor"}},"type":"object","required":["items"],"title":"IMessageRouterConversationPage"},"IMessageRouterConversationResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"local_number":{"type":"string","title":"Local Number"},"remote_number":{"type":"string","title":"Remote Number"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","local_number","remote_number","created_at","updated_at"],"title":"IMessageRouterConversationResponse"},"IMessageRouterConversationSummary":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"local_number":{"type":"string","title":"Local Number"},"remote_number":{"type":"string","title":"Remote Number"},"latest_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Latest Text"},"latest_direction":{"anyOf":[{"$ref":"#/components/schemas/IMessageDirection"},{"type":"null"}]},"latest_message_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Latest Message At"},"total_count":{"type":"integer","minimum":0.0,"title":"Total Count"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","local_number","remote_number","total_count","created_at","updated_at"],"title":"IMessageRouterConversationSummary"},"IMessageRouterLineResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"number":{"type":"string","title":"Number"},"status":{"$ref":"#/components/schemas/IMessageNumberStatus"}},"type":"object","required":["id","number","status"],"title":"IMessageRouterLineResponse"},"IMessageRouterMessagePage":{"properties":{"items":{"items":{"$ref":"#/components/schemas/IMessageRouterMessageResponse"},"type":"array","title":"Items"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor"}},"type":"object","required":["items"],"title":"IMessageRouterMessagePage"},"IMessageRouterMessageResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"conversation_id":{"type":"string","format":"uuid","title":"Conversation Id"},"direction":{"$ref":"#/components/schemas/IMessageDirection"},"content":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Content"},"created_at":{"type":"string","format":"date-time","title":"Created At"}},"type":"object","required":["id","conversation_id","direction","created_at"],"title":"IMessageRouterMessageResponse"},"IMessageRouterResponse":{"properties":{"line":{"$ref":"#/components/schemas/IMessageRouterLineResponse"},"config":{"$ref":"#/components/schemas/IMessageRouterConfigResponse"}},"type":"object","required":["line","config"],"title":"IMessageRouterResponse"},"IMessageRuleAction":{"type":"string","enum":["allow","block"],"title":"IMessageRuleAction"},"IMessageRuleMatchType":{"type":"string","enum":["exact_number"],"title":"IMessageRuleMatchType"},"IMessageSendCommandResponse":{"properties":{"message_id":{"type":"string","format":"uuid","title":"Message Id"},"conversation_id":{"type":"string","format":"uuid","title":"Conversation Id"},"recipient":{"type":"string","title":"Recipient"},"status":{"type":"string","title":"Status"}},"type":"object","required":["message_id","conversation_id","recipient","status"],"title":"IMessageSendCommandResponse"},"IMessageSendableReactionType":{"type":"string","enum":["love","like","dislike","laugh","emphasize","question","eyes"],"title":"IMessageSendableReactionType"},"IMessageTriageNumberResponse":{"properties":{"number":{"type":"string","title":"Number"},"connect_command":{"type":"string","title":"Connect Command"},"sms_link":{"type":"string","title":"Sms Link"},"connect_qr_png_data_url":{"type":"string","title":"Connect Qr Png Data Url"}},"type":"object","required":["number","connect_command","sms_link","connect_qr_png_data_url"],"title":"IMessageTriageNumberResponse"},"MarkIMessageReadRequest":{"properties":{"conversation_id":{"type":"string","format":"uuid","title":"Conversation Id"},"recipient":{"anyOf":[{"type":"string","description":"Phone number in E.164 format (e.g. '+15551234567').","examples":["+15551234567"]},{"type":"null"}],"title":"Recipient"}},"additionalProperties":false,"type":"object","required":["conversation_id"],"title":"MarkIMessageReadRequest"},"MarkIMessageReadResponse":{"properties":{"conversation_id":{"type":"string","format":"uuid","title":"Conversation Id"},"updated_count":{"type":"integer","minimum":0.0,"title":"Updated Count"}},"type":"object","required":["conversation_id","updated_count"],"title":"MarkIMessageReadResponse"},"MessagingCapability":{"type":"string","enum":["iMessage","SMS","RCS"],"title":"MessagingCapability"},"SendIMessageReactionRequest":{"properties":{"message_id":{"type":"string","format":"uuid","title":"Message Id"},"reaction":{"$ref":"#/components/schemas/IMessageSendableReactionType"},"part_index":{"type":"integer","minimum":0.0,"title":"Part Index","default":0}},"additionalProperties":false,"type":"object","required":["message_id","reaction"],"title":"SendIMessageReactionRequest"},"SendIMessageRequest":{"properties":{"to":{"anyOf":[{"type":"string","description":"Phone number in E.164 format (e.g. '+15551234567').","examples":["+15551234567"]},{"items":{"type":"string","description":"Phone number in E.164 format (e.g. '+15551234567').","examples":["+15551234567"]},"type":"array"},{"type":"null"}],"title":"To","description":"One recipient or a list of 1–8 recipients. Lists with two or more members start or select a best-known exact-membership group. Mutually exclusive with conversation_id."},"conversation_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Conversation Id","description":"Existing conversation to reply into. Mutually exclusive with to."},"text":{"anyOf":[{"type":"string","maxLength":18995},{"type":"null"}],"title":"Text"},"media_urls":{"anyOf":[{"items":{"type":"string"},"type":"array","maxItems":1},{"type":"null"}],"title":"Media Urls"},"staged_media":{"items":{"$ref":"#/components/schemas/StagedIMessageMediaBinding"},"type":"array","maxItems":1,"title":"Staged Media"},"send_style":{"anyOf":[{"$ref":"#/components/schemas/IMessageSendStyle"},{"type":"null"}]}},"additionalProperties":false,"type":"object","title":"SendIMessageRequest"},"SendIMessageResponse":{"properties":{"message":{"$ref":"#/components/schemas/IMessageMessageResponse"}},"type":"object","required":["message"],"title":"SendIMessageResponse"},"SendIMessageTypingRequest":{"properties":{"conversation_id":{"type":"string","format":"uuid","title":"Conversation Id"}},"additionalProperties":false,"type":"object","required":["conversation_id"],"title":"SendIMessageTypingRequest"},"StagedIMessageMediaBinding":{"properties":{"handle":{"type":"string","title":"Handle"},"content_hash":{"type":"string","pattern":"^[0-9a-f]{64}$","title":"Content Hash"}},"additionalProperties":false,"type":"object","required":["handle","content_hash"],"title":"StagedIMessageMediaBinding"},"UpdateIMessageNumberRequest":{"properties":{"type":{"anyOf":[{"type":"string","enum":["triage","shared_inbound","dedicated_outbound","dedicated_triage"]},{"type":"string","const":"dedicated"},{"type":"null"}],"title":"Type"},"provider_line_id":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Provider Line Id"},"organization_id":{"anyOf":[{"type":"string","maxLength":255,"minLength":1},{"type":"null"}],"title":"Organization Id","description":"Owning organization. Omit to keep the current owner; send null to return a dedicated number to unowned reserve inventory."}},"additionalProperties":false,"type":"object","title":"UpdateIMessageNumberRequest"},"UpdateIMessageRouterConfigRequest":{"properties":{"vcard_display_name":{"anyOf":[{"type":"string","maxLength":255,"minLength":1},{"type":"null"}],"title":"Vcard Display Name"},"vcard_company_name":{"anyOf":[{"type":"string","maxLength":255,"minLength":1},{"type":"null"}],"title":"Vcard Company Name"},"vcard_email_address":{"anyOf":[{"type":"string","maxLength":320},{"type":"null"}],"title":"Vcard Email Address"},"vcard_note":{"anyOf":[{"type":"string","maxLength":10000},{"type":"null"}],"title":"Vcard Note"},"contact_sharing_enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Contact Sharing Enabled"},"welcome_message":{"anyOf":[{"type":"string","maxLength":10000,"minLength":1},{"type":"null"}],"title":"Welcome Message"},"help_message":{"anyOf":[{"type":"string","maxLength":10000,"minLength":1},{"type":"null"}],"title":"Help Message"},"include_agent_email_in_contact_card":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Include Agent Email In Contact Card"},"include_agent_note_in_contact_card":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Include Agent Note In Contact Card"},"connect_reply_template":{"anyOf":[{"type":"string","maxLength":10000,"minLength":1},{"type":"null"}],"title":"Connect Reply Template"},"reconnect_reply_template":{"anyOf":[{"type":"string","maxLength":10000,"minLength":1},{"type":"null"}],"title":"Reconnect Reply Template"}},"additionalProperties":false,"type":"object","title":"UpdateIMessageRouterConfigRequest"},"UpdateIMessageRouterConnectOnboardingRequest":{"properties":{"send_first_contact_onboarding_on_connect":{"type":"boolean","title":"Send First Contact Onboarding On Connect"}},"additionalProperties":false,"type":"object","required":["send_first_contact_onboarding_on_connect"],"title":"UpdateIMessageRouterConnectOnboardingRequest"},"UploadIMessageMediaResponse":{"properties":{"media_url":{"type":"string","title":"Media Url"},"content_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Content Type"},"size":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Size"}},"type":"object","required":["media_url"],"title":"UploadIMessageMediaResponse"},"AttachmentDownloadResponse":{"properties":{"attachment_ref":{"type":"string","title":"Attachment Ref"},"filename":{"type":"string","title":"Filename"},"content_type":{"type":"string","title":"Content Type"},"size":{"type":"integer","minimum":0.0,"title":"Size"},"url":{"type":"string","title":"Url"},"expires_in":{"type":"integer","exclusiveMinimum":0.0,"title":"Expires In"}},"type":"object","required":["attachment_ref","filename","content_type","size","url","expires_in"],"title":"AttachmentDownloadResponse"},"AttachmentMetadataResponse":{"properties":{"attachment_ref":{"type":"string","title":"Attachment Ref"},"filename":{"type":"string","title":"Filename"},"content_type":{"type":"string","title":"Content Type"},"size":{"type":"integer","minimum":0.0,"title":"Size"}},"type":"object","required":["attachment_ref","filename","content_type","size"],"title":"AttachmentMetadataResponse"},"AttachmentUpload":{"properties":{"filename":{"type":"string","maxLength":255,"title":"Filename"},"content_type":{"type":"string","maxLength":255,"title":"Content Type","description":"MIME type, e.g. image/jpeg"},"content_base64":{"type":"string","title":"Content Base64","description":"Base64-encoded file content"},"content_id":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Content Id","description":"Mark this part as an inline image referenced from body_html as cid:<content_id> (e.g. <img src=\"cid:chart1\">). Surrounding angle brackets are optional. Omit for a normal attachment."}},"type":"object","required":["filename","content_type","content_base64"],"title":"AttachmentUpload"},"BoundedMessageDetailResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"mailbox_id":{"type":"string","format":"uuid","title":"Mailbox Id"},"thread_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Thread Id"},"message_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message Id"},"from_address":{"type":"string","title":"From Address"},"reply_to":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reply To"},"to_addresses":{"items":{"type":"string"},"type":"array","title":"To Addresses"},"cc_addresses":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Cc Addresses"},"subject":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subject"},"snippet":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Snippet"},"direction":{"$ref":"#/components/schemas/MessageDirection"},"status":{"$ref":"#/components/schemas/MessageStatus"},"is_read":{"type":"boolean","title":"Is Read"},"is_starred":{"type":"boolean","title":"Is Starred"},"has_attachments":{"type":"boolean","title":"Has Attachments"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"body_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Body Text"},"body_html":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Body Html"},"body_truncated":{"type":"boolean","title":"Body Truncated"},"bcc_addresses":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Bcc Addresses"},"in_reply_to":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"In Reply To"},"references":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"References"},"attachments":{"items":{"$ref":"#/components/schemas/AttachmentMetadataResponse"},"type":"array","title":"Attachments"}},"type":"object","required":["id","mailbox_id","thread_id","message_id","from_address","reply_to","to_addresses","cc_addresses","subject","snippet","direction","status","is_read","is_starred","has_attachments","created_at","updated_at","body_text","body_html","body_truncated","bcc_addresses","in_reply_to","references","attachments"],"title":"BoundedMessageDetailResponse"},"BoundedThreadDetailResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"mailbox_id":{"type":"string","format":"uuid","title":"Mailbox Id"},"subject":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subject"},"folder":{"$ref":"#/components/schemas/ThreadFolder"},"message_count":{"type":"integer","title":"Message Count"},"last_message_at":{"type":"string","format":"date-time","title":"Last Message At"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"messages":{"items":{"$ref":"#/components/schemas/SafeMessageResponse"},"type":"array","title":"Messages"},"messages_has_more":{"type":"boolean","title":"Messages Has More"}},"type":"object","required":["id","mailbox_id","subject","folder","message_count","last_message_at","created_at","messages","messages_has_more"],"title":"BoundedThreadDetailResponse"},"CursorPage_MailImportJobResponse_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/MailImportJobResponse"},"type":"array","title":"Items"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor"},"has_more":{"type":"boolean","title":"Has More","default":false}},"type":"object","required":["items"],"title":"CursorPage[MailImportJobResponse]"},"CursorPage_MessageResponse_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","title":"Items"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor"},"has_more":{"type":"boolean","title":"Has More","default":false}},"type":"object","required":["items"],"title":"CursorPage[MessageResponse]"},"CursorPage_SafeMessageResponse_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/SafeMessageResponse"},"type":"array","title":"Items"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor"},"has_more":{"type":"boolean","title":"Has More","default":false}},"type":"object","required":["items"],"title":"CursorPage[SafeMessageResponse]"},"CursorPage_ThreadResponse_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/ThreadResponse"},"type":"array","title":"Items"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor"},"has_more":{"type":"boolean","title":"Has More","default":false}},"type":"object","required":["items"],"title":"CursorPage[ThreadResponse]"},"DraftAttachmentAdd":{"properties":{"generation":{"type":"integer","minimum":1.0,"title":"Generation"},"attachments":{"items":{"$ref":"#/components/schemas/AttachmentUpload"},"type":"array","maxItems":50,"minItems":1,"title":"Attachments"}},"type":"object","required":["generation","attachments"],"title":"DraftAttachmentAdd"},"DraftAttachmentResponse":{"properties":{"part_index":{"type":"integer","minimum":0.0,"title":"Part Index"},"filename":{"type":"string","title":"Filename"},"content_type":{"type":"string","title":"Content Type"},"size":{"type":"integer","minimum":0.0,"title":"Size"},"content_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Content Id"},"is_inline":{"type":"boolean","title":"Is Inline","default":false}},"type":"object","required":["part_index","filename","content_type","size"],"title":"DraftAttachmentResponse"},"DraftCreate":{"properties":{"recipients":{"$ref":"#/components/schemas/DraftRecipients"},"subject":{"anyOf":[{"type":"string","maxLength":998},{"type":"null"}],"title":"Subject"},"body_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Body Text"},"body_html":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Body Html"},"reply_to":{"anyOf":[{"type":"string","format":"email"},{"type":"null"}],"title":"Reply To"},"thread_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Thread Id"},"in_reply_to_message_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"In Reply To Message Id"},"references":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"References"},"attachments":{"anyOf":[{"items":{"$ref":"#/components/schemas/AttachmentUpload"},"type":"array","maxItems":50},{"type":"null"}],"title":"Attachments"},"track_opens":{"type":"boolean","title":"Track Opens","default":false},"forward_message_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Forward Message Id"},"forward_mode":{"$ref":"#/components/schemas/ForwardMode","default":"inline"},"include_original_attachments":{"type":"boolean","title":"Include Original Attachments","default":true},"forward_note_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Forward Note Text"},"forward_note_html":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Forward Note Html"}},"type":"object","title":"DraftCreate"},"DraftDetailResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"mailbox_id":{"type":"string","format":"uuid","title":"Mailbox Id"},"from_address":{"type":"string","title":"From Address"},"to_addresses":{"items":{"type":"string"},"type":"array","title":"To Addresses"},"cc_addresses":{"items":{"type":"string"},"type":"array","title":"Cc Addresses"},"bcc_addresses":{"items":{"type":"string"},"type":"array","title":"Bcc Addresses"},"subject":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subject"},"snippet":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Snippet"},"has_attachments":{"type":"boolean","title":"Has Attachments","default":false},"attachment_count":{"type":"integer","minimum":0.0,"title":"Attachment Count","default":0},"generation":{"type":"integer","minimum":1.0,"title":"Generation"},"send_state":{"$ref":"#/components/schemas/DraftSendState"},"track_opens":{"type":"boolean","title":"Track Opens","default":false},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"body_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Body Text"},"body_html":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Body Html"},"reply_to":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reply To"},"thread_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Thread Id"},"message_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message Id"},"in_reply_to":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"In Reply To"},"references":{"items":{"type":"string"},"type":"array","title":"References"},"forward_source_message_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Forward Source Message Id"},"forward_note_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Forward Note Text"},"forward_note_html":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Forward Note Html"},"attachment_metadata":{"items":{"$ref":"#/components/schemas/DraftAttachmentResponse"},"type":"array","title":"Attachment Metadata"}},"type":"object","required":["id","mailbox_id","from_address","generation","send_state","created_at","updated_at"],"title":"DraftDetailResponse"},"DraftGenerationRequest":{"properties":{"generation":{"type":"integer","minimum":1.0,"title":"Generation"}},"type":"object","required":["generation"],"title":"DraftGenerationRequest"},"DraftListResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/DraftSummaryResponse"},"type":"array","title":"Items"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor"},"has_more":{"type":"boolean","title":"Has More","default":false}},"type":"object","title":"DraftListResponse"},"DraftRecipients":{"properties":{"to":{"anyOf":[{"items":{"type":"string","format":"email"},"type":"array"},{"type":"null"}],"title":"To"},"cc":{"anyOf":[{"items":{"type":"string","format":"email"},"type":"array"},{"type":"null"}],"title":"Cc"},"bcc":{"anyOf":[{"items":{"type":"string","format":"email"},"type":"array"},{"type":"null"}],"title":"Bcc"}},"type":"object","title":"DraftRecipients"},"DraftSendState":{"type":"string","enum":["draft","sending","uncertain"],"title":"DraftSendState"},"DraftSummaryResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"mailbox_id":{"type":"string","format":"uuid","title":"Mailbox Id"},"from_address":{"type":"string","title":"From Address"},"to_addresses":{"items":{"type":"string"},"type":"array","title":"To Addresses"},"cc_addresses":{"items":{"type":"string"},"type":"array","title":"Cc Addresses"},"bcc_addresses":{"items":{"type":"string"},"type":"array","title":"Bcc Addresses"},"subject":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subject"},"snippet":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Snippet"},"has_attachments":{"type":"boolean","title":"Has Attachments","default":false},"attachment_count":{"type":"integer","minimum":0.0,"title":"Attachment Count","default":0},"generation":{"type":"integer","minimum":1.0,"title":"Generation"},"send_state":{"$ref":"#/components/schemas/DraftSendState"},"track_opens":{"type":"boolean","title":"Track Opens","default":false},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","mailbox_id","from_address","generation","send_state","created_at","updated_at"],"title":"DraftSummaryResponse"},"DraftUpdate":{"properties":{"generation":{"type":"integer","minimum":1.0,"title":"Generation"},"recipients":{"anyOf":[{"$ref":"#/components/schemas/DraftRecipients"},{"type":"null"}]},"subject":{"anyOf":[{"type":"string","maxLength":998},{"type":"null"}],"title":"Subject"},"body_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Body Text"},"body_html":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Body Html"},"reply_to":{"anyOf":[{"type":"string","format":"email"},{"type":"null"}],"title":"Reply To"},"thread_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Thread Id"},"in_reply_to_message_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"In Reply To Message Id"},"references":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"References"},"track_opens":{"type":"boolean","title":"Track Opens","default":false},"forward_note_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Forward Note Text"},"forward_note_html":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Forward Note Html"}},"type":"object","required":["generation"],"title":"DraftUpdate"},"ForwardMode":{"type":"string","enum":["inline","wrapped"],"title":"ForwardMode"},"MailContactRuleResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"mailbox_id":{"type":"string","format":"uuid","title":"Mailbox Id"},"action":{"$ref":"#/components/schemas/MailRuleAction"},"match_type":{"$ref":"#/components/schemas/MailRuleMatchType"},"match_target":{"type":"string","title":"Match Target"},"status":{"$ref":"#/components/schemas/ResourceStatus"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","mailbox_id","action","match_type","match_target","status","created_at","updated_at"],"title":"MailContactRuleResponse"},"MailImportFormat":{"type":"string","enum":["mbox","eml","zip","auto"],"title":"MailImportFormat"},"MailImportJobCreateRequest":{"properties":{"source_format":{"$ref":"#/components/schemas/MailImportFormat","default":"auto"},"original_addresses":{"anyOf":[{"items":{"type":"string","format":"email"},"type":"array","maxItems":20},{"type":"null"}],"title":"Original Addresses"},"mark_as_read":{"type":"boolean","title":"Mark As Read","default":true}},"type":"object","title":"MailImportJobCreateRequest"},"MailImportJobCreateResponse":{"properties":{"job":{"$ref":"#/components/schemas/MailImportJobResponse"},"upload":{"$ref":"#/components/schemas/MailImportUploadTarget"}},"type":"object","required":["job","upload"],"title":"MailImportJobCreateResponse"},"MailImportJobResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"mailbox_id":{"type":"string","format":"uuid","title":"Mailbox Id"},"status":{"$ref":"#/components/schemas/MailImportJobStatus"},"source_format":{"$ref":"#/components/schemas/MailImportFormat"},"original_addresses":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Original Addresses"},"mark_as_read":{"type":"boolean","title":"Mark As Read"},"upload_size_bytes":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Upload Size Bytes"},"messages_processed":{"type":"integer","title":"Messages Processed"},"messages_imported":{"type":"integer","title":"Messages Imported"},"messages_skipped_duplicate":{"type":"integer","title":"Messages Skipped Duplicate"},"messages_failed":{"type":"integer","title":"Messages Failed"},"messages_rejected_unsafe":{"type":"integer","title":"Messages Rejected Unsafe"},"error_detail":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error Detail"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"started_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Started At"},"finished_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Finished At"}},"type":"object","required":["id","mailbox_id","status","source_format","mark_as_read","messages_processed","messages_imported","messages_skipped_duplicate","messages_failed","messages_rejected_unsafe","created_at","updated_at"],"title":"MailImportJobResponse"},"MailImportJobStatus":{"type":"string","enum":["pending_upload","queued","running","completed","failed","cancelled"],"title":"MailImportJobStatus"},"MailImportUploadTarget":{"properties":{"url":{"type":"string","title":"Url"},"fields":{"additionalProperties":{"type":"string"},"type":"object","title":"Fields"},"expires_in_seconds":{"type":"integer","title":"Expires In Seconds"}},"type":"object","required":["url","fields","expires_in_seconds"],"title":"MailImportUploadTarget"},"MailboxUpdateRequest":{"properties":{"filter_mode":{"anyOf":[{"$ref":"#/components/schemas/FilterMode"},{"type":"null"}],"description":"Contact-rule filter mode. 'whitelist' = only counterparties matching an active rule are allowed; 'blacklist' = all counterparties are allowed except those matching an active rule. Applies symmetrically to inbound receipt and outbound send. Modifying this field requires an admin-scoped API key. Omit to leave unchanged; explicit null is rejected (the column is NOT NULL)."}},"additionalProperties":false,"type":"object","title":"MailboxUpdateRequest"},"MessageDetailResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"mailbox_id":{"type":"string","format":"uuid","title":"Mailbox Id"},"thread_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Thread Id"},"message_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message Id"},"from_address":{"type":"string","title":"From Address"},"to_addresses":{"items":{"type":"string"},"type":"array","title":"To Addresses"},"cc_addresses":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Cc Addresses"},"subject":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subject"},"snippet":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Snippet"},"direction":{"$ref":"#/components/schemas/MessageDirection"},"status":{"$ref":"#/components/schemas/MessageStatus"},"is_read":{"type":"boolean","title":"Is Read"},"is_starred":{"type":"boolean","title":"Is Starred"},"has_attachments":{"type":"boolean","title":"Has Attachments"},"reply_to":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reply To"},"first_opened_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"First Opened At"},"open_count":{"type":"integer","title":"Open Count","default":0},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"sending_domain_warning":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sending Domain Warning"},"import_job_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Import Job Id"},"body_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Body Text"},"body_html":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Body Html"},"bcc_addresses":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Bcc Addresses"},"in_reply_to":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"In Reply To"},"references":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"References"},"attachment_metadata":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Attachment Metadata"},"ses_message_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ses Message Id"},"reply_all_recipients":{"anyOf":[{"$ref":"#/components/schemas/ReplyAllRecipients"},{"type":"null"}]}},"type":"object","required":["id","mailbox_id","thread_id","from_address","to_addresses","cc_addresses","subject","snippet","direction","status","is_read","is_starred","has_attachments","created_at","updated_at"],"title":"MessageDetailResponse"},"MessageFlagsUpdate":{"properties":{"is_read":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Read"},"is_starred":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Starred"}},"type":"object","title":"MessageFlagsUpdate"},"MessageForward":{"properties":{"recipients":{"$ref":"#/components/schemas/Recipients"},"mode":{"$ref":"#/components/schemas/ForwardMode","default":"inline"},"subject":{"anyOf":[{"type":"string","maxLength":998},{"type":"null"}],"title":"Subject"},"body_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Body Text"},"body_html":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Body Html"},"additional_attachments":{"anyOf":[{"items":{"$ref":"#/components/schemas/AttachmentUpload"},"type":"array"},{"type":"null"}],"title":"Additional Attachments"},"additional_staged_attachments":{"anyOf":[{"items":{"$ref":"#/components/schemas/StagedAttachmentReference"},"type":"array","maxItems":50},{"type":"null"}],"title":"Additional Staged Attachments"},"include_original_attachments":{"type":"boolean","title":"Include Original Attachments","default":true},"reply_to":{"anyOf":[{"type":"string","format":"email"},{"type":"null"}],"title":"Reply To"},"track_opens":{"type":"boolean","title":"Track Opens","description":"Embed an open-tracking pixel in the forward's HTML body. The outgoing forward must have an HTML part (the caller note in wrapped mode; caller note or original HTML in inline mode); rejected with 422 otherwise.","default":false}},"type":"object","required":["recipients"],"title":"MessageForward"},"MessageReplyAll":{"properties":{"subject":{"anyOf":[{"type":"string","maxLength":998},{"type":"null"}],"title":"Subject"},"body_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Body Text"},"body_html":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Body Html"},"attachments":{"anyOf":[{"items":{"$ref":"#/components/schemas/AttachmentUpload"},"type":"array"},{"type":"null"}],"title":"Attachments"},"staged_attachments":{"anyOf":[{"items":{"$ref":"#/components/schemas/StagedAttachmentReference"},"type":"array","maxItems":50},{"type":"null"}],"title":"Staged Attachments"},"reply_to":{"anyOf":[{"type":"string","format":"email"},{"type":"null"}],"title":"Reply To"},"approved_recipients":{"anyOf":[{"$ref":"#/components/schemas/Recipients"},{"type":"null"}]},"track_opens":{"type":"boolean","title":"Track Opens","default":false}},"type":"object","title":"MessageReplyAll"},"MessageResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"mailbox_id":{"type":"string","format":"uuid","title":"Mailbox Id"},"thread_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Thread Id"},"message_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message Id"},"from_address":{"type":"string","title":"From Address"},"to_addresses":{"items":{"type":"string"},"type":"array","title":"To Addresses"},"cc_addresses":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Cc Addresses"},"subject":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subject"},"snippet":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Snippet"},"direction":{"$ref":"#/components/schemas/MessageDirection"},"status":{"$ref":"#/components/schemas/MessageStatus"},"is_read":{"type":"boolean","title":"Is Read"},"is_starred":{"type":"boolean","title":"Is Starred"},"has_attachments":{"type":"boolean","title":"Has Attachments"},"reply_to":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reply To"},"first_opened_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"First Opened At"},"open_count":{"type":"integer","title":"Open Count","default":0},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"},"sending_domain_warning":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sending Domain Warning"},"import_job_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Import Job Id"}},"type":"object","required":["id","mailbox_id","thread_id","from_address","to_addresses","cc_addresses","subject","snippet","direction","status","is_read","is_starred","has_attachments","created_at"],"title":"MessageResponse"},"MessageSend":{"properties":{"recipients":{"$ref":"#/components/schemas/Recipients"},"subject":{"type":"string","maxLength":998,"title":"Subject"},"body_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Body Text"},"body_html":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Body Html"},"thread_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Thread Id","description":"Attach this message to an existing conversation. Preferred over in_reply_to_message_id when replying; pass the thread_id returned by the list/get endpoints."},"in_reply_to_message_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"In Reply To Message Id","description":"Message-ID of the email being replied to"},"attachments":{"anyOf":[{"items":{"$ref":"#/components/schemas/AttachmentUpload"},"type":"array"},{"type":"null"}],"title":"Attachments"},"staged_attachments":{"anyOf":[{"items":{"$ref":"#/components/schemas/StagedAttachmentReference"},"type":"array","maxItems":50},{"type":"null"}],"title":"Staged Attachments"},"reply_to":{"anyOf":[{"type":"string","format":"email"},{"type":"null"}],"title":"Reply To","description":"Optional Reply-To address. If set, recipients' mail clients route replies here instead of the From mailbox."},"track_opens":{"type":"boolean","title":"Track Opens","description":"Embed an open-tracking pixel in the HTML body. Requires body_html; a send with track_opens and no HTML body is rejected with 422. Opens surface as first_opened_at/open_count on the message. Note: tracking pixels can raise spam scores.","default":false}},"type":"object","required":["recipients","subject"],"title":"MessageSend"},"Recipients":{"properties":{"to":{"anyOf":[{"items":{"type":"string","format":"email"},"type":"array"},{"type":"null"}],"title":"To"},"cc":{"anyOf":[{"items":{"type":"string","format":"email"},"type":"array"},{"type":"null"}],"title":"Cc"},"bcc":{"anyOf":[{"items":{"type":"string","format":"email"},"type":"array"},{"type":"null"}],"title":"Bcc"}},"type":"object","title":"Recipients"},"ReplyAllRecipients":{"properties":{"to":{"items":{"type":"string"},"type":"array","title":"To"},"cc":{"items":{"type":"string"},"type":"array","title":"Cc"}},"type":"object","title":"ReplyAllRecipients"},"SafeMessageResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"mailbox_id":{"type":"string","format":"uuid","title":"Mailbox Id"},"thread_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Thread Id"},"message_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message Id"},"from_address":{"type":"string","title":"From Address"},"reply_to":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reply To"},"to_addresses":{"items":{"type":"string"},"type":"array","title":"To Addresses"},"cc_addresses":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Cc Addresses"},"subject":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subject"},"snippet":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Snippet"},"direction":{"$ref":"#/components/schemas/MessageDirection"},"status":{"$ref":"#/components/schemas/MessageStatus"},"is_read":{"type":"boolean","title":"Is Read"},"is_starred":{"type":"boolean","title":"Is Starred"},"has_attachments":{"type":"boolean","title":"Has Attachments"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","mailbox_id","thread_id","message_id","from_address","reply_to","to_addresses","cc_addresses","subject","snippet","direction","status","is_read","is_starred","has_attachments","created_at","updated_at"],"title":"SafeMessageResponse"},"StagedAttachmentReference":{"properties":{"media_handle":{"type":"string","format":"uuid","title":"Media Handle"},"filename":{"type":"string","maxLength":255,"minLength":1,"title":"Filename"},"content_hash":{"type":"string","pattern":"^[0-9a-fA-F]{64}$","title":"Content Hash"},"content_type":{"type":"string","maxLength":255,"minLength":3,"title":"Content Type"},"content_id":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Content Id"}},"type":"object","required":["media_handle","filename","content_hash","content_type"],"title":"StagedAttachmentReference"},"ThreadDetailResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"mailbox_id":{"type":"string","format":"uuid","title":"Mailbox Id"},"subject":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subject"},"folder":{"$ref":"#/components/schemas/ThreadFolder"},"message_count":{"type":"integer","title":"Message Count"},"last_message_at":{"type":"string","format":"date-time","title":"Last Message At"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"messages":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","title":"Messages"}},"type":"object","required":["id","mailbox_id","subject","folder","message_count","last_message_at","created_at"],"title":"ThreadDetailResponse"},"ThreadFolder":{"type":"string","enum":["inbox","spam","blocked","archive"],"title":"ThreadFolder"},"ThreadResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"mailbox_id":{"type":"string","format":"uuid","title":"Mailbox Id"},"subject":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subject"},"folder":{"$ref":"#/components/schemas/ThreadFolder"},"message_count":{"type":"integer","title":"Message Count"},"last_message_at":{"type":"string","format":"date-time","title":"Last Message At"},"created_at":{"type":"string","format":"date-time","title":"Created At"}},"type":"object","required":["id","mailbox_id","subject","folder","message_count","last_message_at","created_at"],"title":"ThreadResponse"},"ThreadUpdateRequest":{"properties":{"folder":{"anyOf":[{"$ref":"#/components/schemas/ThreadFolder"},{"type":"null"}]}},"type":"object","title":"ThreadUpdateRequest"},"NoteAccessGrantRequest":{"properties":{"identity_id":{"type":"string","format":"uuid","title":"Identity Id"}},"additionalProperties":false,"type":"object","required":["identity_id"],"title":"NoteAccessGrantRequest"},"NoteAccessResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"note_id":{"type":"string","format":"uuid","title":"Note Id"},"identity_id":{"type":"string","format":"uuid","title":"Identity Id"},"created_at":{"type":"string","format":"date-time","title":"Created At"}},"type":"object","required":["id","note_id","identity_id","created_at"],"title":"NoteAccessResponse"},"NoteCreateRequest":{"properties":{"title":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Title"},"body":{"type":"string","maxLength":100000,"minLength":1,"title":"Body"}},"additionalProperties":false,"type":"object","required":["body"],"title":"NoteCreateRequest"},"NoteResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"organization_id":{"type":"string","title":"Organization Id"},"created_by":{"type":"string","title":"Created By"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"},"body":{"type":"string","title":"Body"},"status":{"$ref":"#/components/schemas/ResourceStatus"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"access":{"items":{"$ref":"#/components/schemas/NoteAccessResponse"},"type":"array","title":"Access","description":"Raw ``note_access`` rows for this note, inlined so the console can skip a follow-up ``GET /notes/{id}/access`` per row. Empty when the note has zero grants (typical for human-authored notes); not a 'not loaded' sentinel — every response path populates this field."}},"type":"object","required":["id","organization_id","created_by","title","body","status","created_at","updated_at"],"title":"NoteResponse"},"NoteUpdateRequest":{"properties":{"title":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Title"},"body":{"anyOf":[{"type":"string","maxLength":100000,"minLength":1},{"type":"null"}],"title":"Body"}},"additionalProperties":false,"type":"object","title":"NoteUpdateRequest"},"CallCommandResponse":{"properties":{"call_id":{"type":"string","format":"uuid","title":"Call Id"},"state":{"type":"string","enum":["queued","hangup_queued"],"title":"State"}},"type":"object","required":["call_id","state"],"title":"CallCommandResponse"},"CallSettingsProjection":{"properties":{"agent_identity_id":{"type":"string","format":"uuid","title":"Agent Identity Id"},"incoming_call_action":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Incoming Call Action"},"client_websocket_configured":{"type":"boolean","title":"Client Websocket Configured"},"incoming_webhook_configured":{"type":"boolean","title":"Incoming Webhook Configured"},"forwarding_target_type":{"anyOf":[{"type":"string","enum":["phone","sip"]},{"type":"null"}],"title":"Forwarding Target Type"},"forwarding_target":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Forwarding Target"},"hosted_agent":{"$ref":"#/components/schemas/HostedAgentSettingsProjection"}},"type":"object","required":["agent_identity_id","incoming_call_action","client_websocket_configured","incoming_webhook_configured","hosted_agent"],"title":"CallSettingsProjection"},"HostedAgentAuthorityModeInput":{"properties":{"agent_identity_id":{"type":"string","title":"Agent Identity Id"},"authority_mode":{"$ref":"#/components/schemas/HostedAgentAuthorityMode"}},"additionalProperties":false,"type":"object","required":["agent_identity_id","authority_mode"],"title":"HostedAgentAuthorityModeInput"},"HostedAgentConfig":{"properties":{"agent_identity_id":{"type":"string","title":"Agent Identity Id"},"voice":{"anyOf":[{"$ref":"#/components/schemas/HostedAgentVoice"},{"type":"null"}]},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model","description":"Compatibility field; accepted values are not stored or used.","deprecated":true},"effective_voice":{"$ref":"#/components/schemas/HostedAgentVoice"},"effective_model":{"type":"string","title":"Effective Model","description":"Server-selected model used for hosted calls."},"instructions":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instructions"},"authority_mode":{"$ref":"#/components/schemas/HostedAgentAuthorityMode","default":"contact_scoped"}},"type":"object","required":["agent_identity_id","effective_voice","effective_model"],"title":"HostedAgentConfig"},"HostedAgentConfigInput":{"properties":{"agent_identity_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Agent Identity Id"},"voice":{"anyOf":[{"$ref":"#/components/schemas/HostedAgentVoice"},{"type":"null"}]},"model":{"anyOf":[{"type":"string","maxLength":128,"pattern":"^[a-zA-Z0-9._-]+$"},{"type":"null"}],"title":"Model","description":"Compatibility field; accepted but ignored.","deprecated":true},"instructions":{"anyOf":[{"type":"string","maxLength":8000},{"type":"null"}],"title":"Instructions"}},"additionalProperties":false,"type":"object","title":"HostedAgentConfigInput"},"HostedAgentSettingsProjection":{"properties":{"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model","description":"Compatibility field; always null.","deprecated":true},"voice":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Voice"},"effective_model":{"type":"string","title":"Effective Model","description":"Server-selected model used for hosted calls."},"effective_voice":{"type":"string","title":"Effective Voice"},"instructions_configured":{"type":"boolean","title":"Instructions Configured"}},"type":"object","required":["model","voice","effective_model","effective_voice","instructions_configured"],"title":"HostedAgentSettingsProjection"},"HostedAgentToolInvocationProjection":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"call_id":{"type":"string","format":"uuid","title":"Call Id"},"tool_name":{"type":"string","title":"Tool Name"},"status":{"type":"string","enum":["started","succeeded","failed"],"title":"Status"},"result":{"anyOf":[{"additionalProperties":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"boolean"},{"type":"null"}]},"type":"object"},{"type":"null"}],"title":"Result"},"started_at":{"type":"string","format":"date-time","title":"Started At"},"completed_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Completed At"}},"type":"object","required":["id","call_id","tool_name","status","result","started_at","completed_at"],"title":"HostedAgentToolInvocationProjection"},"HostedAgentToolInvocationProjectionPage":{"properties":{"items":{"items":{"$ref":"#/components/schemas/HostedAgentToolInvocationProjection"},"type":"array","title":"Items"},"limit":{"type":"integer","title":"Limit"},"offset":{"type":"integer","title":"Offset"},"has_more":{"type":"boolean","title":"Has More"}},"type":"object","required":["items","limit","offset","has_more"],"title":"HostedAgentToolInvocationProjectionPage"},"HostedAgentVoice":{"type":"string","enum":["alloy","ash","ballad","coral","echo","sage","shimmer","verse","marin","cedar"],"title":"HostedAgentVoice"},"IncomingCallActionRequest":{"properties":{"incoming_call_action":{"$ref":"#/components/schemas/IncomingCallAction"},"agent_identity_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Agent Identity Id"},"client_websocket_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Websocket Url"},"incoming_call_webhook_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Incoming Call Webhook Url"},"forwarding_target_type":{"anyOf":[{"$ref":"#/components/schemas/ForwardingTargetType"},{"type":"null"}]},"forwarding_phone_number":{"anyOf":[{"type":"string","description":"Phone number in E.164 format (e.g. '+15551234567').","examples":["+15551234567"]},{"type":"null"}],"title":"Forwarding Phone Number"},"forwarding_sip_uri":{"anyOf":[{"type":"string","maxLength":512,"description":"Complete SIP destination in sip:user@host format.","examples":["sip:line@voice.example.com"]},{"type":"null"}],"title":"Forwarding Sip Uri"}},"additionalProperties":false,"type":"object","required":["incoming_call_action"],"title":"IncomingCallActionRequest"},"IncomingCallActionResponse":{"properties":{"agent_identity_id":{"type":"string","format":"uuid","title":"Agent Identity Id"},"incoming_call_action":{"$ref":"#/components/schemas/IncomingCallAction"},"client_websocket_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Websocket Url"},"incoming_call_webhook_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Incoming Call Webhook Url"},"forwarding_target_type":{"anyOf":[{"$ref":"#/components/schemas/ForwardingTargetType"},{"type":"null"}]},"forwarding_phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Forwarding Phone Number"},"forwarding_sip_uri":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Forwarding Sip Uri"}},"type":"object","required":["agent_identity_id","incoming_call_action","client_websocket_url","incoming_call_webhook_url"],"title":"IncomingCallActionResponse"},"PhoneCallResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"origin":{"$ref":"#/components/schemas/CallOrigin","default":"dedicated_number"},"local_phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Local Phone Number"},"remote_phone_number":{"type":"string","title":"Remote Phone Number"},"direction":{"$ref":"#/components/schemas/CallDirection"},"status":{"$ref":"#/components/schemas/CallStatus"},"client_websocket_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Websocket Url"},"mode":{"$ref":"#/components/schemas/CallMode","default":"client_websocket"},"hosted_agent_authority_mode":{"$ref":"#/components/schemas/HostedAgentAuthorityMode","default":"contact_scoped"},"voicemail_detection":{"$ref":"#/components/schemas/VoicemailDetection","default":"enabled"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"post_call_action_items":{"items":{"$ref":"#/components/schemas/PostCallActionResponse"},"type":"array","title":"Post Call Action Items"},"forwardings":{"items":{"$ref":"#/components/schemas/PhoneCallForwardingResponse"},"type":"array","title":"Forwardings"},"use_inkbox_tts":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Use Inkbox Tts"},"use_inkbox_stt":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Use Inkbox Stt"},"hangup_reason":{"anyOf":[{"$ref":"#/components/schemas/HangupReason"},{"type":"null"}]},"started_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Started At"},"ended_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Ended At"},"is_blocked":{"type":"boolean","title":"Is Blocked","default":false},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","remote_phone_number","direction","status","client_websocket_url","use_inkbox_tts","use_inkbox_stt","started_at","ended_at","created_at","updated_at"],"title":"PhoneCallResponse"},"PhoneCallWithRateLimitResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"origin":{"$ref":"#/components/schemas/CallOrigin","default":"dedicated_number"},"local_phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Local Phone Number"},"remote_phone_number":{"type":"string","title":"Remote Phone Number"},"direction":{"$ref":"#/components/schemas/CallDirection"},"status":{"$ref":"#/components/schemas/CallStatus"},"client_websocket_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Websocket Url"},"mode":{"$ref":"#/components/schemas/CallMode","default":"client_websocket"},"hosted_agent_authority_mode":{"$ref":"#/components/schemas/HostedAgentAuthorityMode","default":"contact_scoped"},"voicemail_detection":{"$ref":"#/components/schemas/VoicemailDetection","default":"enabled"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"post_call_action_items":{"items":{"$ref":"#/components/schemas/PostCallActionResponse"},"type":"array","title":"Post Call Action Items"},"forwardings":{"items":{"$ref":"#/components/schemas/PhoneCallForwardingResponse"},"type":"array","title":"Forwardings"},"use_inkbox_tts":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Use Inkbox Tts"},"use_inkbox_stt":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Use Inkbox Stt"},"hangup_reason":{"anyOf":[{"$ref":"#/components/schemas/HangupReason"},{"type":"null"}]},"started_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Started At"},"ended_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Ended At"},"is_blocked":{"type":"boolean","title":"Is Blocked","default":false},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"rate_limit":{"$ref":"#/components/schemas/RateLimitInfo"}},"type":"object","required":["id","remote_phone_number","direction","status","client_websocket_url","use_inkbox_tts","use_inkbox_stt","started_at","ended_at","created_at","updated_at","rate_limit"],"title":"PhoneCallWithRateLimitResponse"},"PhoneContactRuleResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"phone_number_id":{"type":"string","format":"uuid","title":"Phone Number Id"},"action":{"$ref":"#/components/schemas/PhoneRuleAction"},"match_type":{"$ref":"#/components/schemas/PhoneRuleMatchType"},"match_target":{"type":"string","title":"Match Target"},"status":{"$ref":"#/components/schemas/ResourceStatus"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","phone_number_id","action","match_type","match_target","status","created_at","updated_at"],"title":"PhoneContactRuleResponse"},"PhoneNumberUpdateRequest":{"properties":{"incoming_call_action":{"anyOf":[{"$ref":"#/components/schemas/IncomingCallAction"},{"type":"null"}],"description":"How to handle inbound calls: auto_accept, auto_reject, webhook, hosted_agent, or forward with one phone or SIP destination."},"client_websocket_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Websocket Url","description":"WebSocket URL (wss://) for audio bridging on auto_accept."},"incoming_call_webhook_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Incoming Call Webhook Url","description":"Webhook URL for incoming call notifications. Set to null to unsubscribe."},"forwarding_target_type":{"anyOf":[{"$ref":"#/components/schemas/ForwardingTargetType"},{"type":"null"}]},"forwarding_phone_number":{"anyOf":[{"type":"string","description":"Phone number in E.164 format (e.g. '+15551234567').","examples":["+15551234567"]},{"type":"null"}],"title":"Forwarding Phone Number"},"forwarding_sip_uri":{"anyOf":[{"type":"string","maxLength":512,"description":"Complete SIP destination in sip:user@host format.","examples":["sip:line@voice.example.com"]},{"type":"null"}],"title":"Forwarding Sip Uri"},"filter_mode":{"anyOf":[{"$ref":"#/components/schemas/FilterMode"},{"type":"null"}],"description":"Contact-rule filter mode (single field; covers both voice calls and SMS). 'whitelist' = only counterparties matching an active rule are allowed; 'blacklist' = all counterparties are allowed except those matching an active rule. Applies symmetrically to inbound receipt and outbound dial/send. Modifying this field requires an admin-scoped API key."}},"additionalProperties":false,"type":"object","title":"PhoneNumberUpdateRequest"},"PhoneTranscriptResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"call_id":{"type":"string","format":"uuid","title":"Call Id"},"seq":{"type":"integer","title":"Seq"},"ts_ms":{"type":"integer","title":"Ts Ms"},"party":{"$ref":"#/components/schemas/TranscriptParty"},"text":{"type":"string","title":"Text"},"created_at":{"type":"string","format":"date-time","title":"Created At"}},"type":"object","required":["id","call_id","seq","ts_ms","party","text","created_at"],"title":"PhoneTranscriptResponse"},"PlaceCallRequest":{"properties":{"origination":{"$ref":"#/components/schemas/CallOrigin","description":"Line backing the call: dedicated_number | shared_imessage_number | dedicated_imessage_number. The dedicated iMessage line calls anyone (contact rules only) and surfaces its number as caller ID.","default":"dedicated_number"},"from_number":{"anyOf":[{"type":"string","description":"Phone number in E.164 format (e.g. '+15551234567').","examples":["+15551234567"]},{"type":"null"}],"title":"From Number","description":"Source phone number, in E.164 format. Required for dedicated_number origination."},"to_number":{"type":"string","title":"To Number","description":"Destination phone number to dial, in E.164 format.","examples":["+15551234567"]},"agent_identity_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Agent Identity Id","description":"Agent identity placing the call (required for shared_imessage_number under admin/JWT)."},"client_websocket_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Websocket Url","description":"WebSocket URL (wss://) for audio bridging. Falls back to phone number's client_websocket_url."},"mode":{"$ref":"#/components/schemas/CallMode","description":"Who runs the call: client_websocket (your agent over the media WebSocket, default) or hosted_agent (the platform-hosted call agent).","default":"client_websocket"},"hosted_agent_authority_mode":{"anyOf":[{"$ref":"#/components/schemas/HostedAgentAuthorityMode"},{"type":"null"}],"description":"Optional hosted-agent data-scope override: contact_scoped or yolo. Omit to inherit the identity's saved default."},"voicemail_detection":{"$ref":"#/components/schemas/VoicemailDetection","description":"Whether to hang up when voicemail is detected: enabled (default) or disabled.","default":"enabled"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason","description":"Task brief for the hosted agent, e.g. what to accomplish on the call. Required with mode=hosted_agent; invalid otherwise."}},"type":"object","required":["to_number"],"title":"PlaceCallRequest"},"PostCallActionResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"seq":{"type":"integer","title":"Seq"},"action":{"type":"string","title":"Action"},"details":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Details"},"status":{"$ref":"#/components/schemas/PostCallActionStatus","default":"open"}},"type":"object","required":["id","seq","action"],"title":"PostCallActionResponse"},"ProvisionPhoneNumberRequest":{"properties":{"agent_handle":{"type":"string","title":"Agent Handle","description":"Agent identity handle to assign this number to (e.g. 'sales-agent' or '@sales-agent')."},"type":{"$ref":"#/components/schemas/NumberType","description":"Type of phone number to provision. Only 'local' is supported; toll-free is no longer offered.","default":"local"},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"US state abbreviation (e.g. 'NY', 'CA'). Only used for local numbers."},"incoming_call_action":{"$ref":"#/components/schemas/IncomingCallAction","description":"How to handle inbound calls: hosted_agent (the platform voice agent answers, zero setup — the default wherever the hosted agent is available, so the number is callable right away), auto_accept, auto_reject, webhook, or forward with one phone or SIP destination."},"client_websocket_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Websocket Url","description":"WebSocket URL (wss://) for audio bridging. Required when incoming_call_action is 'auto_accept'."},"incoming_call_webhook_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Incoming Call Webhook Url","description":"Webhook URL for incoming call notifications. Required when incoming_call_action is 'webhook'."},"forwarding_target_type":{"anyOf":[{"$ref":"#/components/schemas/ForwardingTargetType"},{"type":"null"}]},"forwarding_phone_number":{"anyOf":[{"type":"string","description":"Phone number in E.164 format (e.g. '+15551234567').","examples":["+15551234567"]},{"type":"null"}],"title":"Forwarding Phone Number"},"forwarding_sip_uri":{"anyOf":[{"type":"string","maxLength":512,"description":"Complete SIP destination in sip:user@host format.","examples":["sip:line@voice.example.com"]},{"type":"null"}],"title":"Forwarding Sip Uri"}},"additionalProperties":false,"type":"object","required":["agent_handle"],"title":"ProvisionPhoneNumberRequest"},"RecipientResponse":{"properties":{"recipient_phone_number":{"type":"string","title":"Recipient Phone Number"},"delivery_status":{"anyOf":[{"$ref":"#/components/schemas/SmsDeliveryStatus"},{"type":"null"}]},"carrier":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Carrier"},"line_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line Type"},"error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error Code"},"error_detail":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error Detail"},"sent_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Sent At"},"delivered_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Delivered At"},"failed_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Failed At"}},"type":"object","required":["recipient_phone_number"],"title":"RecipientResponse"},"SendTextRequest":{"properties":{"to":{"anyOf":[{"type":"string","description":"Phone number in E.164 format (e.g. '+15551234567').","examples":["+15551234567"]},{"items":{"type":"string","description":"Phone number in E.164 format (e.g. '+15551234567').","examples":["+15551234567"]},"type":"array"},{"type":"null"}],"title":"To","description":"One recipient (1:1) or a list of 1–8 recipients (1:1 with N=1, or group MMS when N≥2). Each recipient is an E.164 number. Mutually exclusive with ``conversation_id``."},"conversation_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Conversation Id","description":"Existing conversation to reply into. The server resolves this to the conversation's participants list and sends to all of them. Mutually exclusive with ``to``."},"text":{"anyOf":[{"type":"string","maxLength":1600},{"type":"null"}],"title":"Text"},"media_urls":{"anyOf":[{"items":{"type":"string"},"type":"array","maxItems":10},{"type":"null"}],"title":"Media Urls","description":"Publicly-fetchable media URLs to attach"},"staged_media":{"items":{"$ref":"#/components/schemas/StagedTextMediaBinding"},"type":"array","maxItems":10,"title":"Staged Media"}},"type":"object","title":"SendTextRequest"},"SmsOptInResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"organization_id":{"type":"string","title":"Organization Id"},"receiver_number":{"type":"string","title":"Receiver Number"},"status":{"$ref":"#/components/schemas/SmsOptInStatus"},"source":{"$ref":"#/components/schemas/SmsOptInSource"},"opted_in_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Opted In At"},"opted_out_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Opted Out At"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","organization_id","receiver_number","status","source","opted_in_at","opted_out_at","created_at","updated_at"],"title":"SmsOptInResponse"},"SmsOptInSource":{"type":"string","enum":["sms","api"],"title":"SmsOptInSource"},"SmsOptInStatus":{"type":"string","enum":["opted_in","opted_out"],"title":"SmsOptInStatus"},"StagedTextMediaBinding":{"properties":{"handle":{"type":"string","title":"Handle"},"content_hash":{"type":"string","pattern":"^[0-9a-f]{64}$","title":"Content Hash"}},"additionalProperties":false,"type":"object","required":["handle","content_hash"],"title":"StagedTextMediaBinding"},"TextConversationSummary":{"properties":{"remote_phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remote Phone Number"},"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id"},"participants":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Participants"},"is_group":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Group"},"latest_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Latest Text"},"latest_direction":{"$ref":"#/components/schemas/TextDirection"},"latest_type":{"$ref":"#/components/schemas/TextType"},"latest_has_media":{"type":"boolean","title":"Latest Has Media","default":false},"latest_message_at":{"type":"string","format":"date-time","title":"Latest Message At"},"unread_count":{"type":"integer","title":"Unread Count"},"total_count":{"type":"integer","title":"Total Count"}},"type":"object","required":["latest_text","latest_direction","latest_type","latest_message_at","unread_count","total_count"],"title":"TextConversationSummary"},"TextConversationUpdateRequest":{"properties":{"is_read":{"type":"boolean","title":"Is Read"}},"type":"object","required":["is_read"],"title":"TextConversationUpdateRequest"},"TextConversationUpdateResponse":{"properties":{"remote_phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remote Phone Number"},"conversation_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Conversation Id"},"is_read":{"type":"boolean","title":"Is Read"},"updated_count":{"type":"integer","title":"Updated Count"}},"type":"object","required":["is_read","updated_count"],"title":"TextConversationUpdateResponse"},"TextMessageResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"direction":{"$ref":"#/components/schemas/TextDirection"},"local_phone_number":{"type":"string","title":"Local Phone Number"},"remote_phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remote Phone Number"},"text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Text"},"type":{"$ref":"#/components/schemas/TextType"},"media":{"anyOf":[{"items":{"$ref":"#/components/schemas/TextMediaItem"},"type":"array"},{"type":"null"}],"title":"Media"},"is_read":{"type":"boolean","title":"Is Read"},"delivery_status":{"anyOf":[{"$ref":"#/components/schemas/SmsDeliveryStatus"},{"type":"null"}]},"origin":{"$ref":"#/components/schemas/TextMessageOrigin","default":"user_initiated"},"error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error Code"},"error_detail":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error Detail"},"sent_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Sent At"},"delivered_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Delivered At"},"failed_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Failed At"},"conversation_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Conversation Id"},"sender_phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sender Phone Number"},"recipients":{"anyOf":[{"items":{"$ref":"#/components/schemas/RecipientResponse"},"type":"array"},{"type":"null"}],"title":"Recipients"},"is_blocked":{"type":"boolean","title":"Is Blocked","default":false},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","direction","local_phone_number","text","type","media","is_read","created_at","updated_at"],"title":"TextMessageResponse"},"TextMessageUpdateRequest":{"properties":{"is_read":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Read"},"status":{"anyOf":[{"type":"string","const":"deleted"},{"type":"null"}],"title":"Status"}},"type":"object","title":"TextMessageUpdateRequest"},"TextSendCommandResponse":{"properties":{"message_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Message Id"},"conversation_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Conversation Id"},"recipients":{"items":{"type":"string"},"type":"array","title":"Recipients"},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type"},"delivery_status":{"type":"string","title":"Delivery Status"},"error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error"},"rule":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rule"},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message"}},"type":"object","required":["message_id","recipients","delivery_status"],"title":"TextSendCommandResponse"},"TranscriptParty":{"type":"string","enum":["local","remote"],"title":"TranscriptParty"},"AccountDeleteResponse":{"properties":{"dsr_request_id":{"type":"string","title":"Dsr Request Id"},"status":{"$ref":"#/components/schemas/DsrRequestStatus"},"request_type":{"$ref":"#/components/schemas/DsrRequestType"},"submitted_at":{"type":"string","format":"date-time","title":"Submitted At"},"fulfilled_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Fulfilled At"}},"type":"object","required":["dsr_request_id","status","request_type","submitted_at"],"title":"AccountDeleteResponse"},"DsrRequestStatus":{"type":"string","enum":["submitted","in_progress","fulfilled","failed"],"title":"DsrRequestStatus"},"DsrRequestType":{"type":"string","enum":["account_delete"],"title":"DsrRequestType"},"ListTunnelsResponse":{"properties":{"tunnels":{"items":{"$ref":"#/components/schemas/TunnelResponse"},"type":"array","title":"Tunnels"}},"type":"object","required":["tunnels"],"title":"ListTunnelsResponse"},"SignCsrRequest":{"properties":{"csr_pem":{"type":"string","title":"Csr Pem","description":"PEM-encoded CSR. CN must equal the tunnel hostname."}},"type":"object","required":["csr_pem"],"title":"SignCsrRequest"},"SignCsrResponse":{"properties":{"cert_pem":{"type":"string","title":"Cert Pem"},"chain_pem":{"type":"string","title":"Chain Pem"},"cert_fingerprint_sha256":{"type":"string","title":"Cert Fingerprint Sha256"},"cert_expires_at":{"type":"string","format":"date-time","title":"Cert Expires At"}},"type":"object","required":["cert_pem","chain_pem","cert_fingerprint_sha256","cert_expires_at"],"title":"SignCsrResponse"},"TunnelResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"organization_id":{"type":"string","title":"Organization Id"},"tunnel_name":{"type":"string","title":"Tunnel Name"},"agent_identity_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Agent Identity Id","description":"Identifier of the identity associated with this tunnel, when available."},"tls_mode":{"$ref":"#/components/schemas/TLSMode"},"cert_pem":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cert Pem"},"cert_fingerprint_sha256":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cert Fingerprint Sha256"},"cert_expires_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Cert Expires At"},"status":{"$ref":"#/components/schemas/TunnelStatus"},"last_connected_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Connected At"},"last_connected_ip_addr":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Connected Ip Addr","description":"Caller IP (leftmost X-Forwarded-For hop, falling back to the direct peer) recorded at the most recent /_system/hello."},"last_disconnected_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Disconnected At","description":"Best-effort timestamp of the most recently observed transition from connected to disconnected. Null means no disconnect has been recorded. Use ``currently_connected`` for current liveness."},"currently_connected":{"type":"boolean","title":"Currently Connected","description":"Live agent-connection state at read time: true if at least one agent connection is registered in Redis. Always resolved live on every tunnels endpoint — runtime state never appears as a stale placeholder. Identity payloads embed ``TunnelSummaryResponse`` instead, which carries no liveness."},"public_host":{"type":"string","title":"Public Host","description":"Per-tunnel public hostname, e.g. ``my-agent.inkboxwire.com`` in production (non-production environments include the environment label in the tunnel zone, e.g. ``my-agent.beta.inkboxwire.com``). Use this for constructing the public URL the third party hits."},"zone":{"type":"string","title":"Zone","description":"Tunnel zone host, e.g. ``inkboxwire.com`` in production. Use this as the data-plane h2 endpoint — the agent connects to ``https://{zone}/_system/connect``, not to ``https://{public_host}/_system/connect``."},"metadata":{"additionalProperties":true,"type":"object","title":"Metadata","description":"Customer-supplied free-form metadata, set via ``PATCH /tunnels/{id}`` with ``metadata={...}``. Returned as-is on read. Empty dict (``{}``) when unset or cleared. Capped at 4 KB serialized JSON; over-limit writes return 422."},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","organization_id","tunnel_name","tls_mode","status","currently_connected","public_host","zone","created_at","updated_at"],"title":"TunnelResponse"},"UpdateTunnelRequest":{"properties":{"metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metadata","description":"Free-form metadata dict; pass ``null`` or ``{}`` to clear (both clear to ``{}`` since the underlying column is non-nullable). Capped at 4 KB serialized JSON."}},"type":"object","title":"UpdateTunnelRequest"},"VaultInitializeRequest":{"properties":{"vault_key":{"$ref":"#/components/schemas/VaultKeyCreate","description":"The primary vault key to create alongside the vault."},"recovery_keys":{"items":{"$ref":"#/components/schemas/VaultKeyCreate"},"type":"array","maxItems":4,"minItems":4,"title":"Recovery Keys","description":"Exactly four recovery keys, each wrapping the same org encryption key with a different recovery-code-derived master key."}},"type":"object","required":["vault_key","recovery_keys"],"title":"VaultInitializeRequest"},"VaultInitializeResponse":{"properties":{"vault_id":{"type":"string","format":"uuid","title":"Vault Id"},"vault_key_id":{"type":"string","format":"uuid","title":"Vault Key Id"},"recovery_key_count":{"type":"integer","title":"Recovery Key Count"}},"type":"object","required":["vault_id","vault_key_id","recovery_key_count"],"title":"VaultInitializeResponse"},"VaultKeyCreate":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"wrapped_org_encryption_key":{"type":"string","title":"Wrapped Org Encryption Key","description":"AES-256-GCM ciphertext wrapping the org encryption key (base64)"},"auth_hash":{"type":"string","maxLength":64,"minLength":64,"pattern":"^[0-9a-f]{64}$","title":"Auth Hash","description":"SHA-256(masterKey) hex digest, required for server-side row lookup"},"key_type":{"$ref":"#/components/schemas/VaultKeyType","default":"primary"}},"type":"object","required":["id","wrapped_org_encryption_key","auth_hash"],"title":"VaultKeyCreate"},"VaultKeyResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"key_type":{"$ref":"#/components/schemas/VaultKeyType"},"created_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By"},"invalidated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Invalidated At"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","key_type","created_by","invalidated_at","created_at","updated_at"],"title":"VaultKeyResponse"},"VaultKeyType":{"type":"string","enum":["primary","recovery"],"title":"VaultKeyType"},"VaultKeyUpdateRequest":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"wrapped_org_encryption_key":{"type":"string","title":"Wrapped Org Encryption Key","description":"AES-256-GCM ciphertext wrapping the org encryption key (base64)"},"auth_hash":{"type":"string","maxLength":64,"minLength":64,"pattern":"^[0-9a-f]{64}$","title":"Auth Hash","description":"SHA-256(newMasterKey) hex digest for the new primary key"},"current_auth_hash":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Current Auth Hash","description":"Stored auth hash of the current primary vault key"},"recovery_auth_hash":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Recovery Auth Hash","description":"Stored auth hash of a recovery code"}},"type":"object","required":["id","wrapped_org_encryption_key","auth_hash"],"title":"VaultKeyUpdateRequest"},"VaultResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"organization_id":{"type":"string","title":"Organization Id"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"key_count":{"type":"integer","title":"Key Count"},"secret_count":{"type":"integer","title":"Secret Count"},"recovery_key_count":{"type":"integer","title":"Recovery Key Count"}},"type":"object","required":["id","organization_id","created_at","updated_at","key_count","secret_count","recovery_key_count"],"title":"VaultResponse"},"VaultSecretAccessGrantRequest":{"properties":{"identity_id":{"type":"string","format":"uuid","title":"Identity Id"}},"type":"object","required":["identity_id"],"title":"VaultSecretAccessGrantRequest"},"VaultSecretAccessResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"vault_secret_id":{"type":"string","format":"uuid","title":"Vault Secret Id"},"identity_id":{"type":"string","format":"uuid","title":"Identity Id"},"created_at":{"type":"string","format":"date-time","title":"Created At"}},"type":"object","required":["id","vault_secret_id","identity_id","created_at"],"title":"VaultSecretAccessResponse"},"VaultSecretCreateRequest":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","maxLength":255,"minLength":1,"title":"Name","description":"Plaintext display name for listing the secret, such as 'AWS Production'."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Optional freeform context describing when and how to use this credential."},"secret_type":{"$ref":"#/components/schemas/VaultSecretType","description":"Credential category hint used by clients, such as 'login', 'ssh_key', 'api_key', or 'other'."},"encrypted_payload":{"type":"string","title":"Encrypted Payload","description":"AES-256-GCM ciphertext (base64), opaque to server"}},"type":"object","required":["id","name","secret_type","encrypted_payload"],"title":"VaultSecretCreateRequest"},"VaultSecretDetailResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"secret_type":{"$ref":"#/components/schemas/VaultSecretType"},"access":{"items":{"$ref":"#/components/schemas/VaultSecretAccessResponse"},"type":"array","title":"Access"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"encrypted_payload":{"type":"string","title":"Encrypted Payload"}},"type":"object","required":["id","name","description","secret_type","created_at","updated_at","encrypted_payload"],"title":"VaultSecretDetailResponse"},"VaultSecretResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"secret_type":{"$ref":"#/components/schemas/VaultSecretType"},"access":{"items":{"$ref":"#/components/schemas/VaultSecretAccessResponse"},"type":"array","title":"Access"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","name","description","secret_type","created_at","updated_at"],"title":"VaultSecretResponse"},"VaultSecretType":{"type":"string","enum":["api_key","key_pair","login","ssh_key","other"],"title":"VaultSecretType"},"VaultSecretUpdateRequest":{"properties":{"name":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Name","description":"Optional new plaintext display name for the secret."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Optional new freeform description for the secret."},"encrypted_payload":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Encrypted Payload","description":"Optional replacement AES-256-GCM ciphertext payload (base64)."}},"type":"object","title":"VaultSecretUpdateRequest"},"VaultUnlockResponse":{"properties":{"wrapped_org_encryption_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Wrapped Org Encryption Key"},"wrapped_org_encryption_keys":{"anyOf":[{"items":{"$ref":"#/components/schemas/WrappedKeyEntry"},"type":"array"},{"type":"null"}],"title":"Wrapped Org Encryption Keys"},"encrypted_secrets":{"items":{"$ref":"#/components/schemas/VaultSecretDetailResponse"},"type":"array","title":"Encrypted Secrets"}},"type":"object","required":["encrypted_secrets"],"title":"VaultUnlockResponse"},"WrappedKeyEntry":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"auth_hash":{"type":"string","title":"Auth Hash"},"wrapped_org_encryption_key":{"type":"string","title":"Wrapped Org Encryption Key"}},"type":"object","required":["id","auth_hash","wrapped_org_encryption_key"],"title":"WrappedKeyEntry"},"AgentSupportErrorEnvelope":{"additionalProperties":true,"properties":{"detail":{"default":null,"title":"Detail"},"agent_support":{"title":"Agent Support","type":"string"}},"required":["agent_support"],"title":"AgentSupportErrorEnvelope","type":"object"}},"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Inkbox Console JWT token passed in the Authorization header."},"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key","description":"Inkbox API key."}}}}