FigoAILabs API Documentation
  1. Schemas
FigoAILabs API Documentation
  • Quickstart
  • Website Javascript Plugin
  • Rate Limits & Pricing
  • FigoAI MCP Server Guide
  • APIs
    • Chat Assistant API
    • Image Assistant API
    • Text To Speech API
    • Speech To Text API
    • Guardrails API
    • CV Scoring API
    • Web Search API
    • Sentiment Analysis API
    • Message Context API
    • Image Analyzer API
    • Nigerian Bank Account Extractor API
  • Schemas
    • Sample Schemas
      • Pet
      • Category
      • Tag
    • Schemas
      • ApiKeyRequest
      • Assignee
      • AssistantRequest
      • AssistantTrainingRequest
      • AssistantTrainingRequestByUrl
      • CVScoringRequest
      • Cf
      • Change
      • ChangePasswordRequest
      • ChangePlanRequest
      • ChatRequest
      • ChatUser
      • CompanyEntityCreateRequest
      • CompanyEntityUpdateRequest
      • CompanyPreferenceUpdateRequest
      • ConfirmPasswordRequest
      • Contact
      • CreateUserRequest
      • CustomFields
      • CustomerContact
      • DescAttachment
      • Entry
      • FAQ
      • FBEntry
      • FBMessage
      • FBMessaging
      • FBRecipient
      • FBSendMessage
      • FBSender
      • FacebookReceiveMessageRequest
      • FacebookSendMessageRequest
      • FacebookSetupRequest
      • GoogleSignInRequest
      • GuardrailForAssistantRequest
      • GuardrailRequest
      • HallucinationTrack
      • IGEntry
      • IGMessage
      • IGMessaging
      • IGRecipient
      • IGSendMessage
      • IGSender
      • ImageChatRequest
      • ImageDefaultChatRequest
      • InstagramReceiveMessageRequest
      • InstagramSendMessageRequest
      • InstagramSetupRequest
      • LLMImage
      • LLMPoolRequest
      • LLMRequest
      • LayoutDetails
      • Message
      • MessageRequest
      • MessageRequestForWebSearch
      • Metadata
      • Payload
      • Profile
      • RefreshTokenRequest
      • RemitaPersonalSignInRequest
      • RemitaSignInRequest
      • RequestOTPRequest
      • ResetPasswordRequest
      • SaveAssistantFAQByTextRequest
      • SaveAssistantFAQByUrlRequest
      • SaveAssistantFAQRequest
      • SaveToolingAgentMapRequest
      • SaveToolingAgentRequest
      • SentimentValidationRequest
      • SignInRequest
      • SignUpRequest
      • TWDirectMessageEvent
      • TWMessageCreate
      • TWMessageData
      • TWTarget
      • TeamsLoginRequest
      • Text
      • TextToSpeechRequest
      • TransactionInitializeRequest
      • TwitterReceiveMessageRequest
      • TwitterSendMessageRequest
      • TwitterSetupRequest
      • UpdateAssistantFAQRequest
      • UpdateUserRequest
      • ValidateOTPRequest
      • Value
      • VerifyEmailRequest
      • WhatsAppReceiveMessageRequest
      • WhatsAppSendMessageRequest
      • WhatsAppSetupRequest
      • ZohoCreateTicketRequest
      • ZohoReceiveMessageRequest
      • ZohoReplyTicketRequest
      • ZohoSetupRequest
  1. Schemas

Payload

{
    "modifiedTime": "2019-08-24T14:15:22Z",
    "subCategory": null,
    "statusType": "string",
    "subject": "string",
    "departmentId": "string",
    "dueDate": null,
    "channel": "string",
    "content": "string",
    "direction": "string",
    "onholdTime": null,
    "language": null,
    "source": null,
    "resolution": null,
    "sharedDepartments": [
        null
    ],
    "closedTime": null,
    "approvalCount": "string",
    "isOverDue": true,
    "isTrashed": true,
    "contact": {
        "firstName": "string",
        "lastName": "string",
        "phone": "string",
        "mobile": null,
        "id": "string",
        "isSpam": true,
        "type": null,
        "email": "string",
        "account": null
    },
    "createdTime": "2019-08-24T14:15:22Z",
    "id": "string",
    "isResponseOverdue": true,
    "firstThread": null,
    "customerResponseTime": "2019-08-24T14:15:22Z",
    "productId": null,
    "contactId": "string",
    "threadCount": "string",
    "secondaryContacts": [
        null
    ],
    "priority": null,
    "classification": null,
    "commentCount": "string",
    "accountId": null,
    "taskCount": "string",
    "phone": "string",
    "webUrl": "string",
    "isSpam": true,
    "assignee": {
        "photoURL": "string",
        "firstName": "string",
        "lastName": "string",
        "id": "string",
        "email": "string"
    },
    "lastActivityTime": "2019-08-24T14:15:22Z",
    "status": "string",
    "entitySkills": [
        null
    ],
    "ticketNumber": "string",
    "sentiment": null,
    "customFields": {
        "severityPercentage": "string",
        "dateofPurchase": "2019-08-24T14:15:22Z",
        "url": "string"
    },
    "isArchived": true,
    "description": "string",
    "timeEntryCount": "string",
    "channelRelatedInfo": null,
    "responseDueDate": null,
    "isDeleted": true,
    "modifiedBy": "string",
    "followerCount": "string",
    "email": "string",
    "layoutDetails": {
        "id": "string",
        "layoutName": "string"
    },
    "channelCode": null,
    "cf": {
        "cf_url": "string",
        "cf_severityPercentage": "string",
        "cf_dateofPurchase": "2019-08-24T14:15:22Z"
    },
    "isFollowing": true,
    "assigneeId": "string",
    "layoutId": "string",
    "createdBy": "string",
    "teamId": null,
    "tagCount": "string",
    "isEscalated": true,
    "attachmentCount": "string",
    "category": "string",
    "descAttachments": [
        {
            "size": "string",
            "name": "string",
            "href": "string",
            "id": "string"
        }
    ]
}
Built with