{"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/dev-tools:gorgias/account-get-details":{"get":{"operationId":"dev_tools_gorgias_account_get_details","summary":"Retrieve your account","description":"GET /api/account","tags":["dev-tools"],"parameters":[{"name":"domain","in":"query","required":true,"description":"Part of the server address: https://{domain}.gorgias.com","schema":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"}}],"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/dev-tools:gorgias/customers-list-ordered-customers":{"get":{"operationId":"dev_tools_gorgias_customers_list_ordered_customers","summary":"List customers","description":"GET /api/customers","tags":["dev-tools"],"parameters":[{"name":"domain","in":"query","required":true,"description":"Part of the server address: https://{domain}.gorgias.com","schema":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"}},{"name":"id","in":"query","required":false,"description":"ID of the customer you're looking for.","schema":{"type":"integer","description":"ID of the customer you're looking for."}},{"name":"cursor","in":"query","required":false,"description":"Value indicating your position in the list of all customers. If omitted, the first customers of the list will be returned.","schema":{"type":"string","description":"Value indicating your position in the list of all customers. If omitted, the first customers of the list will be returned."}},{"name":"email","in":"query","required":false,"description":"Primary email address of the customer you're looking for.","schema":{"type":"string","description":"Primary email address of the customer you're looking for."}},{"name":"external_id","in":"query","required":false,"description":"ID of the customer in a foreign system (Stripe, Aircall etc.) you're looking for.","schema":{"type":"string","description":"ID of the customer in a foreign system (Stripe, Aircall etc.) you're looking for."}},{"name":"language","in":"query","required":false,"description":"The customer's preferred language (format: ISO_639-1) to filter with.","schema":{"type":"string","description":"The customer's preferred language (format: ISO_639-1) to filter with."}},{"name":"limit","in":"query","required":false,"description":"Maximum number of customers to return.","schema":{"type":"integer","default":30,"description":"Maximum number of customers to return."}},{"name":"name","in":"query","required":false,"description":"Full name of the customer you're looking for.","schema":{"type":"string","description":"Full name of the customer you're looking for."}},{"name":"order_by","in":"query","required":false,"description":"Attribute used to order customers.","schema":{"type":"string","enum":["created_datetime:asc","created_datetime:desc","updated_datetime:asc","updated_datetime:desc"],"default":"created_datetime:desc","description":"Attribute used to order customers."}},{"name":"timezone","in":"query","required":false,"description":"The customer's preferred timezone (format: IANA timezone name).","schema":{"type":"string","description":"The customer's preferred timezone (format: IANA timezone name)."}},{"name":"view_id","in":"query","required":false,"description":"ID of a view to filter customers by.","schema":{"type":"integer","description":"ID of a view to filter customers by."}}],"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/dev-tools:gorgias/customers-create-new-customer":{"post":{"operationId":"dev_tools_gorgias_customers_create_new_customer","summary":"Create a customer","description":"POST /api/customers","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain","body"],"properties":{"domain":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"},"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/dev-tools:gorgias/customers-delete-customer":{"post":{"operationId":"dev_tools_gorgias_customers_delete_customer","summary":"Delete customers","description":"DELETE /api/customers","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain","body"],"properties":{"domain":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"},"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/dev-tools:gorgias/customers-merge-customers-info":{"post":{"operationId":"dev_tools_gorgias_customers_merge_customers_info","summary":"Merge two customers","description":"PUT /api/customers/merge","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain","source_id","target_id","body"],"properties":{"domain":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"},"source_id":{"type":"integer","description":"The ID of the customer to merge (which will be merged into the targeted customer)."},"target_id":{"type":"integer","description":"The ID of the targeted customer (which will still be here after the merge)."},"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/dev-tools:gorgias/customers-set-data":{"post":{"operationId":"dev_tools_gorgias_customers_set_data","summary":"Set customer data","description":"PUT /api/customers/{customer_id}/data","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain","customer_id","body"],"properties":{"domain":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"},"customer_id":{"type":"integer","description":"The ID of the customer to update."},"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/dev-tools:gorgias/custom-fields-list-matching-parameters":{"get":{"operationId":"dev_tools_gorgias_custom_fields_list_matching_parameters","summary":"List custom fields","description":"GET /api/custom-fields","tags":["dev-tools"],"parameters":[{"name":"domain","in":"query","required":true,"description":"Part of the server address: https://{domain}.gorgias.com","schema":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"}},{"name":"object_type","in":"query","required":true,"description":"Type of entity on which to use this custom field.","schema":{"type":"string","enum":["Ticket"],"description":"Type of entity on which to use this custom field."}},{"name":"search","in":"query","required":false,"description":"Search for custom fields' names matching the given text query (case insensitive).","schema":{"type":"string","description":"Search for custom fields' names matching the given text query (case insensitive)."}},{"name":"archived","in":"query","required":false,"description":"A filter parameter used to return archived or non-archived only results.","schema":{"type":"boolean","description":"A filter parameter used to return archived or non-archived only results."}},{"name":"order_by","in":"query","required":false,"description":"Attribute used to priority the errors.","schema":{"type":"string","enum":["priority:asc","priority:desc"],"default":"priority:desc","description":"Attribute used to priority the errors."}},{"name":"cursor","in":"query","required":false,"description":"Value indicating your position in the list of all items. If omitted, the first items of the list will be returned.","schema":{"type":"string","description":"Value indicating your position in the list of all items. If omitted, the first items of the list will be returned."}},{"name":"limit","in":"query","required":false,"description":"Maximum number of items to return.","schema":{"type":"integer","default":30,"description":"Maximum number of items to return."}}],"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/dev-tools:gorgias/custom-fields-create-field":{"post":{"operationId":"dev_tools_gorgias_custom_fields_create_field","summary":"Create a custom field","description":"POST /api/custom-fields","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain","body"],"properties":{"domain":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"},"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/dev-tools:gorgias/custom-fields-bulk-update-list":{"post":{"operationId":"dev_tools_gorgias_custom_fields_bulk_update_list","summary":"Bulk update a list of custom fields","description":"PUT /api/custom-fields","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain","body"],"properties":{"domain":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"},"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/dev-tools:gorgias/events-list-paginated":{"get":{"operationId":"dev_tools_gorgias_events_list_paginated","summary":"List events","description":"GET /api/events","tags":["dev-tools"],"parameters":[{"name":"domain","in":"query","required":true,"description":"Part of the server address: https://{domain}.gorgias.com","schema":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"}},{"name":"created_datetime","in":"query","required":false,"description":"Comparators used to filter events on their creation date.","schema":{"type":"object","description":"Comparators used to filter events on their creation date."}},{"name":"cursor","in":"query","required":false,"description":"Value indicating your position in the list of all events. If omitted, the first events of the list will be returned.","schema":{"type":"string","description":"Value indicating your position in the list of all events. If omitted, the first events of the list will be returned."}},{"name":"limit","in":"query","required":false,"description":"Maximum number of events to return.","schema":{"type":"integer","default":30,"description":"Maximum number of events to return."}},{"name":"object_id","in":"query","required":false,"description":"ID of the object associated with the events to return.","schema":{"type":"integer","description":"ID of the object associated with the events to return."}},{"name":"object_type","in":"query","required":false,"description":"Type of the object associated with the events to return.","schema":{"type":"string","enum":["Account","Macro","Tag","Customer","Team","View","Widget","User","TicketMessage","Ticket","Rule","Integration"],"description":"Type of the object associated with the events to return."}},{"name":"order_by","in":"query","required":false,"description":"Attribute used to order events. Value of `created_datetime` has been deprecated , use `created_datetime:asc` or `created_datetime:desc`…","schema":{"type":"string","enum":["created_datetime","created_datetime:asc","created_datetime:desc"],"default":"created_datetime:desc","description":"Attribute used to order events. Value of `created_datetime` has been deprecated , use `created_datetime:asc` or `created_datetime:desc`…"}},{"name":"types","in":"query","required":false,"description":"Types of the events to return.","schema":{"type":"array","description":"Types of the events to return."}},{"name":"user_ids","in":"query","required":false,"description":"IDs of the users who triggered the events to return.","schema":{"type":"array","description":"IDs of the users who triggered the events to return."}}],"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/dev-tools:gorgias/files-upload-multiple-files":{"post":{"operationId":"dev_tools_gorgias_files_upload_multiple_files","summary":"Upload files","description":"POST /api/upload","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain","body"],"properties":{"domain":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"},"type":{"type":"string","enum":["public_attachment","attachment","profile_picture","widget_picture"],"default":"attachment","description":"The type of file to upload. If not specified, the file will be uploaded as a private attachment."},"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"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/dev-tools:gorgias/files-download-file-by-resource-name":{"get":{"operationId":"dev_tools_gorgias_files_download_file_by_resource_name","summary":"Download a file","description":"GET /api/{file_type}/download/{domain_hash}/{resource_name}","tags":["dev-tools"],"parameters":[{"name":"domain","in":"query","required":true,"description":"Part of the server address: https://{domain}.gorgias.com","schema":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"}},{"name":"file_type","in":"query","required":true,"description":"The type of file to download","schema":{"type":"string","description":"The type of file to download"}},{"name":"domain_hash","in":"query","required":true,"description":"The domain identifier of the account that owns the resource","schema":{"type":"string","description":"The domain identifier of the account that owns the resource"}},{"name":"resource_name","in":"query","required":true,"description":"The resource identifier of the attachment you are trying to retrieve","schema":{"type":"string","description":"The resource identifier of the attachment you are trying to retrieve"}}],"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/dev-tools:gorgias/integrations-list-matching-parameters":{"get":{"operationId":"dev_tools_gorgias_integrations_list_matching_parameters","summary":"List integrations","description":"GET /api/integrations","tags":["dev-tools"],"parameters":[{"name":"domain","in":"query","required":true,"description":"Part of the server address: https://{domain}.gorgias.com","schema":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"}},{"name":"cursor","in":"query","required":false,"description":"Value indicating your position in the list of all integrations. If omitted, the first integrations of the list will be returned.","schema":{"type":"string","description":"Value indicating your position in the list of all integrations. If omitted, the first integrations of the list will be returned."}},{"name":"limit","in":"query","required":false,"description":"Maximum number of integrations to return.","schema":{"type":"integer","default":30,"description":"Maximum number of integrations to return."}},{"name":"order_by","in":"query","required":false,"description":"Attribute used to order integrations.","schema":{"type":"string","enum":["created_datetime:asc","created_datetime:desc"],"default":"created_datetime:desc","description":"Attribute used to order integrations."}},{"name":"page","in":"query","required":false,"description":"The index of the page to fetch. This parameter has been deprecated. Use __cursor__ and __limit__ instead.","schema":{"type":"integer","default":1,"description":"The index of the page to fetch. This parameter has been deprecated. Use __cursor__ and __limit__ instead."}},{"name":"per_page","in":"query","required":false,"description":"The maximum number of objects to fetch per page. Default: 1000.\" This parameter has been deprecated. Use __cursor__ and __limit__ instead.","schema":{"type":"integer","default":1000,"description":"The maximum number of objects to fetch per page. Default: 1000.\" This parameter has been deprecated. Use __cursor__ and __limit__ instead."}},{"name":"type","in":"query","required":false,"description":"Type of integration.","schema":{"type":"string","enum":["email","gmail","outlook","app","aircall","facebook","gorgias_chat","phone","sms","twitter","yotpo","whatsapp","http","shopify","recharge","smile","smooch_inside","smooch","magento2","zendesk","klaviyo","bigcommerce","alloy","ecom"],"description":"Type of integration."}}],"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/dev-tools:gorgias/integrations-create-integration":{"post":{"operationId":"dev_tools_gorgias_integrations_create_integration","summary":"Create an integration","description":"POST /api/integrations","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain","body"],"properties":{"domain":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"},"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/dev-tools:gorgias/jobs-list-paginated-jobs":{"get":{"operationId":"dev_tools_gorgias_jobs_list_paginated_jobs","summary":"List jobs","description":"GET /api/jobs","tags":["dev-tools"],"parameters":[{"name":"domain","in":"query","required":true,"description":"Part of the server address: https://{domain}.gorgias.com","schema":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"}},{"name":"cursor","in":"query","required":false,"description":"Value indicating your position in the list of all jobs. If omitted, the first jobs of the list will be returned.","schema":{"type":"string","description":"Value indicating your position in the list of all jobs. If omitted, the first jobs of the list will be returned."}},{"name":"limit","in":"query","required":false,"description":"Maximum number of jobs to return.","schema":{"type":"integer","default":30,"description":"Maximum number of jobs to return."}},{"name":"order_by","in":"query","required":false,"description":"Attribute used to order jobs.","schema":{"type":"string","enum":["created_datetime:asc","created_datetime:desc"],"default":"created_datetime:desc","description":"Attribute used to order jobs."}},{"name":"page","in":"query","required":false,"description":"The index of the page to fetch. This parameter has been deprecated. Use __cursor__ and __limit__ instead.","schema":{"type":"integer","default":1,"description":"The index of the page to fetch. This parameter has been deprecated. Use __cursor__ and __limit__ instead."}},{"name":"per_page","in":"query","required":false,"description":"The maximum number of objects to fetch per page. Default: 30. This parameter has been deprecated. Use __cursor__ and __limit__ instead.","schema":{"type":"integer","default":30,"description":"The maximum number of objects to fetch per page. Default: 30. This parameter has been deprecated. Use __cursor__ and __limit__ instead."}},{"name":"status","in":"query","required":false,"description":"Filter jobs by status.","schema":{"type":"string","enum":["cancel_requested","canceled","done","errored","fatal_errored","pending","running","scheduled"],"description":"Filter jobs by status."}},{"name":"type","in":"query","required":false,"description":"Filter jobs by job type.","schema":{"type":"string","enum":["applyMacro","deleteTicket","exportTicket","importMacro","exportMacro","updateTicket","exportTicketDrilldown"],"description":"Filter jobs by job type."}}],"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/dev-tools:gorgias/jobs-create-job-and-schedule-execution":{"post":{"operationId":"dev_tools_gorgias_jobs_create_job_and_schedule_execution","summary":"Create a job","description":"POST /api/jobs","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain","body"],"properties":{"domain":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"},"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/dev-tools:gorgias/macros-list-all-macros":{"get":{"operationId":"dev_tools_gorgias_macros_list_all_macros","summary":"List macros","description":"GET /api/macros","tags":["dev-tools"],"parameters":[{"name":"domain","in":"query","required":true,"description":"Part of the server address: https://{domain}.gorgias.com","schema":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"}},{"name":"tags","in":"query","required":false,"schema":{"type":"array"}},{"name":"languages","in":"query","required":false,"schema":{"type":"array"}},{"name":"_fallback_order_by","in":"query","required":false,"description":"In the case macros cannot be ordered by relevance, this ordering will be used as a fallback instead of returning a temporary error.","schema":{"type":"string","enum":["name","created_datetime","updated_datetime","usage"],"description":"In the case macros cannot be ordered by relevance, this ordering will be used as a fallback instead of returning a temporary error."}},{"name":"cursor","in":"query","required":false,"description":"Value indicating your position in the list of all tags. If omitted, the first tags of the list will be returned.","schema":{"type":"string","description":"Value indicating your position in the list of all tags. If omitted, the first tags of the list will be returned."}},{"name":"limit","in":"query","required":false,"description":"Maximum number of tags to return.","schema":{"type":"integer","default":30,"description":"Maximum number of tags to return."}},{"name":"message_id","in":"query","required":false,"description":"Order macros by the most relevant ones to reply to the given message. When specified, `order_by` must be set to `relevance` and…","schema":{"type":"integer","description":"Order macros by the most relevant ones to reply to the given message. When specified, `order_by` must be set to `relevance` and…"}},{"name":"order_by","in":"query","required":false,"description":"Order macros by the given attribute. If `relevance` is specified, `ticket_id` parameter is required and macros will be ordered by the most…","schema":{"type":"string","enum":["name","created_datetime","updated_datetime","usage","relevance","language","name:asc","name:desc","created_datetime:asc","created_datetime:desc","updated_datetime:asc","updated_datetime:desc","usage:asc","usage:desc","relevance:asc","relevance:desc","language:asc","language:desc"],"default":"usage","description":"Order macros by the given attribute. If `relevance` is specified, `ticket_id` parameter is required and macros will be ordered by the most…"}},{"name":"order_dir","in":"query","required":false,"description":"Order macros with the given order direction. This parameter has been deprecated. Use __order_by__ instead.","schema":{"type":"string","enum":["asc","desc"],"default":"desc","description":"Order macros with the given order direction. This parameter has been deprecated. Use __order_by__ instead."}},{"name":"page","in":"query","required":false,"description":"The index of the page to fetch.\" This parameter has been deprecated. Use __cursor__ and __limit__ instead.","schema":{"type":"integer","default":1,"description":"The index of the page to fetch.\" This parameter has been deprecated. Use __cursor__ and __limit__ instead."}},{"name":"per_page","in":"query","required":false,"description":"The maximum number of macros to fetch per page. Default: 30. This parameter has been deprecated. Use __cursor__ and __limit__ instead.","schema":{"type":"integer","default":30,"description":"The maximum number of macros to fetch per page. Default: 30. This parameter has been deprecated. Use __cursor__ and __limit__ instead."}},{"name":"search","in":"query","required":false,"description":"Filter macros containing the given search query.","schema":{"type":"string","description":"Filter macros containing the given search query."}},{"name":"ticket_id","in":"query","required":false,"description":"Order macros by the most relevant ones to reply to the given ticket. When specified, `order_by` must be set to `relevance`.","schema":{"type":"integer","description":"Order macros by the most relevant ones to reply to the given ticket. When specified, `order_by` must be set to `relevance`."}},{"name":"number_predictions","in":"query","required":false,"description":"Number of relevant macros to return on top of the list.","schema":{"type":"integer","default":0,"description":"Number of relevant macros to return on top of the list."}}],"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/dev-tools:gorgias/macros-create-macro":{"post":{"operationId":"dev_tools_gorgias_macros_create_macro","summary":"Create a macro","description":"POST /api/macros","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain","body"],"properties":{"domain":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"},"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/dev-tools:gorgias/rules-list-paginated":{"get":{"operationId":"dev_tools_gorgias_rules_list_paginated","summary":"List rules","description":"GET /api/rules","tags":["dev-tools"],"parameters":[{"name":"domain","in":"query","required":true,"description":"Part of the server address: https://{domain}.gorgias.com","schema":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"}},{"name":"cursor","in":"query","required":false,"description":"Value indicating your position in the list of all rules. If omitted, the first rules of the list will be returned.","schema":{"type":"string","description":"Value indicating your position in the list of all rules. If omitted, the first rules of the list will be returned."}},{"name":"limit","in":"query","required":false,"description":"Maximum number of rules to return.","schema":{"type":"integer","default":100,"description":"Maximum number of rules to return."}},{"name":"order_by","in":"query","required":false,"description":"Attribute used to order rules.","schema":{"type":"string","enum":["created_datetime:asc","created_datetime:desc"],"default":"created_datetime:desc","description":"Attribute used to order rules."}}],"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/dev-tools:gorgias/rules-create-rule":{"post":{"operationId":"dev_tools_gorgias_rules_create_rule","summary":"Create a rule","description":"POST /api/rules","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain","body"],"properties":{"domain":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"},"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/dev-tools:gorgias/rules-update-priorities":{"post":{"operationId":"dev_tools_gorgias_rules_update_priorities","summary":"Update rules' priorities","description":"POST /api/rules/priorities","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain","body"],"properties":{"domain":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"},"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/dev-tools:gorgias/satisfaction-surveys-list-surveys-paginated":{"get":{"operationId":"dev_tools_gorgias_satisfaction_surveys_list_surveys_paginated","summary":"List surveys","description":"GET /api/satisfaction-surveys","tags":["dev-tools"],"parameters":[{"name":"domain","in":"query","required":true,"description":"Part of the server address: https://{domain}.gorgias.com","schema":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"}},{"name":"cursor","in":"query","required":false,"description":"Value indicating your position in the list of all satisfaction surveys. If omitted, the first satisfaction survey of the list will be…","schema":{"type":"string","description":"Value indicating your position in the list of all satisfaction surveys. If omitted, the first satisfaction survey of the list will be…"}},{"name":"limit","in":"query","required":false,"description":"Maximum number of satisfaction surveys to return.","schema":{"type":"integer","default":30,"description":"Maximum number of satisfaction surveys to return."}},{"name":"order_by","in":"query","required":false,"description":"Attribute used to order satisfaction surveys.","schema":{"type":"string","enum":["created_datetime:asc","created_datetime:desc"],"default":"created_datetime:desc","description":"Attribute used to order satisfaction surveys."}}],"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/dev-tools:gorgias/satisfaction-surveys-create-survey":{"post":{"operationId":"dev_tools_gorgias_satisfaction_surveys_create_survey","summary":"Create a survey","description":"POST /api/satisfaction-surveys","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain","body"],"properties":{"domain":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"},"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/dev-tools:gorgias/search-resources-post":{"post":{"operationId":"dev_tools_gorgias_search_resources_post","summary":"Search for resources","description":"POST /api/search","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain","body"],"properties":{"domain":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"},"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/dev-tools:gorgias/users-list-paginated":{"get":{"operationId":"dev_tools_gorgias_users_list_paginated","summary":"List users","description":"GET /api/users","tags":["dev-tools"],"parameters":[{"name":"domain","in":"query","required":true,"description":"Part of the server address: https://{domain}.gorgias.com","schema":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"}},{"name":"cursor","in":"query","required":false,"description":"Value indicating your position in the list of all items. If omitted, the first items of the list will be returned.","schema":{"type":"string","description":"Value indicating your position in the list of all items. If omitted, the first items of the list will be returned."}},{"name":"email","in":"query","required":false,"description":"Email of the user you're looking for","schema":{"type":"string","description":"Email of the user you're looking for"}},{"name":"external_id","in":"query","required":false,"description":"ID of the user in a foreign system (Stripe, Aircall, etc...) you're looking for","schema":{"type":"string","description":"ID of the user in a foreign system (Stripe, Aircall, etc...) you're looking for"}},{"name":"limit","in":"query","required":false,"description":"Maximum number of items to return.","schema":{"type":"integer","default":30,"description":"Maximum number of items to return."}},{"name":"order_by","in":"query","required":false,"description":"Attribute used to order users.","schema":{"type":"string","enum":["created_datetime:asc","created_datetime:desc","name:asc","name:desc"],"default":"name:asc","description":"Attribute used to order users."}},{"name":"page","in":"query","required":false,"description":"The index of the page to fetch. This parameter has been deprecated. Use __cursor__ and __limit__ instead.","schema":{"type":"integer","default":1,"description":"The index of the page to fetch. This parameter has been deprecated. Use __cursor__ and __limit__ instead."}},{"name":"per_page","in":"query","required":false,"description":"The maximum number of items to fetch per page. This parameter has been deprecated. Use __cursor__ and __limit__ instead.","schema":{"type":"integer","default":30,"description":"The maximum number of items to fetch per page. This parameter has been deprecated. Use __cursor__ and __limit__ instead."}},{"name":"relationships","in":"query","required":false,"description":"Attribute used to fetch relationships of the User.","schema":{"type":"array","description":"Attribute used to fetch relationships of the User."}},{"name":"roles","in":"query","required":false,"description":"A list of roles to filter users.","schema":{"type":"array","description":"A list of roles to filter users."}}],"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/dev-tools:gorgias/users-create-user":{"post":{"operationId":"dev_tools_gorgias_users_create_user","summary":"Create a user","description":"POST /api/users","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain","body"],"properties":{"domain":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"},"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/dev-tools:gorgias/teams-list-matching-parameters":{"get":{"operationId":"dev_tools_gorgias_teams_list_matching_parameters","summary":"List teams","description":"GET /api/teams","tags":["dev-tools"],"parameters":[{"name":"domain","in":"query","required":true,"description":"Part of the server address: https://{domain}.gorgias.com","schema":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"}},{"name":"cursor","in":"query","required":false,"description":"Value indicating your position in the list of all teams. If omitted, the first team of the list will be returned.","schema":{"type":"string","description":"Value indicating your position in the list of all teams. If omitted, the first team of the list will be returned."}},{"name":"limit","in":"query","required":false,"description":"Maximum number of teams to return.","schema":{"type":"integer","default":30,"description":"Maximum number of teams to return."}},{"name":"order_by","in":"query","required":false,"description":"Attribute used to order teams.","schema":{"type":"string","enum":["created_datetime:asc","created_datetime:desc","name:asc","name:desc"],"default":"created_datetime:desc","description":"Attribute used to order teams."}}],"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/dev-tools:gorgias/teams-create-team":{"post":{"operationId":"dev_tools_gorgias_teams_create_team","summary":"Create a team","description":"POST /api/teams","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain","body"],"properties":{"domain":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"},"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/dev-tools:gorgias/tags-list-matching-parameters":{"get":{"operationId":"dev_tools_gorgias_tags_list_matching_parameters","summary":"List tags","description":"GET /api/tags","tags":["dev-tools"],"parameters":[{"name":"domain","in":"query","required":true,"description":"Part of the server address: https://{domain}.gorgias.com","schema":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"}},{"name":"order_by","in":"query","required":false,"description":"Order tags by the given attribute. Values `name`, `created_datetime`, `name`, `usage` have been deprecated . Use values with `:asc` or…","schema":{"type":"string","enum":["created_datetime","name","usage","created_datetime:asc","created_datetime:desc","name:asc","name:desc","usage:asc,name:asc","usage:desc,name:desc"],"default":"created_datetime:desc","description":"Order tags by the given attribute. Values `name`, `created_datetime`, `name`, `usage` have been deprecated . Use values with `:asc` or…"}},{"name":"order_dir","in":"query","required":false,"description":"Order tags with the given order direction. This parameter has been deprecated. Use __order_by__ instead.","schema":{"type":"string","enum":["desc","asc"],"default":"desc","description":"Order tags with the given order direction. This parameter has been deprecated. Use __order_by__ instead."}},{"name":"page","in":"query","required":false,"description":"The index of the page to fetch. This parameter has been deprecated. Use __cursor__ and __limit__ instead.","schema":{"type":"integer","default":1,"description":"The index of the page to fetch. This parameter has been deprecated. Use __cursor__ and __limit__ instead."}},{"name":"per_page","in":"query","required":false,"description":"The maximum number of items to fetch per page. This parameter has been deprecated. Use __cursor__ and __limit__ instead.","schema":{"type":"integer","default":30,"description":"The maximum number of items to fetch per page. This parameter has been deprecated. Use __cursor__ and __limit__ instead."}},{"name":"search","in":"query","required":false,"description":"Search for tags' names matching the given text query (case insensitive).","schema":{"type":"string","description":"Search for tags' names matching the given text query (case insensitive)."}},{"name":"cursor","in":"query","required":false,"description":"Value indicating your position in the list of all items. If omitted, the first items of the list will be returned.","schema":{"type":"string","description":"Value indicating your position in the list of all items. If omitted, the first items of the list will be returned."}},{"name":"limit","in":"query","required":false,"description":"Maximum number of items to return.","schema":{"type":"integer","default":30,"description":"Maximum number of items to return."}}],"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/dev-tools:gorgias/tags-create-tag":{"post":{"operationId":"dev_tools_gorgias_tags_create_tag","summary":"Create a tag","description":"POST /api/tags","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain","body"],"properties":{"domain":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"},"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/dev-tools:gorgias/tags-deactivate-all":{"post":{"operationId":"dev_tools_gorgias_tags_deactivate_all","summary":"Delete tags","description":"DELETE /api/tags","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain","body"],"properties":{"domain":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"},"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/dev-tools:gorgias/tags-merge-tags-into-destination":{"post":{"operationId":"dev_tools_gorgias_tags_merge_tags_into_destination","summary":"Merge tags","description":"PUT /api/tags/{destination_tag_id}/merge","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain","destination_tag_id","body"],"properties":{"domain":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"},"destination_tag_id":{"type":"integer","description":"The ID of the tag that will serve as base for the merge."},"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/dev-tools:gorgias/tickets-list-paginated":{"get":{"operationId":"dev_tools_gorgias_tickets_list_paginated","summary":"List tickets","description":"GET /api/tickets","tags":["dev-tools"],"parameters":[{"name":"domain","in":"query","required":true,"description":"Part of the server address: https://{domain}.gorgias.com","schema":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"}},{"name":"cursor","in":"query","required":false,"description":"Value indicating your position in the list of all tickets. If omitted, the first tickets of the list will be returned.","schema":{"type":"string","description":"Value indicating your position in the list of all tickets. If omitted, the first tickets of the list will be returned."}},{"name":"customer_id","in":"query","required":false,"description":"The ID of a [customer](https://developers.gorgias.com/) used to select their tickets.","schema":{"type":"integer","description":"The ID of a [customer](https://developers.gorgias.com/) used to select their tickets."}},{"name":"external_id","in":"query","required":false,"description":"ID of the ticket in a foreign system you're looking for.","schema":{"type":"string","description":"ID of the ticket in a foreign system you're looking for."}},{"name":"limit","in":"query","required":false,"description":"Maximum number of tickets to return.","schema":{"type":"integer","default":30,"description":"Maximum number of tickets to return."}},{"name":"order_by","in":"query","required":false,"description":"Attribute used to order tickets.","schema":{"type":"string","enum":["created_datetime:asc","created_datetime:desc","updated_datetime:asc","updated_datetime:desc"],"default":"created_datetime:desc","description":"Attribute used to order tickets."}},{"name":"view_id","in":"query","required":false,"description":"The ID of a [view](https://developers.gorgias.com/) used to select tickets matching the filters of this one.","schema":{"type":"integer","description":"The ID of a [view](https://developers.gorgias.com/) used to select tickets matching the filters of this one."}},{"name":"rule_id","in":"query","required":false,"description":"The ID of a [rule](https://developers.gorgias.com/) used to select tickets matching the filters of this one.","schema":{"type":"integer","description":"The ID of a [rule](https://developers.gorgias.com/) used to select tickets matching the filters of this one."}},{"name":"ticket_ids","in":"query","required":false,"description":"The IDs of tickets to select.","schema":{"type":"array","description":"The IDs of tickets to select."}}],"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/dev-tools:gorgias/tickets-create-new-ticket":{"post":{"operationId":"dev_tools_gorgias_tickets_create_new_ticket","summary":"Create a ticket","description":"POST /api/tickets","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain","body"],"properties":{"domain":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"},"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/dev-tools:gorgias/ticket-messages-create-new-message":{"post":{"operationId":"dev_tools_gorgias_ticket_messages_create_new_message","summary":"Create a message","description":"POST /api/tickets/{ticket_id}/messages","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain","ticket_id","body"],"properties":{"domain":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"},"ticket_id":{"type":"integer","description":"The ID of the ticket to create a message in."},"action":{"type":"string","enum":["force","retry","cancel"],"description":"Policy applied on external actions associated with the message if they failed. Three actions are possible: - force: bypass the failed…"},"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/dev-tools:gorgias/tickets-list-tags":{"get":{"operationId":"dev_tools_gorgias_tickets_list_tags","summary":"List ticket tags","description":"GET /api/tickets/{ticket_id}/tags","tags":["dev-tools"],"parameters":[{"name":"domain","in":"query","required":true,"description":"Part of the server address: https://{domain}.gorgias.com","schema":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"}},{"name":"ticket_id","in":"query","required":true,"description":"The ID of the ticket.","schema":{"type":"integer","description":"The ID of the ticket."}}],"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/dev-tools:gorgias/tickets-add-tags-to-ticket":{"post":{"operationId":"dev_tools_gorgias_tickets_add_tags_to_ticket","summary":"Add ticket tags","description":"POST /api/tickets/{ticket_id}/tags","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain","ticket_id","body"],"properties":{"domain":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"},"ticket_id":{"type":"integer","description":"The ID of the ticket."},"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/dev-tools:gorgias/tickets-set-tags":{"post":{"operationId":"dev_tools_gorgias_tickets_set_tags","summary":"Set ticket tags","description":"PUT /api/tickets/{ticket_id}/tags","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain","ticket_id","body"],"properties":{"domain":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"},"ticket_id":{"type":"integer","description":"The ID of the ticket."},"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/dev-tools:gorgias/tickets-remove-tags":{"post":{"operationId":"dev_tools_gorgias_tickets_remove_tags","summary":"Remove ticket tags","description":"DELETE /api/tickets/{ticket_id}/tags","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain","ticket_id","body"],"properties":{"domain":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"},"ticket_id":{"type":"integer","description":"The ID of the ticket."},"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/dev-tools:gorgias/tickets-list-custom-field-values":{"get":{"operationId":"dev_tools_gorgias_tickets_list_custom_field_values","summary":"List ticket field values","description":"GET /api/tickets/{ticket_id}/custom-fields","tags":["dev-tools"],"parameters":[{"name":"domain","in":"query","required":true,"description":"Part of the server address: https://{domain}.gorgias.com","schema":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"}},{"name":"ticket_id","in":"query","required":true,"description":"The ID of the ticket.","schema":{"type":"integer","description":"The ID of the ticket."}}],"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/dev-tools:gorgias/tickets-update-custom-fields-values":{"post":{"operationId":"dev_tools_gorgias_tickets_update_custom_fields_values","summary":"Update ticket fields values","description":"PUT /api/tickets/{ticket_id}/custom-fields","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain","ticket_id","body"],"properties":{"domain":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"},"ticket_id":{"type":"integer","description":"The ID of the ticket."},"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/dev-tools:gorgias/ticket-messages-list-matching":{"get":{"operationId":"dev_tools_gorgias_ticket_messages_list_matching","summary":"List messages","description":"GET /api/messages","tags":["dev-tools"],"parameters":[{"name":"domain","in":"query","required":true,"description":"Part of the server address: https://{domain}.gorgias.com","schema":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"}},{"name":"cursor","in":"query","required":false,"description":"Value indicating your position in the list of all messages. If omitted, the first messages of the list will be returned.","schema":{"type":"string","description":"Value indicating your position in the list of all messages. If omitted, the first messages of the list will be returned."}},{"name":"limit","in":"query","required":false,"description":"Maximum number of messages to return.","schema":{"type":"integer","default":30,"description":"Maximum number of messages to return."}},{"name":"order_by","in":"query","required":false,"description":"Attribute used to order messages.","schema":{"type":"string","enum":["created_datetime:asc","created_datetime:desc"],"default":"created_datetime:desc","description":"Attribute used to order messages."}},{"name":"ticket_id","in":"query","required":false,"description":"The ID of the ticket the messages are associated with.","schema":{"type":"integer","description":"The ID of the ticket the messages are associated with."}}],"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/dev-tools:gorgias/statistics-get-statistic":{"post":{"operationId":"dev_tools_gorgias_statistics_get_statistic","summary":"Retrieve a statistic","description":"POST /api/stats/{name}","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain","name","body"],"properties":{"domain":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"},"name":{"type":"string","enum":["overview","total-tickets-created","total-tickets-replied","total-tickets-closed","total-messages-sent","total-messages-received","median-first-response-time","median-resolution-time","total-one-touch-tickets","support-volume","resolution-time","first-response-time","tickets-created-per-hour-per-weekday","tickets-per-tag","tickets-created-per-channel","tickets-created-per-channel-per-day","tickets-closed-per-agent","tickets-closed-per-agent-per-day","messages-sent-per-macro","satisfaction-surveys","latest-satisfaction-surveys","intents-occurrence","intents-overview","intents-breakdown-per-day","revenue-overview","revenue-per-agent","revenue-per-day","revenue-per-ticket","self-service-overview","self-service-volume-per-flow","self-service-quick-response-performance","self-service-article-recommendation-performance","self-service-top-reported-issues","self-service-products-with-most-issues-and-return-requests","self-service-workflows-performance"],"description":"The name of the statistic to retrieve."},"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/dev-tools:gorgias/statistics-download-statistic-data":{"post":{"operationId":"dev_tools_gorgias_statistics_download_statistic_data","summary":"Download a statistic","description":"POST /api/stats/{name}/download","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain","name","body"],"properties":{"domain":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"},"name":{"type":"string","enum":["overview","total-tickets-created","total-tickets-replied","total-tickets-closed","total-messages-sent","total-messages-received","median-first-response-time","median-resolution-time","total-one-touch-tickets","support-volume","resolution-time","first-response-time","tickets-created-per-hour-per-weekday","tickets-per-tag","tickets-created-per-channel","tickets-created-per-channel-per-day","tickets-closed-per-agent","tickets-closed-per-agent-per-day","messages-sent-per-macro","satisfaction-surveys","latest-satisfaction-surveys","intents-occurrence","intents-overview","intents-breakdown-per-day","revenue-overview","revenue-per-agent","revenue-per-day","revenue-per-ticket","self-service-overview","self-service-volume-per-flow","self-service-quick-response-performance","self-service-article-recommendation-performance","self-service-top-reported-issues","self-service-products-with-most-issues-and-return-requests","self-service-workflows-performance"],"description":"The name of the statistic to retrieve."},"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/dev-tools:gorgias/views-list-ordered-views":{"get":{"operationId":"dev_tools_gorgias_views_list_ordered_views","summary":"List views","description":"GET /api/views","tags":["dev-tools"],"parameters":[{"name":"domain","in":"query","required":true,"description":"Part of the server address: https://{domain}.gorgias.com","schema":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"}},{"name":"cursor","in":"query","required":false,"description":"Value indicating your position in the list of all views. If omitted, the first views of the list will be returned.","schema":{"type":"string","description":"Value indicating your position in the list of all views. If omitted, the first views of the list will be returned."}},{"name":"limit","in":"query","required":false,"description":"Maximum number of views to return.","schema":{"type":"integer","default":30,"description":"Maximum number of views to return."}},{"name":"order_by","in":"query","required":false,"description":"Attribute used to order views.","schema":{"type":"string","enum":["created_datetime:asc","created_datetime:desc"],"default":"created_datetime:desc","description":"Attribute used to order views."}}],"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/dev-tools:gorgias/views-create-new-view":{"post":{"operationId":"dev_tools_gorgias_views_create_new_view","summary":"Create a view","description":"POST /api/views","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain","body"],"properties":{"domain":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"},"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/dev-tools:gorgias/views-list-view-items":{"get":{"operationId":"dev_tools_gorgias_views_list_view_items","summary":"List view's items","description":"GET /api/views/{view_id}/items","tags":["dev-tools"],"parameters":[{"name":"domain","in":"query","required":true,"description":"Part of the server address: https://{domain}.gorgias.com","schema":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"}},{"name":"view_id","in":"query","required":true,"description":"The ID of the view to list items from.","schema":{"type":"integer","description":"The ID of the view to list items from."}},{"name":"cursor","in":"query","required":false,"description":"Value indicating your position in the list of all the view's items. If omitted, the first items of the list will be returned.","schema":{"type":"string","description":"Value indicating your position in the list of all the view's items. If omitted, the first items of the list will be returned."}},{"name":"direction","in":"query","required":false,"description":"- `prev` returns items before the cursor. - `next` returns items after the cursor.","schema":{"type":"string","enum":["prev","next"],"description":"- `prev` returns items before the cursor. - `next` returns items after the cursor."}},{"name":"ignored_item","in":"query","required":false,"description":"ID of an item to ignore in the list of returned items.","schema":{"type":"integer","description":"ID of an item to ignore in the list of returned items."}},{"name":"limit","in":"query","required":false,"description":"Maximum number of items to return.","schema":{"type":"integer","default":30,"description":"Maximum number of items to return."}}],"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/dev-tools:gorgias/views-search-view-items":{"post":{"operationId":"dev_tools_gorgias_views_search_view_items","summary":"Search for view's items","description":"PUT /api/views/{view_id}/items","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain","view_id","body"],"properties":{"domain":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"},"view_id":{"type":"integer","description":"This parameter should be set to 0."},"cursor":{"type":"string","description":"Value indicating your position in the list of all the view's items. If omitted, the first items of the list will be returned."},"direction":{"type":"string","enum":["prev","next"],"description":"- `prev` returns items before the cursor. - `next` returns items after the cursor."},"ignored_item":{"type":"integer","description":"ID of an item to ignore in the list of returned items."},"limit":{"type":"integer","default":30,"description":"Maximum number of items to return."},"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/dev-tools:gorgias/voice-calls-list-matching-parameters":{"get":{"operationId":"dev_tools_gorgias_voice_calls_list_matching_parameters","summary":"List voice calls","description":"GET /api/phone/voice-calls","tags":["dev-tools"],"parameters":[{"name":"domain","in":"query","required":true,"description":"Part of the server address: https://{domain}.gorgias.com","schema":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"}},{"name":"cursor","in":"query","required":false,"description":"Value indicating your position in the list of all items. If omitted, the first items of the list will be returned.","schema":{"type":"string","description":"Value indicating your position in the list of all items. If omitted, the first items of the list will be returned."}},{"name":"limit","in":"query","required":false,"description":"Maximum number of items to return.","schema":{"type":"integer","default":30,"description":"Maximum number of items to return."}},{"name":"ticket_id","in":"query","required":false,"schema":{"type":"integer"}}],"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/dev-tools:gorgias/voice-call-recordings-list-matching-parameters":{"get":{"operationId":"dev_tools_gorgias_voice_call_recordings_list_matching_parameters","summary":"List voice call recordings","description":"GET /api/phone/voice-call-recordings","tags":["dev-tools"],"parameters":[{"name":"domain","in":"query","required":true,"description":"Part of the server address: https://{domain}.gorgias.com","schema":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"}},{"name":"cursor","in":"query","required":false,"description":"Value indicating your position in the list of all items. If omitted, the first items of the list will be returned.","schema":{"type":"string","description":"Value indicating your position in the list of all items. If omitted, the first items of the list will be returned."}},{"name":"limit","in":"query","required":false,"description":"Maximum number of items to return.","schema":{"type":"integer","default":30,"description":"Maximum number of items to return."}},{"name":"call_id","in":"query","required":false,"schema":{"type":"integer"}}],"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/dev-tools:gorgias/voice-call-events-list-matching-parameters":{"get":{"operationId":"dev_tools_gorgias_voice_call_events_list_matching_parameters","summary":"List voice call events","description":"GET /api/phone/voice-call-events","tags":["dev-tools"],"parameters":[{"name":"domain","in":"query","required":true,"description":"Part of the server address: https://{domain}.gorgias.com","schema":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"}},{"name":"cursor","in":"query","required":false,"description":"Value indicating your position in the list of all items. If omitted, the first items of the list will be returned.","schema":{"type":"string","description":"Value indicating your position in the list of all items. If omitted, the first items of the list will be returned."}},{"name":"limit","in":"query","required":false,"description":"Maximum number of items to return.","schema":{"type":"integer","default":30,"description":"Maximum number of items to return."}},{"name":"call_id","in":"query","required":false,"schema":{"type":"integer"}}],"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/dev-tools:gorgias/widgets-list-ordered":{"get":{"operationId":"dev_tools_gorgias_widgets_list_ordered","summary":"List widgets","description":"GET /api/widgets","tags":["dev-tools"],"parameters":[{"name":"domain","in":"query","required":true,"description":"Part of the server address: https://{domain}.gorgias.com","schema":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"}},{"name":"cursor","in":"query","required":false,"description":"Value indicating your position in the list of all widgets. If omitted, the first widgets of the list will be returned.","schema":{"type":"string","description":"Value indicating your position in the list of all widgets. If omitted, the first widgets of the list will be returned."}},{"name":"limit","in":"query","required":false,"description":"Maximum number of widgets to return.","schema":{"type":"integer","default":30,"description":"Maximum number of widgets to return."}},{"name":"order_by","in":"query","required":false,"description":"Attribute used to order widgets.","schema":{"type":"string","enum":["created_datetime:asc","created_datetime:desc","order:asc","order:desc"],"default":"created_datetime:desc","description":"Attribute used to order widgets."}},{"name":"integration_id","in":"query","required":false,"description":"The ID of the integration to filter the widgets list by.","schema":{"type":"integer","description":"The ID of the integration to filter the widgets list by."}},{"name":"app_id","in":"query","required":false,"description":"The ID of the 3rd party app to filter the widgets list by.","schema":{"type":"string","description":"The ID of the 3rd party app to filter the widgets list by."}}],"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/dev-tools:gorgias/widgets-create-widget":{"post":{"operationId":"dev_tools_gorgias_widgets_create_widget","summary":"Create a widget","description":"POST /api/widgets","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain","body"],"properties":{"domain":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"},"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/dev-tools:gorgias/customers-get-by-id":{"get":{"operationId":"dev_tools_gorgias_customers_get_by_id","summary":"Retrieve a customer","description":"GET /api/customers/{id}","tags":["dev-tools"],"parameters":[{"name":"domain","in":"query","required":true,"description":"Part of the server address: https://{domain}.gorgias.com","schema":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"}},{"name":"id","in":"query","required":true,"description":"The ID of the customer to retrieve.","schema":{"type":"integer","description":"The ID of the customer to retrieve."}}],"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/dev-tools:gorgias/customers-update-customer-by-id":{"post":{"operationId":"dev_tools_gorgias_customers_update_customer_by_id","summary":"Update a customer","description":"PUT /api/customers/{id}","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain","id","body"],"properties":{"domain":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"},"id":{"type":"integer","description":"The ID of the customer to update."},"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/dev-tools:gorgias/customers-remove-by-id":{"post":{"operationId":"dev_tools_gorgias_customers_remove_by_id","summary":"Delete a customer","description":"DELETE /api/customers/{id}","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain","id"],"properties":{"domain":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"},"id":{"type":"integer","description":"The ID of the customer to delete."}}}}}},"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/dev-tools:gorgias/custom-fields-get-by-id":{"get":{"operationId":"dev_tools_gorgias_custom_fields_get_by_id","summary":"Retrieve a custom field","description":"GET /api/custom-fields/{id}","tags":["dev-tools"],"parameters":[{"name":"domain","in":"query","required":true,"description":"Part of the server address: https://{domain}.gorgias.com","schema":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"}},{"name":"id","in":"query","required":true,"description":"The ID of the custom field to retrieve.","schema":{"type":"integer","description":"The ID of the custom field to retrieve."}}],"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/dev-tools:gorgias/custom-fields-update-by-id":{"post":{"operationId":"dev_tools_gorgias_custom_fields_update_by_id","summary":"Update a custom field","description":"PUT /api/custom-fields/{id}","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain","id","body"],"properties":{"domain":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"},"id":{"type":"integer","description":"The ID of the custom field to update."},"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/dev-tools:gorgias/events-get-event-by-id":{"get":{"operationId":"dev_tools_gorgias_events_get_event_by_id","summary":"Retrieve an event","description":"GET /api/events/{id}","tags":["dev-tools"],"parameters":[{"name":"domain","in":"query","required":true,"description":"Part of the server address: https://{domain}.gorgias.com","schema":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"}},{"name":"id","in":"query","required":true,"description":"The ID of the event to retrieve.","schema":{"type":"integer","description":"The ID of the event to retrieve."}}],"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/dev-tools:gorgias/integrations-get-by-id":{"get":{"operationId":"dev_tools_gorgias_integrations_get_by_id","summary":"Retrieve an integration","description":"GET /api/integrations/{id}","tags":["dev-tools"],"parameters":[{"name":"domain","in":"query","required":true,"description":"Part of the server address: https://{domain}.gorgias.com","schema":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"}},{"name":"id","in":"query","required":true,"description":"The ID of the integration to retrieve.","schema":{"type":"integer","description":"The ID of the integration to retrieve."}}],"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/dev-tools:gorgias/integrations-update-by-id":{"post":{"operationId":"dev_tools_gorgias_integrations_update_by_id","summary":"Update an integration","description":"PUT /api/integrations/{id}","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain","id","body"],"properties":{"domain":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"},"id":{"type":"integer","description":"The ID of the integration to update."},"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/dev-tools:gorgias/integrations-delete-integration":{"post":{"operationId":"dev_tools_gorgias_integrations_delete_integration","summary":"Delete an integration","description":"DELETE /api/integrations/{id}","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain","id"],"properties":{"domain":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"},"id":{"type":"integer","description":"The ID of the integration to delete."}}}}}},"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/dev-tools:gorgias/jobs-get-by-id":{"get":{"operationId":"dev_tools_gorgias_jobs_get_by_id","summary":"Retrieve a job","description":"GET /api/jobs/{id}","tags":["dev-tools"],"parameters":[{"name":"domain","in":"query","required":true,"description":"Part of the server address: https://{domain}.gorgias.com","schema":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"}},{"name":"id","in":"query","required":true,"description":"The ID of the job to retrieve.","schema":{"type":"integer","description":"The ID of the job to retrieve."}}],"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/dev-tools:gorgias/jobs-update-by-id":{"post":{"operationId":"dev_tools_gorgias_jobs_update_by_id","summary":"Update a job","description":"PUT /api/jobs/{id}","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain","id","body"],"properties":{"domain":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"},"id":{"type":"integer","description":"The ID of the job to update."},"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/dev-tools:gorgias/jobs-cancel-job":{"post":{"operationId":"dev_tools_gorgias_jobs_cancel_job","summary":"Cancel a job","description":"DELETE /api/jobs/{id}","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain","id"],"properties":{"domain":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"},"id":{"type":"integer","description":"The ID of the job to cancel."}}}}}},"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/dev-tools:gorgias/macros-get-macro-by-id":{"get":{"operationId":"dev_tools_gorgias_macros_get_macro_by_id","summary":"Retrieve a macro","description":"GET /api/macros/{id}","tags":["dev-tools"],"parameters":[{"name":"domain","in":"query","required":true,"description":"Part of the server address: https://{domain}.gorgias.com","schema":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"}},{"name":"id","in":"query","required":true,"description":"The ID of the macro to retrieve.","schema":{"type":"integer","description":"The ID of the macro to retrieve."}}],"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/dev-tools:gorgias/macros-update-macro-by-id":{"post":{"operationId":"dev_tools_gorgias_macros_update_macro_by_id","summary":"Update a macro","description":"PUT /api/macros/{id}","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain","id","body"],"properties":{"domain":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"},"id":{"type":"integer","description":"The ID of the macro to update."},"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/dev-tools:gorgias/macros-delete-macro-by-id":{"post":{"operationId":"dev_tools_gorgias_macros_delete_macro_by_id","summary":"Delete a macro","description":"DELETE /api/macros/{id}","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain","id"],"properties":{"domain":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"},"id":{"type":"integer","description":"The ID of the macro to delete."}}}}}},"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/dev-tools:gorgias/rules-get-rule-by-id":{"get":{"operationId":"dev_tools_gorgias_rules_get_rule_by_id","summary":"Retrieve a rule","description":"GET /api/rules/{id}","tags":["dev-tools"],"parameters":[{"name":"domain","in":"query","required":true,"description":"Part of the server address: https://{domain}.gorgias.com","schema":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"}},{"name":"id","in":"query","required":true,"description":"The ID of the rule to retrieve.","schema":{"type":"integer","description":"The ID of the rule to retrieve."}}],"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/dev-tools:gorgias/rules-update-rule-by-id":{"post":{"operationId":"dev_tools_gorgias_rules_update_rule_by_id","summary":"Update a rule","description":"PUT /api/rules/{id}","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain","id","body"],"properties":{"domain":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"},"id":{"type":"integer","description":"The ID of the rule to update."},"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/dev-tools:gorgias/rules-delete-rule-by-id":{"post":{"operationId":"dev_tools_gorgias_rules_delete_rule_by_id","summary":"Delete a rule","description":"DELETE /api/rules/{id}","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain","id"],"properties":{"domain":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"},"id":{"type":"integer","description":"The ID of the rule to delete."}}}}}},"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/dev-tools:gorgias/satisfaction-surveys-get-survey":{"get":{"operationId":"dev_tools_gorgias_satisfaction_surveys_get_survey","summary":"Retrieve a survey","description":"GET /api/satisfaction-surveys/{id}","tags":["dev-tools"],"parameters":[{"name":"domain","in":"query","required":true,"description":"Part of the server address: https://{domain}.gorgias.com","schema":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"}},{"name":"id","in":"query","required":true,"description":"The ID of the survey to retrieve.","schema":{"type":"integer","description":"The ID of the survey to retrieve."}}],"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/dev-tools:gorgias/satisfaction-surveys-update-survey":{"post":{"operationId":"dev_tools_gorgias_satisfaction_surveys_update_survey","summary":"Update a survey","description":"PUT /api/satisfaction-surveys/{id}","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain","id","body"],"properties":{"domain":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"},"id":{"type":"integer","description":"The ID of the survey to update."},"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/dev-tools:gorgias/users-get-user-by-id":{"get":{"operationId":"dev_tools_gorgias_users_get_user_by_id","summary":"Retrieve a user","description":"GET /api/users/{id}","tags":["dev-tools"],"parameters":[{"name":"domain","in":"query","required":true,"description":"Part of the server address: https://{domain}.gorgias.com","schema":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"}},{"name":"id","in":"query","required":true,"description":"The ID of the user to retrieve. Use the ID `0` to fetch your user (current user).","schema":{"type":"integer","description":"The ID of the user to retrieve. Use the ID `0` to fetch your user (current user)."}}],"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/dev-tools:gorgias/users-update-user-by-id":{"post":{"operationId":"dev_tools_gorgias_users_update_user_by_id","summary":"Update a user","description":"PUT /api/users/{id}","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain","id","body"],"properties":{"domain":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"},"id":{"type":"integer","description":"The ID of the user to update. Use the ID `0` to update your user (current user)."},"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/dev-tools:gorgias/users-delete-user":{"post":{"operationId":"dev_tools_gorgias_users_delete_user","summary":"Delete a user","description":"DELETE /api/users/{id}","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain","id"],"properties":{"domain":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"},"id":{"type":"integer","description":"The ID of the user to delete."}}}}}},"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/dev-tools:gorgias/teams-get-team-by-id":{"get":{"operationId":"dev_tools_gorgias_teams_get_team_by_id","summary":"Retrieve a team","description":"GET /api/teams/{id}","tags":["dev-tools"],"parameters":[{"name":"domain","in":"query","required":true,"description":"Part of the server address: https://{domain}.gorgias.com","schema":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"}},{"name":"id","in":"query","required":true,"description":"The ID of the team to retrieve.","schema":{"type":"integer","description":"The ID of the team to retrieve."}}],"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/dev-tools:gorgias/teams-update-team-by-id":{"post":{"operationId":"dev_tools_gorgias_teams_update_team_by_id","summary":"Update a team","description":"PUT /api/teams/{id}","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain","id","body"],"properties":{"domain":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"},"id":{"type":"integer","description":"The ID of the team to update."},"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/dev-tools:gorgias/teams-delete-team-by-id":{"post":{"operationId":"dev_tools_gorgias_teams_delete_team_by_id","summary":"Delete a team","description":"DELETE /api/teams/{id}","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain","id"],"properties":{"domain":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"},"id":{"type":"integer","description":"The ID of the team to delete."}}}}}},"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/dev-tools:gorgias/tags-get-tag":{"get":{"operationId":"dev_tools_gorgias_tags_get_tag","summary":"Retrieve a tag","description":"GET /api/tags/{id}","tags":["dev-tools"],"parameters":[{"name":"domain","in":"query","required":true,"description":"Part of the server address: https://{domain}.gorgias.com","schema":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"}},{"name":"id","in":"query","required":true,"description":"The ID of the tag to retrieve.","schema":{"type":"integer","description":"The ID of the tag to retrieve."}}],"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/dev-tools:gorgias/tags-update-tag-by-id":{"post":{"operationId":"dev_tools_gorgias_tags_update_tag_by_id","summary":"Update a tag","description":"PUT /api/tags/{id}","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain","id","body"],"properties":{"domain":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"},"id":{"type":"integer","description":"The ID of the tag to update."},"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/dev-tools:gorgias/tags-delete-tag":{"post":{"operationId":"dev_tools_gorgias_tags_delete_tag","summary":"Delete a tag","description":"DELETE /api/tags/{id}","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain","id"],"properties":{"domain":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"},"id":{"type":"integer","description":"The ID of the tag to delete."}}}}}},"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/dev-tools:gorgias/tickets-get-by-id":{"get":{"operationId":"dev_tools_gorgias_tickets_get_by_id","summary":"Retrieve a ticket","description":"GET /api/tickets/{id}","tags":["dev-tools"],"parameters":[{"name":"domain","in":"query","required":true,"description":"Part of the server address: https://{domain}.gorgias.com","schema":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"}},{"name":"id","in":"query","required":true,"description":"The ID of the ticket to retrieve.","schema":{"type":"integer","description":"The ID of the ticket to retrieve."}},{"name":"relationships","in":"query","required":false,"description":"Names of relations that should be included in returned data.","schema":{"type":"array","description":"Names of relations that should be included in returned data."}}],"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/dev-tools:gorgias/tickets-update-ticket-by-id":{"post":{"operationId":"dev_tools_gorgias_tickets_update_ticket_by_id","summary":"Update a ticket","description":"PUT /api/tickets/{id}","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain","id","body"],"properties":{"domain":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"},"id":{"type":"integer","description":"The ID of the ticket to update."},"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/dev-tools:gorgias/tickets-delete-by-id":{"post":{"operationId":"dev_tools_gorgias_tickets_delete_by_id","summary":"Delete a ticket","description":"DELETE /api/tickets/{id}","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain","id"],"properties":{"domain":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"},"id":{"type":"integer","description":"The ID of the ticket to delete."}}}}}},"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/dev-tools:gorgias/ticket-messages-get-message":{"get":{"operationId":"dev_tools_gorgias_ticket_messages_get_message","summary":"Retrieve a message","description":"GET /api/tickets/{ticket_id}/messages/{id}","tags":["dev-tools"],"parameters":[{"name":"domain","in":"query","required":true,"description":"Part of the server address: https://{domain}.gorgias.com","schema":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"}},{"name":"ticket_id","in":"query","required":true,"description":"The ID of the ticket associated with the message.","schema":{"type":"integer","description":"The ID of the ticket associated with the message."}},{"name":"id","in":"query","required":true,"description":"The ID of the message to retrieve.","schema":{"type":"integer","description":"The ID of the message to retrieve."}}],"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/dev-tools:gorgias/ticket-messages-update-message":{"post":{"operationId":"dev_tools_gorgias_ticket_messages_update_message","summary":"Update a message","description":"PUT /api/tickets/{ticket_id}/messages/{id}","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain","ticket_id","id","body"],"properties":{"domain":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"},"ticket_id":{"type":"integer","description":"The ID of the ticket associated with the message."},"id":{"type":"integer","description":"The ID of the message to update."},"action":{"type":"string","enum":["force","retry","cancel"],"description":"Policy applied on external actions associated with the message if they failed. Three actions are possible: - force: bypass the failed…"},"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/dev-tools:gorgias/ticket-messages-delete-message-by-id":{"post":{"operationId":"dev_tools_gorgias_ticket_messages_delete_message_by_id","summary":"Delete a message","description":"DELETE /api/tickets/{ticket_id}/messages/{id}","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain","ticket_id","id"],"properties":{"domain":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"},"ticket_id":{"type":"integer","description":"The ID of the ticket associated with the message."},"id":{"type":"integer","description":"The ID of the message to delete."}}}}}},"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/dev-tools:gorgias/tickets-update-custom-field-value":{"post":{"operationId":"dev_tools_gorgias_tickets_update_custom_field_value","summary":"Update ticket field value","description":"PUT /api/tickets/{ticket_id}/custom-fields/{id}","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain","ticket_id","id","body"],"properties":{"domain":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"},"ticket_id":{"type":"integer","description":"The ID of the ticket."},"id":{"type":"integer","description":"The ID of the custom field."},"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/dev-tools:gorgias/tickets-delete-field-value":{"post":{"operationId":"dev_tools_gorgias_tickets_delete_field_value","summary":"Delete ticket field value","description":"DELETE /api/tickets/{ticket_id}/custom-fields/{id}","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain","ticket_id","id"],"properties":{"domain":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"},"ticket_id":{"type":"integer","description":"The ID of the ticket."},"id":{"type":"integer","description":"The ID of the custom field."}}}}}},"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/dev-tools:gorgias/views-get-by-id":{"get":{"operationId":"dev_tools_gorgias_views_get_by_id","summary":"Retrieve a view","description":"GET /api/views/{id}","tags":["dev-tools"],"parameters":[{"name":"domain","in":"query","required":true,"description":"Part of the server address: https://{domain}.gorgias.com","schema":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"}},{"name":"id","in":"query","required":true,"description":"The ID of the view to retrieve.","schema":{"type":"integer","description":"The ID of the view to retrieve."}}],"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/dev-tools:gorgias/views-update-view-by-id":{"post":{"operationId":"dev_tools_gorgias_views_update_view_by_id","summary":"Update a view","description":"PUT /api/views/{id}","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain","id","body"],"properties":{"domain":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"},"id":{"type":"integer","description":"The ID of the view to update."},"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/dev-tools:gorgias/views-delete-view":{"post":{"operationId":"dev_tools_gorgias_views_delete_view","summary":"Delete a view","description":"DELETE /api/views/{id}","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain","id"],"properties":{"domain":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"},"id":{"type":"integer","description":"The ID of the view to delete."}}}}}},"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/dev-tools:gorgias/voice-calls-get-by-id":{"get":{"operationId":"dev_tools_gorgias_voice_calls_get_by_id","summary":"Retrieve a voice call","description":"GET /api/phone/voice-calls/{id}","tags":["dev-tools"],"parameters":[{"name":"domain","in":"query","required":true,"description":"Part of the server address: https://{domain}.gorgias.com","schema":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"}},{"name":"id","in":"query","required":true,"description":"The ID of the voice call to retrieve.","schema":{"type":"integer","description":"The ID of the voice call to retrieve."}}],"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/dev-tools:gorgias/voice-call-recordings-get-by-id":{"get":{"operationId":"dev_tools_gorgias_voice_call_recordings_get_by_id","summary":"Retrieve a voice call recording","description":"GET /api/phone/voice-call-recordings/{id}","tags":["dev-tools"],"parameters":[{"name":"domain","in":"query","required":true,"description":"Part of the server address: https://{domain}.gorgias.com","schema":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"}},{"name":"id","in":"query","required":true,"description":"The ID of the voice call recording to retrieve.","schema":{"type":"integer","description":"The ID of the voice call recording to retrieve."}}],"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/dev-tools:gorgias/voice-call-recordings-delete-recording":{"post":{"operationId":"dev_tools_gorgias_voice_call_recordings_delete_recording","summary":"Delete a voice call recording","description":"DELETE /api/phone/voice-call-recordings/{id}","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain","id"],"properties":{"domain":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"},"id":{"type":"integer","description":"The ID of the voice call recording to delete."}}}}}},"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/dev-tools:gorgias/voice-call-events-get-event-by-id":{"get":{"operationId":"dev_tools_gorgias_voice_call_events_get_event_by_id","summary":"Retrieve a voice call event","description":"GET /api/phone/voice-call-events/{id}","tags":["dev-tools"],"parameters":[{"name":"domain","in":"query","required":true,"description":"Part of the server address: https://{domain}.gorgias.com","schema":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"}},{"name":"id","in":"query","required":true,"description":"The ID of the voice event to retrieve.","schema":{"type":"integer","description":"The ID of the voice event to retrieve."}}],"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/dev-tools:gorgias/widgets-get-by-id":{"get":{"operationId":"dev_tools_gorgias_widgets_get_by_id","summary":"Retrieve a widget","description":"GET /api/widgets/{id}","tags":["dev-tools"],"parameters":[{"name":"domain","in":"query","required":true,"description":"Part of the server address: https://{domain}.gorgias.com","schema":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"}},{"name":"id","in":"query","required":true,"description":"The ID of the widget to retrieve.","schema":{"type":"integer","description":"The ID of the widget to retrieve."}}],"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/dev-tools:gorgias/widgets-update-by-id":{"post":{"operationId":"dev_tools_gorgias_widgets_update_by_id","summary":"Update a widget","description":"PUT /api/widgets/{id}","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain","id","body"],"properties":{"domain":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"},"id":{"type":"integer","description":"The ID of the widget to update."},"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/dev-tools:gorgias/widgets-delete-by-id":{"post":{"operationId":"dev_tools_gorgias_widgets_delete_by_id","summary":"Delete a widget","description":"DELETE /api/widgets/{id}","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain","id"],"properties":{"domain":{"type":"string","description":"Part of the server address: https://{domain}.gorgias.com"},"id":{"type":"integer","description":"The ID of the widget to delete."}}}}}},"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"}}},"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"}}}}}}}