{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/business:gladly/communications-send-sms":{"post":{"operationId":"business_gladly_communications_send_sms","summary":"Send SMS","description":"POST /api/v1/communications/sms","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:gladly/communications-receive-custom-channel-messages":{"post":{"operationId":"business_gladly_communications_receive_custom_channel_messages","summary":"Receive Custom Channel messages","description":"POST /api/v1/communications/custom-channels/{customChannelId}/messages","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customChannelId","body"],"properties":{"customChannelId":{"type":"string","description":"The ID of the Custom Channel. To find the Custom Channel ID, you must open the overflow menu of a Custom Channel Entry Point and select…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:gladly/communications-update-message-status":{"post":{"operationId":"business_gladly_communications_update_message_status","summary":"Update message status","description":"PUT /api/v1/communications/custom-channels/{customChannelId}/messages/{messageId}/status","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customChannelId","messageId","body"],"properties":{"customChannelId":{"type":"string","description":"The ID of the Custom Channel. To find the Custom Channel ID, you must open the overflow menu of a Custom Channel Entry Point and select…"},"messageId":{"type":"string","description":"The id of message updated"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:gladly/conversations-get-metadata":{"get":{"operationId":"business_gladly_conversations_get_metadata","summary":"Get conversation","description":"GET /api/v1/conversations/{conversationId}","tags":["business"],"parameters":[{"name":"conversationId","in":"query","required":true,"description":"Id of the conversation to get","schema":{"type":"string","description":"Id of the conversation to get"},"example":"9BcE2O0DQ2ynGHRmk9FeoA"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:gladly/conversations-update-assignee-status":{"post":{"operationId":"business_gladly_conversations_update_assignee_status","summary":"Update conversation","description":"PATCH /api/v1/conversations/{conversationId}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["conversationId","body"],"properties":{"conversationId":{"type":"string","description":"Id of the conversation"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:gladly/conversations-create-customer-item":{"post":{"operationId":"business_gladly_conversations_create_customer_item","summary":"Create item","description":"POST /api/v1/conversation-items","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:gladly/conversations-get-item":{"get":{"operationId":"business_gladly_conversations_get_item","summary":"Get item","description":"GET /api/v1/conversation-items/{itemId}","tags":["business"],"parameters":[{"name":"itemId","in":"query","required":true,"description":"id of the conversation item","schema":{"type":"string","description":"id of the conversation item"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:gladly/conversations-delete-item":{"post":{"operationId":"business_gladly_conversations_delete_item","summary":"Delete item","description":"DELETE /api/v1/conversation-items/{itemId}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["itemId"],"properties":{"itemId":{"type":"string","description":"Id of the item to be deleted."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:gladly/conversations-get-recording":{"get":{"operationId":"business_gladly_conversations_get_recording","summary":"Get media","description":"GET /api/v1/conversation-items/{itemId}/media/recording","tags":["business"],"parameters":[{"name":"itemId","in":"query","required":true,"description":"id of the conversation item","schema":{"type":"string","description":"id of the conversation item"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:gladly/conversations-create-customer-item-2":{"post":{"operationId":"business_gladly_conversations_create_customer_item_2","summary":"Create item for customer","description":"POST /api/v1/customers/{customerId}/conversation-items","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customerId"],"properties":{"customerId":{"type":"string","description":"Id of the customer associated with this item. You can look up the id using the [Find customers](index.html#tag/Customers) API."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:gladly/conversations-delete-customer-item":{"post":{"operationId":"business_gladly_conversations_delete_customer_item","summary":"Delete item for customer","description":"DELETE /api/v1/customers/{customerId}/conversation-items/{itemId}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customerId","itemId"],"properties":{"customerId":{"type":"string","description":"Id of the customer associated with this item. You can look up the id using the [Find customers](index.html#tag/Customers) API."},"itemId":{"type":"string","description":"Id of the item to be deleted."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:gladly/conversations-list-items-in-conversation":{"get":{"operationId":"business_gladly_conversations_list_items_in_conversation","summary":"List items in conversation","description":"GET /api/v1/conversations/{conversationId}/items","tags":["business"],"parameters":[{"name":"conversationId","in":"query","required":true,"description":"Id of the conversation to get the timeline for","schema":{"type":"string","description":"Id of the conversation to get the timeline for"},"example":"9BcE2O0DQ2ynGHRmk9FeoA"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:gladly/conversations-add-topic-to-list":{"post":{"operationId":"business_gladly_conversations_add_topic_to_list","summary":"Add topic","description":"POST /api/v1/conversations/{conversationId}/topics","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["conversationId","body"],"properties":{"conversationId":{"type":"string","description":"Id of the conversation."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:gladly/conversations-delete-topic":{"post":{"operationId":"business_gladly_conversations_delete_topic","summary":"Delete topic","description":"DELETE /api/v1/conversations/{conversationId}/topics/{topicId}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["conversationId","topicId"],"properties":{"conversationId":{"type":"string","description":"Id of the conversation."},"topicId":{"type":"string","description":"Id of topic to be deleted from conversation."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:gladly/conversations-add-freeform-topics":{"post":{"operationId":"business_gladly_conversations_add_freeform_topics","summary":"Add or Remove Freeform topic","description":"POST /api/v1/customer-history/{customerId}/conversations/{conversationId}/custom-attributes","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customerId","conversationId","body"],"properties":{"customerId":{"type":"string","description":"Id of the customer."},"conversationId":{"type":"string","description":"Id of the conversation."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:gladly/conversations-add-note-to-conversation":{"post":{"operationId":"business_gladly_conversations_add_note_to_conversation","summary":"Add note","description":"POST /api/v1/conversations/{conversationId}/notes","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["conversationId"],"properties":{"conversationId":{"type":"string","description":"Id of the conversation."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:gladly/conversations-get-note":{"get":{"operationId":"business_gladly_conversations_get_note","summary":"Get note","description":"GET /api/v1/conversations/{conversationId}/notes/{noteId}","tags":["business"],"parameters":[{"name":"conversationId","in":"query","required":true,"description":"id of the conversation","schema":{"type":"string","description":"id of the conversation"}},{"name":"noteId","in":"query","required":true,"description":"id of the note","schema":{"type":"string","description":"id of the note"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:gladly/conversations-send-response":{"post":{"operationId":"business_gladly_conversations_send_response","summary":"Reply to message","description":"POST /api/v1/conversation-items/{itemId}/reply","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["itemId"],"properties":{"itemId":{"type":"string","description":"id of the conversation item"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:gladly/conversations-redact-conversation-item":{"post":{"operationId":"business_gladly_conversations_redact_conversation_item","summary":"Redact conversation item","description":"POST /api/v1/conversation-items/{itemId}/redact","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["itemId"],"properties":{"itemId":{"type":"string","description":"id of the conversation item"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:gladly/message-automation-get-session":{"get":{"operationId":"business_gladly_message_automation_get_session","summary":"Get Automation Session","description":"GET /api/v1/message-automation/sessions/{sessionId}","tags":["business"],"parameters":[{"name":"sessionId","in":"query","required":true,"description":"The id of the automation session.","schema":{"type":"string","description":"The id of the automation session."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:gladly/message-automation-get-session-messages":{"get":{"operationId":"business_gladly_message_automation_get_session_messages","summary":"Get Automation Messages","description":"GET /api/v1/message-automation/sessions/{sessionId}/messages","tags":["business"],"parameters":[{"name":"sessionId","in":"query","required":true,"description":"Id of the automation session.","schema":{"type":"string","description":"Id of the automation session."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:gladly/message-automation-outbound-message":{"post":{"operationId":"business_gladly_message_automation_outbound_message","summary":"Send Outbound Automation Message","description":"POST /api/v1/message-automation/sessions/{sessionId}/messages","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["sessionId","body"],"properties":{"sessionId":{"type":"string","description":"Id of the automation session."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:gladly/message-automation-get-message":{"get":{"operationId":"business_gladly_message_automation_get_message","summary":"Get Automation Message","description":"GET /api/v1/message-automation/sessions/{sessionId}/messages/{messageId}","tags":["business"],"parameters":[{"name":"sessionId","in":"query","required":true,"description":"Id of the automation session.","schema":{"type":"string","description":"Id of the automation session."}},{"name":"messageId","in":"query","required":true,"description":"Id of the message.","schema":{"type":"string","description":"Id of the message."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:gladly/message-automation-handoff-session-to-agent":{"post":{"operationId":"business_gladly_message_automation_handoff_session_to_agent","summary":"Agent Handoff","description":"POST /api/v1/message-automation/sessions/{sessionId}/handoff","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["sessionId","body"],"properties":{"sessionId":{"type":"string","description":"Id of the automation session."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:gladly/message-automation-close-session":{"post":{"operationId":"business_gladly_message_automation_close_session","summary":"Close Automation Session","description":"POST /api/v1/message-automation/sessions/{sessionId}/close","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["sessionId","body"],"properties":{"sessionId":{"type":"string","description":"Id of the automation session."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:gladly/tasks-customer-timeline":{"post":{"operationId":"business_gladly_tasks_customer_timeline","summary":"Create task","description":"POST /api/v1/tasks","tags":["business"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:gladly/tasks-get-customer-tasks":{"get":{"operationId":"business_gladly_tasks_get_customer_tasks","summary":"List tasks","description":"GET /api/v1/customers/{customerId}/tasks","tags":["business"],"parameters":[{"name":"customerId","in":"query","required":true,"description":"Id of the customer whose tasks you'd like to view.","schema":{"type":"string","description":"Id of the customer whose tasks you'd like to view."}},{"name":"status","in":"query","required":false,"description":"Fetch tasks with the provided status.","schema":{"type":"string","enum":["OPEN","CLOSED"],"description":"Fetch tasks with the provided status."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:gladly/tasks-create-customer-task":{"post":{"operationId":"business_gladly_tasks_create_customer_task","summary":"Create task for customer","description":"POST /api/v1/customers/{customerId}/tasks","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customerId"],"properties":{"customerId":{"type":"string","description":"Id of the customer associated with the task to create. You can look up the id using the [Find customers](index.html#tag/Customers) API."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:gladly/tasks-get-task":{"get":{"operationId":"business_gladly_tasks_get_task","summary":"Get task","description":"GET /api/v1/tasks/{taskId}","tags":["business"],"parameters":[{"name":"taskId","in":"query","required":true,"description":"Id of the task requested","schema":{"type":"string","description":"Id of the task requested"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:gladly/tasks-update-task":{"post":{"operationId":"business_gladly_tasks_update_task","summary":"Update task","description":"PATCH /api/v1/tasks/{taskId}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["taskId"],"properties":{"taskId":{"type":"string","description":"Id of the task that is to be updated"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:gladly/tasks-get-task-comments":{"get":{"operationId":"business_gladly_tasks_get_task_comments","summary":"Get task comments","description":"GET /api/v1/tasks/{taskId}/comments","tags":["business"],"parameters":[{"name":"taskId","in":"query","required":true,"description":"Id of the task comments are requested for.","schema":{"type":"string","description":"Id of the task comments are requested for."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:gladly/tasks-add-task-comment":{"post":{"operationId":"business_gladly_tasks_add_task_comment","summary":"Add task comment","description":"POST /api/v1/tasks/{taskId}/comments","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["taskId"],"properties":{"taskId":{"type":"string","description":"Id of the task that will be commented on."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:gladly/tasks-get-comment":{"get":{"operationId":"business_gladly_tasks_get_comment","summary":"Get task comment","description":"GET /api/v1/tasks/{taskId}/comments/{commentId}","tags":["business"],"parameters":[{"name":"taskId","in":"query","required":true,"description":"Task id","schema":{"type":"string","description":"Task id"}},{"name":"commentId","in":"query","required":true,"description":"Comment id","schema":{"type":"string","description":"Comment id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:gladly/freeform-topics-get-attribute":{"get":{"operationId":"business_gladly_freeform_topics_get_attribute","summary":"Get custom attribute","description":"GET /api/v1/custom-attributes/:customAttributeId","tags":["business"],"parameters":[{"name":"customAttributeId","in":"query","required":true,"description":"id of the custom attribute","schema":{"type":"string","description":"id of the custom attribute"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:gladly/customers-find-profiles":{"get":{"operationId":"business_gladly_customers_find_profiles","summary":"Find customers","description":"GET /api/v1/customer-profiles","tags":["business"],"parameters":[{"name":"email","in":"query","required":false,"description":"customer email address to search on.","schema":{"type":"string","description":"customer email address to search on."}},{"name":"externalCustomerId","in":"query","required":false,"description":"Customer ID in your system of record for Customer Profiles linked to a Lookup Adaptor installed prior to 05/12/21. If Customer Profile is…","schema":{"type":"string","description":"Customer ID in your system of record for Customer Profiles linked to a Lookup Adaptor installed prior to 05/12/21. If Customer Profile is…"}},{"name":"phoneNumber","in":"query","required":false,"description":"Phone number in E.164 format. The value should be URL escaped where `+` becomes `%2B`.","schema":{"type":"string","description":"Phone number in E.164 format. The value should be URL escaped where `+` becomes `%2B`."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:gladly/customers-create-profile":{"post":{"operationId":"business_gladly_customers_create_profile","summary":"Create customer","description":"POST /api/v1/customer-profiles","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:gladly/customers-get-profile-by-id":{"get":{"operationId":"business_gladly_customers_get_profile_by_id","summary":"Get customer","description":"GET /api/v1/customer-profiles/{customerId}","tags":["business"],"parameters":[{"name":"customerId","in":"query","required":true,"description":"id of the customer","schema":{"type":"string","description":"id of the customer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:gladly/customers-update-profile-by-id":{"post":{"operationId":"business_gladly_customers_update_profile_by_id","summary":"Update customer","description":"PATCH /api/v1/customer-profiles/{customerId}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customerId","body"],"properties":{"customerId":{"type":"string","description":"id of the customer"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:gladly/user-identity-generate-jwt":{"post":{"operationId":"business_gladly_user_identity_generate_jwt","summary":"Create a User Identity JWT","description":"POST /api/v1/user-identity-jwt","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:gladly/answers-search-results":{"get":{"operationId":"business_gladly_answers_search_results","summary":"Search public answers","description":"GET /api/v1/orgs/{orgId}/answers-search?q=search+terms","tags":["business"],"parameters":[{"name":"orgId","in":"query","required":true,"description":"id of your organization You can look up the ID using the [Get organization](index.html#tag/Organization) API.","schema":{"type":"string","description":"id of your organization You can look up the ID using the [Get organization](index.html#tag/Organization) API."}},{"name":"q","in":"query","required":false,"description":"search term","schema":{"type":"string","description":"search term"}},{"name":"lng","in":"query","required":false,"description":"language code","schema":{"type":"string","description":"language code"}},{"name":"audienceId","in":"query","required":false,"description":"Audience ID. The Audience ID can be retrieved by going to Settings > Audiences in Gladly, then clicking on the Edit button next to the…","schema":{"type":"string","description":"Audience ID. The Audience ID can be retrieved by going to Settings > Audiences in Gladly, then clicking on the Edit button next to the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:gladly/answers-list-public":{"get":{"operationId":"business_gladly_answers_list_public","summary":"List public answers","description":"GET /api/v1/orgs/{orgId}/answers?lng={lng}&audienceId={audienceId}","tags":["business"],"parameters":[{"name":"orgId","in":"query","required":true,"description":"id of your organization You can look up the ID using the [Get organization](index.html#tag/Organization) API.","schema":{"type":"string","description":"id of your organization You can look up the ID using the [Get organization](index.html#tag/Organization) API."}},{"name":"lng","in":"query","required":true,"description":"Language of the answers returned Defaults to `en-us`","schema":{"type":"string","description":"Language of the answers returned Defaults to `en-us`"}},{"name":"audienceId","in":"query","required":true,"description":"Audience ID for answers returned - optional. The Audience ID can be retrieved by going to Settings > Audiences in Gladly, then clicking on…","schema":{"type":"string","description":"Audience ID for answers returned - optional. The Audience ID can be retrieved by going to Settings > Audiences in Gladly, then clicking on…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:gladly/answers-list-answer-titles":{"get":{"operationId":"business_gladly_answers_list_answer_titles","summary":"List Help Center Answer Titles","description":"GET /api/v1/orgs/{orgId}/help-center/{helpCenterId}/answer-titles?lng={lng}&audienceId={audienceId}","tags":["business"],"parameters":[{"name":"orgId","in":"query","required":true,"description":"id of your organization You can look up the ID using the [Get organization](index.html#tag/Organization) API.","schema":{"type":"string","description":"id of your organization You can look up the ID using the [Get organization](index.html#tag/Organization) API."}},{"name":"helpCenterId","in":"query","required":true,"description":"Help Center ID You can look up the ID by going to Settings > Help Center in Gladly, then clicking on the 3 dots next to the Help Center…","schema":{"type":"string","description":"Help Center ID You can look up the ID by going to Settings > Help Center in Gladly, then clicking on the 3 dots next to the Help Center…"}},{"name":"lng","in":"query","required":true,"description":"Language of the answers returned Defaults to `en-us`","schema":{"type":"string","description":"Language of the answers returned Defaults to `en-us`"}},{"name":"audienceId","in":"query","required":true,"description":"Audience ID for answers returned - optional. The Audience ID can be retrieved by going to Settings > Audiences in Gladly, then clicking on…","schema":{"type":"string","description":"Audience ID for answers returned - optional. The Audience ID can be retrieved by going to Settings > Audiences in Gladly, then clicking on…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:gladly/answers-get-by-id":{"get":{"operationId":"business_gladly_answers_get_by_id","summary":"Get public answer","description":"GET /api/v1/orgs/{orgId}/answers/{answerId}","tags":["business"],"parameters":[{"name":"orgId","in":"query","required":true,"description":"id of your organization You can look up the ID using the [Get organization](index.html#tag/Organization) API.","schema":{"type":"string","description":"id of your organization You can look up the ID using the [Get organization](index.html#tag/Organization) API."}},{"name":"answerId","in":"query","required":true,"description":"id of the answer","schema":{"type":"string","description":"id of the answer"}},{"name":"lng","in":"query","required":false,"description":"language code","schema":{"type":"string","description":"language code"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:gladly/agents-list":{"get":{"operationId":"business_gladly_agents_list","summary":"List Agents","description":"GET /api/v1/agents","tags":["business"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:gladly/agents-get-agent-profile":{"get":{"operationId":"business_gladly_agents_get_agent_profile","summary":"Get Agent","description":"GET /api/v1/agents/{agentId}","tags":["business"],"parameters":[{"name":"agentId","in":"query","required":true,"description":"id of the agent","schema":{"type":"string","description":"id of the agent"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:gladly/agents-get-call-recorder-status":{"get":{"operationId":"business_gladly_agents_get_call_recorder_status","summary":"Get Agent CallRecorder","description":"GET /api/v1/agents/{agentId}/call-recorder","tags":["business"],"parameters":[{"name":"agentId","in":"query","required":true,"description":"Gladly ID or Gladly email address of the agent","schema":{"type":"string","description":"Gladly ID or Gladly email address of the agent"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:gladly/agents-update-call-recorder":{"post":{"operationId":"business_gladly_agents_update_call_recorder","summary":"Update Agent CallRecorder","description":"PATCH /api/v1/agents/{agentId}/call-recorder","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["agentId","body"],"properties":{"agentId":{"type":"string","description":"Gladly ID or Gladly email address of the agent"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:gladly/organization-get-metadata":{"get":{"operationId":"business_gladly_organization_get_metadata","summary":"Get organization","description":"GET /api/v1/organization","tags":["business"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:gladly/inboxes-list-metadata":{"get":{"operationId":"business_gladly_inboxes_list_metadata","summary":"List inboxes","description":"GET /api/v1/inboxes","tags":["business"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:gladly/inboxes-get-metadata":{"get":{"operationId":"business_gladly_inboxes_get_metadata","summary":"Get inbox","description":"GET /api/v1/inboxes/{inboxId}","tags":["business"],"parameters":[{"name":"inboxId","in":"query","required":true,"description":"id of the inbox","schema":{"type":"string","description":"id of the inbox"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:gladly/teams-list-teams":{"get":{"operationId":"business_gladly_teams_list_teams","summary":"List teams","description":"GET /api/v1/teams","tags":["business"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:gladly/teams-get-by-id":{"get":{"operationId":"business_gladly_teams_get_by_id","summary":"Get team","description":"GET /api/v1/teams/{teamId}","tags":["business"],"parameters":[{"name":"teamId","in":"query","required":true,"description":"id of the team","schema":{"type":"string","description":"id of the team"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:gladly/topics-list":{"get":{"operationId":"business_gladly_topics_list","summary":"List topics","description":"GET /api/v1/topics","tags":["business"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:gladly/topics-get-by-id":{"get":{"operationId":"business_gladly_topics_get_by_id","summary":"Get topic","description":"GET /api/v1/topics/{topicId}","tags":["business"],"parameters":[{"name":"topicId","in":"query","required":true,"description":"id of the topic","schema":{"type":"string","description":"id of the topic"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:gladly/export-list-schedules":{"get":{"operationId":"business_gladly_export_list_schedules","summary":"List schedules","description":"GET /api/v1/export/schedules","tags":["business"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:gladly/export-jobs-list":{"get":{"operationId":"business_gladly_export_jobs_list","summary":"List jobs","description":"GET /api/v1/export/jobs","tags":["business"],"parameters":[{"name":"status","in":"query","required":false,"description":"export job status to search on.","schema":{"type":"string","enum":["PENDING","IN_PROGRESS","COMPLETED","FAILED"],"description":"export job status to search on."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:gladly/export-job-by-id":{"get":{"operationId":"business_gladly_export_job_by_id","summary":"Get job","description":"GET /api/v1/export/jobs/{jobId}","tags":["business"],"parameters":[{"name":"jobId","in":"query","required":true,"description":"id of the job","schema":{"type":"string","description":"id of the job"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:gladly/export-delete-job":{"post":{"operationId":"business_gladly_export_delete_job","summary":"Delete job","description":"DELETE /api/v1/export/jobs/{jobId}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["jobId"],"properties":{"jobId":{"type":"string","description":"id of the job"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:gladly/export-download-file":{"get":{"operationId":"business_gladly_export_download_file","summary":"Get file","description":"GET /api/v1/export/jobs/{jobId}/files/{filename}","tags":["business"],"parameters":[{"name":"jobId","in":"query","required":true,"description":"id of the job","schema":{"type":"string","description":"id of the job"}},{"name":"filename","in":"query","required":true,"description":"name of the file","schema":{"type":"string","description":"name of the file"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:gladly/reports-generate-report-csv":{"post":{"operationId":"business_gladly_reports_generate_report_csv","summary":"Generate a report","description":"POST /api/v1/reports","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:gladly/webhooks-list":{"get":{"operationId":"business_gladly_webhooks_list","summary":"List webhooks","description":"GET /api/v1/webhooks","tags":["business"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:gladly/webhooks-create-webhook":{"post":{"operationId":"business_gladly_webhooks_create_webhook","summary":"Create webhook","description":"POST /api/v1/webhooks","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:gladly/webhooks-get-by-id":{"get":{"operationId":"business_gladly_webhooks_get_by_id","summary":"Get webhook","description":"GET /api/v1/webhooks/{webhookId}","tags":["business"],"parameters":[{"name":"webhookId","in":"query","required":true,"description":"id of the webhook","schema":{"type":"string","description":"id of the webhook"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:gladly/webhooks-update-by-id":{"post":{"operationId":"business_gladly_webhooks_update_by_id","summary":"Update webhook","description":"PATCH /api/v1/webhooks/{webhookId}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webhookId","body"],"properties":{"webhookId":{"type":"string","description":"id of the webhook"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:gladly/webhooks-delete-by-id":{"post":{"operationId":"business_gladly_webhooks_delete_by_id","summary":"Delete webhook","description":"DELETE /api/v1/webhooks/{webhookId}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webhookId"],"properties":{"webhookId":{"type":"string","description":"id of the webhook"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:gladly/payloads-notify-endpoint":{"post":{"operationId":"business_gladly_payloads_notify_endpoint","summary":"Gladly will perform a POST request to your endpoint when the event occurs. Your service is expected to…","description":"POST /gladly/webhook","tags":["business"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:gladly/reports-generate-work-session-report":{"post":{"operationId":"business_gladly_reports_generate_work_session_report","summary":"Generate a work session report","description":"POST /api/v1/reports/work-session-events","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:gladly/events-list-stream-of-events":{"get":{"operationId":"business_gladly_events_list_stream_of_events","summary":"List events","description":"GET /api/v1/events","tags":["business"],"parameters":[{"name":"startAt","in":"query","required":true,"description":"Starting time of the events interval. This is based on the `timestamp` field which indicates when the event was recorded. Must be from…","schema":{"type":"string","description":"Starting time of the events interval. This is based on the `timestamp` field which indicates when the event was recorded. Must be from…"}},{"name":"endAt","in":"query","required":false,"description":"Ending time of the events interval. This is based on the `timestamp` field which indicates when the event was recorded. If unspecified,…","schema":{"type":"string","description":"Ending time of the events interval. This is based on the `timestamp` field which indicates when the event was recorded. If unspecified,…"}},{"name":"entities","in":"query","required":true,"description":"Entity types that have associated events. Any number of types is acceptable and at least one must be present Available Types:…","schema":{"type":"array","description":"Entity types that have associated events. Any number of types is acceptable and at least one must be present Available Types:…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}