{"openapi":"3.0.2","info":{"title":"Talkdesk API","description":"Tags all public endpoints with API ranks","version":"1.0.0","contact":{"name":"Talkdesk","url":"https://talkdesk.com"}},"paths":{"/account":{"get":{"description":"Get Account Details","security":[{"GA":["account:read"]}],"tags":["Account"],"responses":{"200":{"description":"Account details","content":{"application/json":{"schema":{"example":{"id":"c65186ee-3780-468e-968b-ca15b981c312","name":"airmattress","company_name":"Air Mattress","email":"joseph.pinetree@talkdesk.com","timezone":"America/Los_Angeles","created_at":"2018-06-28T14:04:07.000Z","_links":{"self":{"href":"http://api-docs.talkdesk.org/account"}}},"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","description":"a unique name identifier for the account (used for its subdomain)"},"company_name":{"type":"string","description":"a friendly, human-readable name for the account"},"email":{"type":"string","format":"email","description":"primary email associated with the account"},"timezone":{"type":"string","description":"IANA (Internet Assigned Numbers Authority) time zone database"},"created_at":{"type":"string","description":"account creation date","format":"date-time"},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","default":"http://api-docs.talkdesk.org/account"},"users":{"type":"string","default":"http://api-docs.talkdesk.org/users"}}}}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0060001","message":"Access denied."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0060002","message":"Forbidden access."}}}},"404":{"description":"Account not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0060000","message":"Account not found."}}}}}}},"/account/wallets":{"get":{"description":"Get account wallet list","security":[{"GA":["account-wallets:read"]}],"tags":["Usage Manager"],"parameters":[{"in":"query","name":"page","required":false,"schema":{"type":"integer","minimum":1,"maximum":2147483647,"default":1},"description":"Page number"},{"in":"query","name":"per_page","required":false,"schema":{"type":"integer","default":20,"minimum":1,"maximum":100},"description":"Maximum number of items per page"},{"in":"query","name":"filter","schema":{"type":"string","minLength":0,"maxLength":2147483647,"x-operators":["and","eq","or","not","contains","( )"]},"required":false,"example":"product_name eq 'SaaS Consumption-Licensing' or name contains ('product_usage','telco_usage')","description":"Filter wallets according to the specified filter expression.\n\nCurrently you can filter by the following attributes:\n* `name` - Filter by wallet name. E.g. `name eq 'product_usage'`.\n* `product_name` - Filter by product name. E.g. `product_name eq 'SaaS Consumption-Licensing'`.\nSupported comparison operators:\n* `contains` - Match if any value is within the list, i.e. evaluates to true if any value of the contains operand matches the value in the database. E.g. `contains(product_name, 'standard')`.\n* `eq` - Exact match, i.e. only evaluates to true if both operands have the same value. E.g. `name eq 'saas_licenses'`.\nSupported logical operators:\n* `and` - AND logical operator. E.g. `name eq 'saas_licenses' and product_name eq 'Talkdesk Fax'`.\n* `or` - OR logical operator. E.g. `name eq 'saas_licenses' or product_name eq 'Talkdesk Fax'`.\n* `not` - NOT logical operator. E.g. `not product_name eq 'product_usage'`.\nSupported precedence operators:\n* `(` and `)` - Parentheses precedence operator. You can force some expressions to be evaluated first than another by enclosing them into parentheses E.g. `(name eq 'saas_licenses' and product_name eq 'Talkdesk Fax') or name eq 'guardian'` is different than `name eq 'saas_licenses'\n and (product_name eq 'Talkdesk Fax' or name eq 'guardian')`.\nValues must have single quotes marks e.g.: `name eq 'guardian'`\n\nExamples\n* `filter=product_name eq 'Saas Licenses' and (name eq 'saas_licenses' and contains(product_name, 'digital')` - Retrieve the wallets that have product_name 'Saas Licenses' and thatname is 'saas_licenses' or product_name contains the string 'digital' within.\n* `filter=name eq 'ai_premium_batch' or contains(product_name, 'realtime') - Retrieves the wallets that have name 'ai_premium_batch' or that product_name contains the string 'realtime' within.\n"},{"in":"query","name":"order_by","description":"Sorts by the indicated field in the specified direction, ascending or descending.\n The expression format may contain the suffix asc or desc separated from the property name with a colon in between.
\n Examples:\n More information here","schema":{"type":"string","x-sorting_default_order":"asc","default":"name:asc","x-sorting_fields":["name","product_name","balance"],"minLength":0,"maxLength":2147483647},"example":"name:asc"}],"responses":{"200":{"description":"Account wallet list","content":{"application/json":{"schema":{"type":"object","required":["total","count","page","per_page","_links","_embedded"],"properties":{"total":{"type":"integer"},"count":{"type":"integer"},"page":{"type":"integer"},"per_page":{"type":"integer"},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}},"first":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}},"prev":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}},"next":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}},"last":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}}}},"_embedded":{"type":"object","required":["wallets"],"properties":{"wallets":{"type":"array","items":{"type":"object","description":"A list of wallets","required":["name","product_name","balance","account_id","created_at","updated_at","_links"],"properties":{"name":{"type":"string","description":"Wallet name","minLength":1,"maxLength":255},"product_name":{"type":"string","description":"Wallet's product name","minLength":1,"maxLength":255},"balance":{"type":"number","format":"float","description":"Wallet balance in credits. Credits represents x10000 the real currency value."},"account_id":{"type":"string","description":"Talkdesk Account ID"},"created_at":{"type":"string","format":"date-time","description":"Wallet creation datetime"},"updated_at":{"type":"string","format":"date-time","description":"Wallet update datetime"},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","description":"Link to the current Location of the resource","required":["href"],"properties":{"href":{"type":"string","description":"The hypertext reference describing this link."}}}}}}}}}}}},"example":{"total":10,"count":10,"page":1,"per_page":2,"_links":{"self":{"href":"https://api-docs.talkdesk.org/account/wallets?page=2&per_page=2"},"first":{"href":"https://api-docs.talkdesk.org/account/wallets?page=1&per_page=2"},"prev":{"href":"https://api-docs.talkdesk.org/account/wallets?page=1&per_page=2"},"next":{"href":"https://api-docs.talkdesk.org/account/wallets?page=3&per_page=2"},"last":{"href":"https://api-docs.talkdesk.org/account/wallets?page=5&per_page=2"}},"_embedded":{"wallets":[{"name":"saas_licenses","product_name":"SaaS Consumption-Licensing","balance":-2000,"account_id":"5baca11092c7c500069c0938","created_at":"2020-03-14T07:13:00.000Z","updated_at":"2020-03-14T08:13:00.000Z","_links":{"self":{"href":"https://api-docs.talkdesk.org/account/wallets/saas_licence"}}},{"name":"telco","product_name":"Telco Usage License","balance":3000,"account_id":"5baca11092c7c500069c0938","created_at":"2020-03-14T07:13:00.000Z","updated_at":"2020-03-14T08:13:00.000Z","_links":{"self":{"href":"https://api-docs.talkdesk.org/account/wallets/telco"}}}]}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1840000","message":"Invalid data"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1840404","message":"Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1840403","message":"Forbidden"}}}}}}},"/account/wallets/{name}":{"get":{"description":"Get single account wallet","security":[{"GA":["account-wallets:read"]}],"tags":["Usage Manager"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","maxLength":255},"description":"Wallet name"}],"responses":{"200":{"description":"Account wallet","content":{"application/json":{"schema":{"type":"object","required":["name","product_name","balance","account_id","created_at","updated_at","_links"],"properties":{"name":{"type":"string","description":"Wallet name","minLength":1,"maxLength":255},"product_name":{"type":"string","description":"Wallet's product name","minLength":1,"maxLength":255},"balance":{"type":"number","format":"float","description":"Wallet balance in credits. Credits represents x10000 the real currency value."},"account_id":{"type":"string","description":"Talkdesk Account ID"},"created_at":{"type":"string","format":"date-time","description":"Wallet creation datetime"},"updated_at":{"type":"string","format":"date-time","description":"Wallet update datetime"},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","description":"Link to the current Location of the resource","required":["href"],"properties":{"href":{"type":"string","description":"The hypertext reference describing this link."}}}}}}},"example":{"name":"saas_licenses","product_name":"SaaS Consumption-Licensing","balance":-2000,"account_id":"5baca11092c7c500069c0938","created_at":"2020-03-14T07:13:00.000Z","updated_at":"2020-03-14T08:13:00.000Z","_links":{"self":{"href":"https://api-docs.talkdesk.org/account/wallets/saas_licence"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1840404","message":"Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1840403","message":"Forbidden"}}}},"404":{"description":"Account wallet not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1840402","message":"Account wallet not found"}}}}}}},"/account/bucket-configurations":{"get":{"description":"Get all bucket configurations.","summary":"Get all bucket configurations of an account.","security":[{"GA":["bucket-configurations:read"]}],"tags":["Usage Manager"],"parameters":[{"in":"query","name":"page","description":"Desired page. Defaults to 1.","required":false,"schema":{"type":"integer","default":1,"minimum":1}},{"in":"query","name":"per_page","description":"Limit the number of bucket configurations per page. Defaults to 5.","required":false,"schema":{"type":"integer","minimum":1,"maximum":10,"default":5}},{"in":"query","name":"status","description":"It allows filtering configurations based on the current status. Options: * ACTIVE - Matches configurations that are currently active. It has effective_start < now > effective_end and it is the last configuration of a specific charge_number; * ALL - Matches all configurations.\n","required":false,"schema":{"type":"string","default":"ACTIVE","enum":["ACTIVE","ALL"],"minLength":0}}],"responses":{"200":{"description":"Get the bucket configurations details","content":{"application/json":{"schema":{"type":"object","required":["page","per_page","count","total","_links","_embedded"],"properties":{"page":{"type":"integer","description":"The current page"},"per_page":{"type":"integer","description":"The number of elements of bucket configurations per page"},"count":{"type":"integer","description":"The number of bucket configurations present on the current page"},"total":{"type":"integer","description":"The total number of bucket configurations"},"_links":{"type":"object","required":["self"],"properties":{"self":{"description":"The link to the current page","type":"object","required":["href"],"properties":{"href":{"description":"The hypertext reference describing this link","type":"string"}}},"first":{"description":"The link to the first page","type":"object","required":["href"],"properties":{"href":{"description":"The hypertext reference describing this link","type":"string"}}},"prev":{"description":"The link to the previous page","type":"object","required":["href"],"properties":{"href":{"description":"The hypertext reference describing this link","type":"string"}}},"next":{"description":"The link to the next page","type":"object","required":["href"],"properties":{"href":{"description":"The hypertext reference describing this link","type":"string"}}},"last":{"description":"The link to the last page","type":"object","required":["href"],"properties":{"href":{"description":"The hypertext reference describing this link","type":"string"}}}}},"_embedded":{"type":"object","required":["bucket_configurations"],"properties":{"bucket_configurations":{"type":"array","description":"the results displayed in an array","items":{"type":"object","required":["id","charge_number","plafond","plafond_multiplier","effective_start","effective_end","resource","unit_of_measure","properties","status","type","created_at"],"properties":{"id":{"type":"string","description":"Bucket Configuration unique ID"},"account_id":{"type":"string","description":"Talkdesk Account ID"},"charge_number":{"type":"string","description":"Charge number"},"plafond":{"type":"number","format":"float","description":"Plafond quantity"},"plafond_multiplier":{"type":"number","format":"float","description":"Plafond multiplication factor"},"effective_start":{"type":"string","format":"date-time","description":"Bucket configuration effective start date"},"effective_end":{"type":"string","format":"date-time","description":"Bucket configuration effective end date"},"resource":{"type":"string","description":"Resource of bucket configuration"},"unit_of_measure":{"type":"string","description":"Bucket configuration unit of measure","enum":["UNITS","MINUTES","SECONDS","GB","MB","TRANSCRIPTIONS","SEGMENTS","REQUESTS","NUMBERS","PAGES","SESSIONS","CHARS"]},"properties":{"type":"object","description":"Interaction properties"},"status":{"type":"string","description":"Bucket configuration status","enum":["ACTIVE","TERMINATED","UPCOMING"]},"type":{"type":"string","description":"Type of the bucket","enum":["FREE_UNITS","TIER"]},"tier":{"type":"string","description":"Tier of the bucket. Only present if bucket is of type TIER."},"created_at":{"type":"string","format":"date-time","description":"Bucket configuration date of creation"}}}}}}}},"example":{"page":3,"per_page":5,"count":5,"total":35,"_links":{"self":{"href":"https://api-docs.talkdesk.org/account/bucket-configurations?page=3&per_page=3&active=ACTIVE"},"first":{"href":"https://api-docs.talkdesk.org/account/bucket-configurations?page=1&per_page=3&active=ACTIVE"},"prev":{"href":"https://api-docs.talkdesk.org/account/bucket-configurations?page=2&per_page=3&active=ACTIVE"},"next":{"href":"https://api-docs.talkdesk.org/account/bucket-configurations?page=4&per_page=3&active=ACTIVE"},"last":{"href":"https://api-docs.talkdesk.org/account/bucket-configurations?page=6&per_page=3&active=ACTIVE"}},"_embedded":{"bucket_configurations":[{"id":"2a58b423-f9c2-492a-b411-2f5345c01ef5","charge_number":"CN-001","plafond":100,"plafond_multiplier":1,"effective_start":"2021-01-01T07:13:00.000Z","effective_end":"2021-12-31T08:13:00.000Z","resource":"CALL","unit_of_measure":"MINUTES","properties":{"type":"byoc"},"status":"ACTIVE","type":"FREE_UNITS","created_at":"2021-01-01T06:00:00.000Z"}]}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1840000","message":"Invalid data"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1840404","message":"Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1840403","message":"Forbidden"}}}}}}},"/apps":{"get":{"description":"Get the list of apps","security":[{"GA":["apps:read"]}],"tags":["Apps"],"responses":{"200":{"description":"The list of apps","content":{"application/json":{"schema":{"example":{"_embedded":{"apps":[{"id":"b1ab346a-0270-4570-8c60-3333bf5e1611","app_type":"atlas","name":"apply","display_name":"App.ly","slug":"apply","description":"Lorem Ipsum","listing_summary":"Demo App for Talkdesk Marketplace","render":"portal","emails":[{"type":"support","email":"support@example.com"},{"type":"developer","email":"developer@example.com"},{"type":"sales","email":"sales@example.com"}],"assets":[{"type":"icon","url":"https://application.example.com/icon.jpg"}],"urls":[{"type":"redirect_uri","url":"https://application.example.com/talkdesk/sso/callback"},{"type":"installation_subscription","url":"https://application.example.com/talkdesk/webhooks/callback"}],"subscription_types":[{"type":"trial","license_type":"individual","name":"Free Trial","description":"Simply sign up and enjoy all the capabilities we have to offer for a full one month","listing_summary":"App trial","price":0,"min_licenses":0,"max_licenses":200,"created_by":"Talkdesk, Inc"}],"scopes":["apps:read","apps:write","reports:read","reports:write"],"capabilitities":[{"name":"auth","protocols":"authorization"}],"_links":{"self":{"href":"https://api-docs.talkdesk.org/apps/{app_id}"}}}]},"total":2,"page":1,"per_page":1,"_links":{"self":{"href":"https://api-docs.talkdesk.org/apps?page=1&per_page=1"},"next":{"href":"https://api-docs.talkdesk.org/apps?page=2&per_page=1"}}},"type":"object","properties":{"_embedded":{"type":"object","properties":{"apps":{"type":"object","properties":{"id":{"type":"string","description":"the ID of a specific app installation for an account"},"app_type":{"type":"string","description":"a name to identify the app type","enum":["standalone","atlas"]},"name":{"type":"string","description":"a unique name identifier for the application"},"display_name":{"type":"string","description":"a friendly, human-readable name of the app"},"slug":{"type":"string","description":"a friendly identifier of the app used as a part of the app url"},"listing_summary":{"type":"string","description":"a summary description just for the listing"},"description":{"type":"string","description":"a description of the apps main features"},"notes":{"type":"string","description":"any additional note"},"version_number":{"type":"string","description":"the app current version"},"render":{"type":"string","description":"a name to identify where the app should be rendered","enum":["portal","canvas"]},"created_type":{"type":"string","description":"company name that created the app"},"sandbox":{"type":"boolean","description":"identifier of whether it is a testing environment or not"},"scopes_reason":{"type":"string","description":"reason why the app needs additional scopes"},"emails":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"email":{"type":"string"}}},"description":"an array of emails that should be used for notifications regarding the app"},"assets":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["screenshot","video","icon"]},"description":{"type":"string"},"url":{"type":"string"}}}},"urls":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["redirect_uri","installation_subscription","launch_url","privacy_policy","terms_of_service","app_source"]},"url":{"type":"string"}}}},"subscription_types":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["trial","paid"]},"license_type":{"type":"string","enum":["individual","universal"]},"name":{"type":"string","description":"the name of the subscription"},"price":{"type":"integer","description":"the monthly cost per seat"},"description":{"type":"string"},"listing_summary":{"type":"string"},"min_licenses":{"type":"integer"},"max_licenses":{"type":"integer"},"created_by":{"type":"string"}}}},"scopes":{"type":"array","items":{"type":"string","enum":["openid","refresh_token","apps:read","apps:write","reports:read","reports:write","events:read","account:read","users:read","recordings:read","interaction-triggers:read"]}},"capabilities":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"}}},"description":"list of capabilities the app will need to use"},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","default":"https://api-docs.talkdesk.org/apps/{app_id}"}}}}}}}}},"total":{"type":"integer"},"page":{"type":"integer"},"per_page":{"type":"integer"},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","default":"https://api-docs.talkdesk.org/apps"}}},"next":{"type":"object","properties":{"href":{"type":"string","default":"https://api-docs.talkdesk.org/apps?page=2&per_page=1"}}}}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0017000","message":"Unauthorized"}}}}}},"post":{"description":"Submit app","security":[{"GA":["apps:write"]}],"tags":["Apps"],"parameters":[],"responses":{"201":{"description":"The id of the created app","content":{"application/json":{"schema":{"example":{"id":"asd995b1256a8a4568b35e788193599d7"},"type":"object","properties":{"id":{"type":"string","description":"the ID of the created app"}}}}}},"400":{"description":"Invalid manifest","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0030103","message":"The app manifest is invalid","fields":[{"name":"field_a","description":"name missing"},{"name":"field_b","description":"render invalid type"},{"name":"field_c","description":"non-https urls"}]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0017000","message":"Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0030009","message":"Forbidden"}}}}},"requestBody":{"description":"The new app information","required":true,"content":{"application/json":{"schema":{"example":{"name":"Conversation App","display_name":"Conversation App","slug":"conversation","app_type":"atlas","created_by":"Talkdesk, Inc","render":"canvas","urls":[{"type":"standalone","description":"Standalone URL","url":"https://${account_name}.gettalkdesk.com/atlas/apps/conversation","templated":true},{"type":"app_source","description":"App source URL","url":"https://stg-cdn-talkdesk.talkdeskdev.com/conversation-app/latest/index.html"}],"sandbox":true,"capabilities":[{"name":"auth","protocols":"authorization"}],"scopes":["apps:read","apps:write","callbar","reports:write"],"scopes_reason":"In order to use Conversation app, those rights are needed to read information about account...","emails":[{"type":"support","email":"support@example.com"},{"type":"sales","email":"sales@example.com"}],"assets":[{"type":"icon","description":"icon description","url":"https://application.example.com/icon.jpg"}],"description":"Conversation App description","notes":"Some kind of relevant note","listing_summary":"Summary of the description","version_number":"1.0","subscription_types":[{"type":"trial","license_type":"individual","name":"Free Trial","description":"Simply sign up and enjoy all the capabilities we have to offer for a full one month","listing_summary":"App trial","price":0,"min_licenses":0,"max_licenses":200,"created_by":"Talkdesk, Inc"}]},"type":"object","properties":{"_embedded":{"type":"object","properties":{"apps":{"type":"object","properties":{"id":{"type":"string","description":"the ID of a specific app installation for an account"},"app_type":{"type":"string","description":"a name to identify the app type","enum":["standalone","atlas"]},"name":{"type":"string","description":"a unique name identifier for the application"},"display_name":{"type":"string","description":"a friendly, human-readable name of the app"},"slug":{"type":"string","description":"a friendly identifier of the app used as a part of the app url"},"listing_summary":{"type":"string","description":"a summary description just for the listing"},"description":{"type":"string","description":"a description of the apps main features"},"notes":{"type":"string","description":"any additional note"},"version_number":{"type":"string","description":"the app current version"},"render":{"type":"string","description":"a name to identify where the app should be rendered","enum":["portal","canvas"]},"created_type":{"type":"string","description":"company name that created the app"},"sandbox":{"type":"boolean","description":"identifier of whether it is a testing environment or not"},"scopes_reason":{"type":"string","description":"reason why the app needs additional scopes"},"emails":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"email":{"type":"string"}}},"description":"an array of emails that should be used for notifications regarding the app"},"assets":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["screenshot","video","icon"]},"description":{"type":"string"},"url":{"type":"string"}}}},"urls":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["redirect_uri","installation_subscription","launch_url","privacy_policy","terms_of_service","app_source"]},"url":{"type":"string"}}}},"subscription_types":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["trial","paid"]},"license_type":{"type":"string","enum":["individual","universal"]},"name":{"type":"string","description":"the name of the subscription"},"price":{"type":"integer","description":"the monthly cost per seat"},"description":{"type":"string"},"listing_summary":{"type":"string"},"min_licenses":{"type":"integer"},"max_licenses":{"type":"integer"},"created_by":{"type":"string"}}}},"scopes":{"type":"array","items":{"type":"string","enum":["openid","refresh_token","apps:read","apps:write","reports:read","reports:write","events:read","account:read","users:read","recordings:read","interaction-triggers:read"]}},"capabilities":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"}}},"description":"list of capabilities the app will need to use"},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","default":"https://api-docs.talkdesk.org/apps/{app_id}"}}}}}}}}},"total":{"type":"integer"},"page":{"type":"integer"},"per_page":{"type":"integer"},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","default":"https://api-docs.talkdesk.org/apps"}}},"next":{"type":"object","properties":{"href":{"type":"string","default":"https://api-docs.talkdesk.org/apps?page=2&per_page=1"}}}}}}}}}}}},"/apps/{app_id}":{"get":{"description":"Get information about an app","security":[{"GA":["apps:read"]}],"parameters":[{"name":"app_id","in":"path","description":"The app id provided in the app registration step","required":true,"schema":{"type":"string"}}],"tags":["Apps"],"responses":{"200":{"description":"The app information","content":{"application/json":{"schema":{"example":{"id":"b1ab346a-0270-4570-8c60-3333bf5e1611","app_type":"atlas","name":"apply","display_name":"App.ly","slug":"apply","description":"Lorem Ipsum","listing_summary":"Demo App for Talkdesk Marketplace","render":"portal","emails":[{"type":"support","email":"support@example.com"},{"type":"developer","email":"developer@example.com"},{"type":"sales","email":"sales@example.com"}],"assets":[{"type":"icon","url":"https://application.example.com/icon.jpg"}],"urls":[{"type":"redirect_uri","url":"https://application.example.com/talkdesk/sso/callback"},{"type":"installation_subscription","url":"https://application.example.com/talkdesk/webhooks/callback"}],"subscription_types":[{"type":"trial","license_type":"individual","name":"Free Trial","description":"Simply sign up and enjoy all the capabilities we have to offer for a full one month","listing_summary":"App trial","price":0,"min_licenses":0,"max_licenses":200,"created_by":"Talkdesk, Inc"}],"scopes":["apps:read","apps:write","reports:read","reports:write"],"capabilitities":[{"name":"auth","protocols":"authorization"}],"_links":{"self":{"href":"https://api-docs.talkdesk.org/apps/{app_id}"}}},"type":"object","properties":{"id":{"type":"string","description":"the ID of a specific app installation for an account"},"app_type":{"type":"string","description":"a name to identify the app type","enum":["standalone","atlas"]},"name":{"type":"string","description":"a unique name identifier for the application"},"display_name":{"type":"string","description":"a friendly, human-readable name of the app"},"slug":{"type":"string","description":"a friendly identifier of the app used as a part of the app url"},"listing_summary":{"type":"string","description":"a summary description just for the listing"},"description":{"type":"string","description":"a description of the apps main features"},"notes":{"type":"string","description":"any additional note"},"version_number":{"type":"string","description":"the app current version"},"render":{"type":"string","description":"a name to identify where the app should be rendered","enum":["portal","canvas"]},"created_type":{"type":"string","description":"company name that created the app"},"sandbox":{"type":"boolean","description":"identifier of whether it is a testing environment or not"},"scopes_reason":{"type":"string","description":"reason why the app needs additional scopes"},"emails":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"email":{"type":"string"}}},"description":"an array of emails that should be used for notifications regarding the app"},"assets":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["screenshot","video","icon"]},"description":{"type":"string"},"url":{"type":"string"}}}},"urls":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["redirect_uri","installation_subscription","launch_url","privacy_policy","terms_of_service","app_source"]},"url":{"type":"string"}}}},"subscription_types":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["trial","paid"]},"license_type":{"type":"string","enum":["individual","universal"]},"name":{"type":"string","description":"the name of the subscription"},"price":{"type":"integer","description":"the monthly cost per seat"},"description":{"type":"string"},"listing_summary":{"type":"string"},"min_licenses":{"type":"integer"},"max_licenses":{"type":"integer"},"created_by":{"type":"string"}}}},"scopes":{"type":"array","items":{"type":"string","enum":["openid","refresh_token","apps:read","apps:write","reports:read","reports:write","events:read","account:read","users:read","recordings:read","interaction-triggers:read"]}},"capabilities":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"}}},"description":"list of capabilities the app will need to use"},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","default":"https://api-docs.talkdesk.org/apps/{app_id}"}}}}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0017000","message":"Unauthorized"}}}},"404":{"description":"App not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0030100","message":"App not found"}}}}}},"patch":{"description":"Partially updates the app info","security":[{"GA":["apps:write"]}],"tags":["Apps"],"parameters":[{"name":"app_id","in":"path","description":"The app id provided in the app registration step","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The app with the updated fields","content":{"application/json":{"schema":{"example":{"name":"Updated name","display_name":"Conversation App","slug":"conversation","app_type":"atlas","created_by":"Talkdesk, Inc","render":"portal","urls":[{"type":"standalone","description":"Standalone URL","url":"https://${account_name}.gettalkdesk.com/atlas/apps/conversation","templated":true},{"type":"app_source","description":"App source URL","url":"https://stg-cdn-talkdesk.talkdeskdev.com/conversation-app/latest/index.html"}],"sandbox":true,"capabilitities":[{"name":"auth","protocols":"authorization"}],"scopes":["apps:read","apps:write","callbar","reports:write"],"scopes_reason":"In order to use Conversation app, those rights are needed to read information about account...","emails":[{"type":"support","email":"support@example.com"},{"type":"sales","email":"sales@example.com"}],"assets":[{"type":"icon","url":"https://application.example.com/icon.jpg"}],"description":"Conversation App description","notes":"Some kind of relevant note","listing_summary":"Summary of the description","version_number":"1.0","subscription_types":[{"type":"trial","license_type":"individual","name":"Free Trial","description":"Simply sign up and enjoy all the capabilities we have to offer for a full one month","listing_summary":"App trial","price":0,"min_licenses":0,"max_licenses":200,"created_by":"Talkdesk, Inc"}]},"type":"object","properties":{"_embedded":{"type":"object","properties":{"apps":{"type":"object","properties":{"id":{"type":"string","description":"the ID of a specific app installation for an account"},"app_type":{"type":"string","description":"a name to identify the app type","enum":["standalone","atlas"]},"name":{"type":"string","description":"a unique name identifier for the application"},"display_name":{"type":"string","description":"a friendly, human-readable name of the app"},"slug":{"type":"string","description":"a friendly identifier of the app used as a part of the app url"},"listing_summary":{"type":"string","description":"a summary description just for the listing"},"description":{"type":"string","description":"a description of the apps main features"},"notes":{"type":"string","description":"any additional note"},"version_number":{"type":"string","description":"the app current version"},"render":{"type":"string","description":"a name to identify where the app should be rendered","enum":["portal","canvas"]},"created_type":{"type":"string","description":"company name that created the app"},"sandbox":{"type":"boolean","description":"identifier of whether it is a testing environment or not"},"scopes_reason":{"type":"string","description":"reason why the app needs additional scopes"},"emails":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"email":{"type":"string"}}},"description":"an array of emails that should be used for notifications regarding the app"},"assets":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["screenshot","video","icon"]},"description":{"type":"string"},"url":{"type":"string"}}}},"urls":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["redirect_uri","installation_subscription","launch_url","privacy_policy","terms_of_service","app_source"]},"url":{"type":"string"}}}},"subscription_types":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["trial","paid"]},"license_type":{"type":"string","enum":["individual","universal"]},"name":{"type":"string","description":"the name of the subscription"},"price":{"type":"integer","description":"the monthly cost per seat"},"description":{"type":"string"},"listing_summary":{"type":"string"},"min_licenses":{"type":"integer"},"max_licenses":{"type":"integer"},"created_by":{"type":"string"}}}},"scopes":{"type":"array","items":{"type":"string","enum":["openid","refresh_token","apps:read","apps:write","reports:read","reports:write","events:read","account:read","users:read","recordings:read","interaction-triggers:read"]}},"capabilities":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"}}},"description":"list of capabilities the app will need to use"},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","default":"https://api-docs.talkdesk.org/apps/{app_id}"}}}}}}}}},"total":{"type":"integer"},"page":{"type":"integer"},"per_page":{"type":"integer"},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","default":"https://api-docs.talkdesk.org/apps"}}},"next":{"type":"object","properties":{"href":{"type":"string","default":"https://api-docs.talkdesk.org/apps?page=2&per_page=1"}}}}}}}}}},"400":{"description":"Update failure","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0030111","message":"Failed to update app","fields":[{"name":"field_name","description":"not allowed to be updated"}]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0017000","message":"Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0030009","message":"Forbidden"}}}},"404":{"description":"App not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0030100","message":"App not found"}}}}},"requestBody":{"description":"The information to be updated","required":true,"content":{"application/json":{"schema":{"example":{"name":"Updated name","render":"portal"},"type":"object","properties":{"name":{"type":"string"},"active":{"type":"boolean"},"description":{"type":"string"},"sandbox":{"type":"boolean"},"assets":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["screenshot","video","icon"]},"url":{"type":"string"},"description":{"type":"string"}}}},"slug":{"type":"string"},"capabilities":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"}}}},"urls":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["redirect_uri","installation_subscription","launch_url","privacy_policy","terms_of_service","app_source"]},"url":{"type":"string"}}}},"render":{"type":"string"}}}}}}}},"/apps/{app_id}/installations/{id}":{"get":{"description":"Get information about installation","security":[{"GA":["apps:read"]}],"parameters":[{"name":"app_id","in":"path","description":"The app id provided in the app registration step","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"The installation id for a specific account","required":true,"schema":{"type":"string"}}],"tags":["Apps"],"responses":{"200":{"description":"The successful installation information","content":{"application/json":{"schema":{"example":{"id":"9514148a-170c-4d4a-aa34-4a540cec08c5","app_id":"b1ab346a-0270-4570-8c60-3333bf5e1611","account_id":"052c3763-ee07-45c6-8a1f-65f25b0bf273","scopes":["apps:read","apps:write","reports:read","reports:write"],"auto_provision_filters":[{"filter":"role_id","match":"5b34eb0cdcba1b000bdbd320"}],"total_licenses":20,"created_at":"2016-06-14T16:23:07Z","created_by":"470dff254054076fc7c78a33","_embedded":{"state":{"state":"approve","reason":"Approving app installation","updated_at":"2016-06-14T16:23:07Z","_links":{"self":{"href":"http://api-docs.talkdesk.org/apps/{app_id}/installations/{installation_id}/state"}}}},"_links":{"self":{"href":"https://api-docs.talkdesk.org/apps/{app_id}/installations/{installation_id}"},"account":{"href":"https://api-docs.talkdesk.org/account"},"users":{"href":"https://api-docs.talkdesk.org/apps/{app_id}/installations/{installation_id}/users"},"subscription":{"href":"https://api-docs.talkdesk.org/apps/{app_id}/installations/{installation_id}/subscription"},"auto_provision_filters":{"href":"https://api-docs.talkdesk.org/apps/{app_id}/installations/{installation_id}/auto-provision-filters"}}},"type":"object","properties":{"id":{"type":"string","description":"The installation id"},"app_id":{"type":"string","description":"The application id for the given installation"},"account_id":{"type":"string","description":"The account id for which the app is installed"},"scopes":{"type":"array","items":{"type":"string"},"description":"List of scopes that the admin configuring the app has given access to"},"auto_provision_filters":{"type":"array","items":{"type":"object","properties":{"filter":{"type":"string","description":"The property to which the filter should be applied to (all, role, role_id, none)"},"match":{"type":"string","description":"The value used by the filter to find matches"}}},"description":"List of filters used for auto-provisioning"},"created_at":{"type":"string","format":"date-time","description":"Date of installation"},"_embedded":{"type":"object","properties":{"created_by":{"type":"object","properties":{"id":{"type":"string","description":"the Id of the user"},"email":{"type":"string","description":"the e-mail of the user"},"name":{"type":"string","description":"the name of the user"},"active":{"type":"boolean","description":"the activation state of the user"},"gender":{"type":"string","description":"the gender of the user"},"extension":{"type":"integer","description":"the phone extension for the user"},"external_phone_number":{"type":"string","description":"the external phone number for the user"},"created_at":{"type":"string","format":"date-time","description":"the date for the creation of the user"},"_links":{"type":"object","description":"the defined links","properties":{"self":{"type":"object","description":"the URI of the details of the user","properties":{"href":{"type":"string","default":"http://api-docs.talkdesk.org/users/:id"}}}}}}},"state":{"type":"object","properties":{"state":{"type":"string","description":"the current state of the installation","enum":["approve","reject"]},"reason":{"type":"string","description":"a reason associated with the state change"},"updated_at":{"type":"string","format":"date-time","description":"date of latest change to the installation"},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","default":"http://api-docs.talkdesk.org/apps/{app_id}/installations/{installation_id}/state"}}}}}}}}},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","default":"https://api-docs.talkdesk.org/apps/{app_id}/installations/{installation_id}"}}},"account":{"type":"object","properties":{"href":{"type":"string","default":"http://api-docs.talkdesk.org/account"}}},"subscription":{"type":"object","properties":{"href":{"type":"string","default":"http://api-docs.talkdesk.org/apps/{app_id}/installations/{installation_id}/subscription"}}},"auto_provision_filters":{"type":"object","properties":{"href":{"type":"string","default":"http://api-docs.talkdesk.org/apps/{app_id}/installations/{installation_id}/auto-provision-filters"}}},"users":{"type":"object","properties":{"href":{"type":"string","default":"http://api-docs.talkdesk.org/apps/{app_id}/installations/{installation_id}/users"}}},"channels":{"type":"object","properties":{"href":{"type":"string","default":"http://api-docs.talkdesk.org/apps/{app_id}/installations/{installation_id}/channels"}}}}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0017000","message":"Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0030009","message":"Forbidden"}}}},"404":{"description":"App / Installation not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"App not found":{"value":{"code":"0030100","message":"App not found"}},"Installation not found":{"value":{"code":"0030200","message":"Installation {installation_id} not found for app {app_id}"}}}}}}}}},"/apps/{app_id}/installations/{id}/users":{"get":{"description":"Gets the users enabled for a given installation","security":[{"GA":["apps:read"]}],"parameters":[{"name":"app_id","in":"path","description":"The app id provided in the app registration step","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"The installation id for a specific account","required":true,"schema":{"type":"string"}}],"tags":["Apps"],"responses":{"200":{"description":"A paginated list of users of the account enabled for the app","content":{"application/json":{"schema":{"example":{"total":2,"page":1,"per_page":1,"_embdedded":{"users":[{"id":"5b34eb0cdcba1b000bdbd320","name":"Paulo Omni","email":"paulo@talkdesk.com","_links":{"self":{"href":"http://api-docs.talkdesk.org/users/{user_id}"}}}]},"_links":{"self":{"href":"https://api-docs.talkdesk.org/apps/{app_id}/installations/{installation_id}/users"},"next":{"href":"https://api-docs.talkdesk.org/apps/{app_id}/installations/{installation_id}/users?page=2&per_page=1"}}},"type":"object","properties":{"total":{"type":"integer"},"page":{"type":"integer"},"per_page":{"type":"integer"},"_embedded":{"type":"object","properties":{"users":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"the Id of the user"},"email":{"type":"string","description":"the e-mail of the user"},"name":{"type":"string","description":"the name of the user"},"active":{"type":"boolean","description":"the activation state of the user"},"gender":{"type":"string","description":"the gender of the user"},"extension":{"type":"integer","description":"the phone extension for the user"},"external_phone_number":{"type":"string","description":"the external phone number for the user"},"created_at":{"type":"string","format":"date-time","description":"the date for the creation of the user"},"_links":{"type":"object","description":"the defined links","properties":{"self":{"type":"object","description":"the URI of the details of the user","properties":{"href":{"type":"string","default":"http://api-docs.talkdesk.org/users/:id"}}}}}}}}}},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","default":"https://api-docs.talkdesk.org/apps/{app_id}/installations/{installation_id}/users"}}},"next":{"type":"object","properties":{"href":{"type":"string","default":"https://api-docs.talkdesk.org/apps/{app_id}/installations/{installation_id}/users?page=2&per_page=1"}}}}}}}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"The error message"}}}}}},"404":{"description":"App or Installation Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"The error message"}}}}}}}}},"/apps/{app_id}/installations/{id}/state":{"post":{"description":"set the state of the installation","security":[{"GA":["apps:write"]}],"parameters":[{"name":"app_id","in":"path","description":"The app id provided in the app registration step","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"The installation id for a specific account","required":true,"schema":{"type":"string"}}],"tags":["Apps"],"responses":{"200":{"description":"State of the app successfully changed","content":{"application/json":{"schema":{"example":{"state":"approve","reason":"Approving app installation","updated_at":"2016-06-14T16:23:07Z","_links":{"self":{"href":"http://api-docs.talkdesk.org/apps/{app_id}/installations/{installation_id}/state"}}},"type":"object","properties":{"state":{"type":"string","description":"the current state of the installation","enum":["approve","reject"]},"reason":{"type":"string","description":"a reason associated with the state change"},"updated_at":{"type":"string","format":"date-time","description":"date of latest change to the installation"},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","default":"http://api-docs.talkdesk.org/apps/{app_id}/installations/{installation_id}/state"}}}}}}}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"The error message"}}}}}},"404":{"description":"App or Installation Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"The error message"}}}}}}},"requestBody":{"description":"The body of the request","content":{"application/json":{"schema":{"properties":{"state":{"type":"string","description":"the current state of the installation","enum":["approve","reject"]},"reason":{"type":"string","description":"the reason associated with the state change"}}}}}}}},"/apps/{app_id}/installations/{id}/subscription":{"get":{"description":"get the current subscription of the installation","security":[{"GA":["apps:read"]}],"parameters":[{"name":"app_id","in":"path","description":"The app id provided in the app registration step","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"The installation id for a specific account","required":true,"schema":{"type":"string"}}],"tags":["Apps"],"responses":{"200":{"description":"Current account subscription for the app","content":{"application/json":{"schema":{"example":{"id":"3acb33d7-82e6-42c9-a149-0440ccf5e81b","type":"trial","name":"Free Trial","price":0,"min_licenses":0,"max_licenses":200,"total_licenses":1,"_links":{"self":{"href":"http://api-docs.talkdesk.org/apps/{app_id}/installations/{installation_id}/subscription"}}},"allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["trial","paid"]},"license_type":{"type":"string","enum":["individual","universal"]},"name":{"type":"string","description":"the name of the subscription"},"price":{"type":"integer","description":"the monthly cost per seat"},"description":{"type":"string"},"listing_summary":{"type":"string"},"min_licenses":{"type":"integer"},"max_licenses":{"type":"integer"},"created_by":{"type":"string"}}},{"properties":{"id":{"type":"string","description":"The ID of the subscription"},"type":{"type":"string","description":"The type of the subscription"},"name":{"type":"string","description":"The name of the subscription"},"price":{"type":"integer","description":"The price per seat"},"min_licenses":{"type":"integer","description":"The minimum number of licenses"},"max_licenses":{"type":"integer","description":"The maximum number of licenses"},"total_licenses":{"type":"integer","description":"Number of licenses purchased for the installation"},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","default":"http://api-docs.talkdesk.org/apps/{app_id}/installations/{installation_id}/subscription"}}}}}}}]}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"The error message"}}}}}},"404":{"description":"App or Installation Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"The error message"}}}}}}}}},"/apps/{app_id}/installations/{id}/channels":{"get":{"description":"list channels for the installation","security":[{"EarlyAccess":["apps:read"]}],"parameters":[{"name":"app_id","in":"path","description":"The app id provided in the app registration step","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"The installation id for a specific account","required":true,"schema":{"type":"string"}}],"tags":["Apps","Channels"],"responses":{"200":{"description":"List of channels provisioned for the app installation","content":{"application/json":{"schema":{"example":{"total":2,"page":1,"per_page":1,"_embdedded":{"channels":[{"type":"messages","_embedded":{"resource":{"id":"123","type":"number","_links":{"self":{"href":"http://api-docs.talkdesk.org/numbers/123"}}}},"_links":{"self":{"href":"http://api-docs.talkdesk.org/numbers/123/channels/messages"}}}]},"_links":{"self":{"href":"https://api-docs.talkdesk.org/apps/{app_id}/installations/{installation_id}/channels"}}},"type":"object","properties":{"total":{"type":"integer"},"page":{"type":"integer"},"per_page":{"type":"integer"},"_embedded":{"type":"object","properties":{"users":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"the type of channel","enum":["messages"]},"updated_at":{"type":"string","format":"date-time","description":"date of latest change to this channel"},"_embedded":{"type":"object","properties":{"resource":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"the id of the target resource"},"type":{"type":"string","description":"the target resource type (e.g. number)","enum":["number"]},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","default":"http://api-docs.talkdesk.org/numbers/{number_id}"}}}}}}}}}},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","default":"http://api-docs.talkdesk.org/numbers/{number_id}/channels/{type}"}}}}}}}}}},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","default":"https://api-docs.talkdesk.org/apps/{app_id}/installations/{installation_id}/channels"}}}}}}}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"The error message"}}}}}},"404":{"description":"App or Installation Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"The error message"}}}}}}}},"post":{"description":"activate channels for the installation","security":[{"EarlyAccess":["apps:write"]}],"parameters":[{"name":"app_id","in":"path","description":"The app id provided in the app registration step","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"The installation id for a specific account","required":true,"schema":{"type":"string"}}],"tags":["Apps","Channels"],"responses":{"201":{"description":"Channel provisioned for the app installation","content":{"application/json":{"schema":{"example":{"total":2,"page":1,"per_page":1,"_embdedded":{"channels":[{"type":"messages","_embedded":{"resource":{"id":"123","type":"number","_links":{"self":{"href":"http://api-docs.talkdesk.org/numbers/123"}}}},"_links":{"self":{"href":"http://api-docs.talkdesk.org/numbers/123/channels/messages"}}}]},"_links":{"self":{"href":"https://api-docs.talkdesk.org/apps/{app_id}/installations/{installation_id}/channels"}}},"type":"object","properties":{"total":{"type":"integer"},"page":{"type":"integer"},"per_page":{"type":"integer"},"_embedded":{"type":"object","properties":{"users":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"the type of channel","enum":["messages"]},"updated_at":{"type":"string","format":"date-time","description":"date of latest change to this channel"},"_embedded":{"type":"object","properties":{"resource":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"the id of the target resource"},"type":{"type":"string","description":"the target resource type (e.g. number)","enum":["number"]},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","default":"http://api-docs.talkdesk.org/numbers/{number_id}"}}}}}}}}}},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","default":"http://api-docs.talkdesk.org/numbers/{number_id}/channels/{type}"}}}}}}}}}},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","default":"https://api-docs.talkdesk.org/apps/{app_id}/installations/{installation_id}/channels"}}}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0030700","message":"The activation request could not be completed"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0030701","message":"The request is not authorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0030703","message":"The request is forbidden"}}}},"404":{"description":"App or Installation Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0030704","message":"The resource does not exist"}}}},"409":{"description":"Resource already in use","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0030709","message":"The resource is already in use by another channel"}}}}},"requestBody":{"description":"The body of the request","content":{"application/json":{"schema":{"properties":{"type":{"type":"string","description":"the type of channel","enum":["messages"]},"resource_type":{"type":"string","description":"the target resource type (e.g. number)","enum":["number"]},"resource":{"type":"string","description":"the resource to be provisioned for this channel"}}}}}}}},"/apps/{app_id}/installations/{id}/trial":{"get":{"description":"Gets the installation trial information","x-namespace":"/apps","security":[{"GA":["apps:read"]}],"parameters":[{"name":"app_id","in":"path","description":"The app id provided in the app registration step","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"The installation id for a specific account","required":true,"schema":{"type":"string"}}],"tags":["Apps"],"responses":{"200":{"description":"Information related to an installation trial state","content":{"application/json":{"schema":{"type":"object","properties":{"state":{"type":"string","description":"Trial current state"},"started_at":{"type":"string","format":"date-time","description":"Start date of installation trial"},"expires_at":{"type":"string","format":"date-time","description":"Expiration date of installation trial"},"ended_at":{"type":"string","format":"date-time","description":"Ended date of installation trial"},"ended_reason":{"type":"string","description":"Reason for the ending of trial"},"subscription_name":{"type":"string","description":"Name of the subscription type"},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","default":"https://api-docs.talkdesk.org/apps/{app_id}/installations/{installation_id}/trial"}}},"installation":{"type":"object","properties":{"href":{"type":"string","default":"https://api-docs.talkdesk.org/apps/{app_id}/installations/{installation_id}"}}}}}}},"example":{"state":"active","started_at":"2022-03-03T17:51:11.669+00:00","expires_at":"2022-04-02T17:51:11.669+00:00","ended_at":"2022-04-02T17:51:11.669+00:00","ended_reason":"Trial expired","subscription_name":"Free Trial","_links":{"self":{"href":"https://api-docs.talkdesk.org/apps/{app_id}/installations/{installation_id}/trial"},"installation":{"href":"https://api-docs.talkdesk.org/apps/{app_id}/installations/{installation_id}"}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0030002","message":"Invalid request data"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0030010","message":"Action is not authorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0030009","message":"Forbidden"}}}},"404":{"description":"Installation not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0030200","message":"Installation {installation_id} not found for app {app_id}"}}}}}}},"/apps/{app_id}/installations/{id}/credentials/actions/rotate":{"post":{"description":"rotates the installation's credentials","x-namespace":"/apps","security":[{"GA":["apps:write"]}],"parameters":[{"name":"app_id","in":"path","description":"The app id provided in the app registration step","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"The installation id for a specific account","required":true,"schema":{"type":"string"}}],"tags":["Apps"],"responses":{"201":{"description":"Requested credentials accepted"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0030010","message":"Action is not authorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0030009","message":"Forbidden"}}}},"404":{"description":"App / Installation not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"App not found":{"value":{"code":"0030100","message":"App not found"}},"Installation not found":{"value":{"code":"0030200","message":"Installation {installation_id} not found for app {app_id}"}}}}}}}}},"/apps/{app_id}/installations/{id}/credentials/{client_id}/state":{"post":{"description":"creates a transition to 'acknowledged' of the installation's credentials resource","x-namespace":"/apps","security":[{"GA":["apps:write"]}],"parameters":[{"name":"app_id","in":"path","description":"The app id provided in the app registration step","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"The installation id for a specific account","required":true,"schema":{"type":"string"}},{"name":"client_id","in":"path","description":"The installation client id that is being acknowledged","required":true,"schema":{"type":"string"}}],"tags":["Apps"],"requestBody":{"description":"The body of the request","content":{"application/json":{"schema":{"type":"object","properties":{"state":{"type":"object","pattern":"acknowledged","description":"the current state of the installation credentials"}}},"example":{"state":"acknowledged"}}}},"responses":{"202":{"description":"Requested state accepted","content":{"application/json":{"schema":{"type":"object","properties":{"state":{"type":"object","pattern":"acknowledged","description":"the current state of the installation credentials"},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","default":"http://api-docs.talkdesk.org/apps/{app_id}/installations/{id}/credentials/{client_id}/state"}}}}}}},"example":{"type":"object","properties":{"state":"acknowledged","_links":{"self":{"href":"http://api-docs.talkdesk.org/apps/{app_id}/installations/{id}/credentials/{client_id}/state"}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0030010","message":"Action is not authorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0030009","message":"Forbidden"}}}},"404":{"description":"App / Installation not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"App not found":{"value":{"code":"0030100","message":"App not found"}},"Installation not found":{"value":{"code":"0030200","message":"Installation {installation_id} not found for app {app_id}"}}}}}},"409":{"description":"Requested state conflicts with current state of the target resource","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0030227","message":"Invalid client state input"}}}}}}},"/attachments/2023-03":{"get":{"x-namespace":"/attachments","tags":["Attachments"],"summary":"List attachments","description":"Lists the current account's attachments","security":[{"EarlyAccess":["attachments:read"]}],"parameters":[{"name":"Authorization","in":"header","description":"A token for access the api","required":true,"schema":{"type":"string","minLength":7,"maximum":10240},"example":"Bearer 2pUwO0zU7PTlWXVHE6G1GDI3niEVML"},{"name":"name","in":"query","description":"Filter by attachment name","required":false,"schema":{"type":"string","minLength":1,"maxLength":512}},{"name":"types","in":"query","description":"Filter by attachment types","required":false,"schema":{"type":"string","items":{"type":"string","minLength":1,"maxLength":127}}},{"name":"metadata","in":"query","description":"Filter by attachment metadata(Requires URL encoding)","required":false,"schema":{"type":"string","minLength":1,"maxLength":127},"example":"metadata=%7B%22flow_id%22:%22m_o8E823YDto8rDzUP-oXf-11118%22%7D"},{"name":"state","in":"query","description":"Filter by attachment state","required":false,"schema":{"type":"string","minLength":1,"maxLength":127}},{"name":"page","in":"query","description":"Desired page","required":false,"schema":{"type":"integer","default":1,"minimum":1,"maximum":4611686018427388000}},{"name":"per_page","in":"query","description":"Limit the number of attachments per page","required":false,"schema":{"type":"integer","default":50,"minimum":1,"maximum":250}}],"responses":{"200":{"description":"Attachments list","content":{"application/hal+json":{"schema":{"type":"object","required":["total","page","per_page","_links"],"properties":{"total":{"type":"integer","description":"Total"},"page":{"type":"integer","description":"Page","default":1},"per_page":{"type":"integer","description":"The per page","default":20},"_embedded":{"type":"object","description":"The list of attachments","properties":{"list":{"type":"array","items":{"type":"object","allOf":[{"type":"object","required":["id","name","state"],"properties":{"id":{"type":"string","description":"The ID of the attachment"},"name":{"type":"string","description":"the attachment name"},"state":{"type":"string","description":"The current state of the attachment"},"size":{"type":"integer","description":"the attachment size"},"type":{"type":"string","description":"The attachment type"},"metadata":{"type":"object","additionalProperties":true,"description":"The meta data"},"provider":{"type":"object","additionalProperties":true,"description":"The provider info"},"_links":{"type":"object","description":"HAL API related links.","properties":{"self":{"type":"object","description":"Link to fetch the detail of the Asset","properties":{"href":{"type":"string","description":"Address of the resource","default":"https://xxxx.talkdesk.com/assets/{id}"}}},"download_link":{"type":"object","description":"Link used to generate a download link","properties":{"href":{"type":"string","description":"Download link generation address","default":"https://xxxx.talkdesk.com/assets/{id}/download-link"}}}}}}}],"required":["id"]}}}},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string"}}},"prev":{"type":"object","properties":{"href":{"type":"string"}}},"next":{"type":"object","properties":{"href":{"type":"string"}}}}}}},"example":{"total":1,"page":1,"per_page":10,"count":1,"_embedded":{"list":[{"id":"123e4567e89b12d3a456426655440010","name":"121233.jpg","state":"published","size":1024,"type":"image/jpeg","metadata":{"flow_id":"223e4567e89b12d3a456426655440011"},"provider":{"name":"aws","data":"aws-data"},"_links":{"self":{"href":"https://xxx.talkdesk.com/assets/123e4567e89b12d3a456426655440010"},"download_link":{"href":"https://xxxx.talkdesk.com/assets/123e4567e89b12d3a456426655440010/download-link"}}}]},"_links":{"self":{"href":"/attachments?page=2&per_page=10"},"prev":{"href":"/attachments?page=1&per_page=10"},"next":{"href":"/attachments?page=3&per_page=10"}}}}}},"400":{"description":"Invalid parameter value","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2320000","message":"Bad request error"}}}},"401":{"description":"Unauthorized access - invalid or unverifiable JWT","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2320001","message":"Authorization failed"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2320002","message":"Forbidden"}}}}}},"post":{"x-namespace":"/attachments","tags":["Attachments"],"summary":"Create Attachment","description":"Create a new attachment and return the newly created attachment resource","security":[{"EarlyAccess":["attachments:write"]}],"parameters":[{"name":"Authorization","in":"header","description":"A token for access the api","required":true,"schema":{"type":"string","minLength":7,"maximum":10240},"example":"Bearer 2pUwO0zU7PTlWXVHE6G1GDI3niEVML"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"the attachment name","minLength":1,"maxLength":64},"request_id":{"type":"string","description":"the attachment uploaded request id","minLength":1,"maxLength":64},"metadata":{"type":"object","description":"metadata values associated with this attachment and used for searching/categorization","additionalProperties":{"type":"string","minLength":1,"maxLength":127}}}},"example":{"name":"calm-down-song.mp3","request_id":"9821123e4567e89b12d3a456426655440011","metadata":{"flow_id":"ABCEDF0987654321","name":"1111.jpg","size":1143840,"type":"image/jpeg"}}}}},"responses":{"200":{"description":"The newly created attachment resource","content":{"application/hal+json":{"schema":{"type":"object","required":["id","name","state"],"properties":{"id":{"type":"string","description":"The ID of the attachment"},"name":{"type":"string","description":"the attachment name"},"state":{"type":"string","description":"The current state of the attachment"},"size":{"type":"integer","description":"the attachment size"},"type":{"type":"string","description":"The attachment type"},"metadata":{"type":"object","additionalProperties":true,"description":"The meta data"},"provider":{"type":"object","additionalProperties":true,"description":"The provider info"},"_links":{"type":"object","description":"HAL API related links.","properties":{"self":{"type":"object","description":"Link to fetch the detail of the Asset","properties":{"href":{"type":"string","description":"Address of the resource","default":"https://xxxx.talkdesk.com/assets/{id}"}}},"download_link":{"type":"object","description":"Link used to generate a download link","properties":{"href":{"type":"string","description":"Download link generation address","default":"https://xxxx.talkdesk.com/assets/{id}/download-link"}}}}}}},"example":{"id":"123e4567e89b12d3a456426655440010","name":"121233.jpg","state":"published","size":1024,"type":"image/jpeg","metadata":{"flow_id":"223e4567e89b12d3a456426655440011"},"provider":{"name":"aws","data":"aws-data"},"_links":{"self":{"href":"https://xxx.talkdesk.com/assets/123e4567e89b12d3a456426655440010"},"download_link":{"href":"https://xxxx.talkdesk.com/assets/123e4567e89b12d3a456426655440010/download-link"}}}}}},"400":{"description":"Validation constraint violation","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2320000","message":"Bad request error"}}}},"401":{"description":"Unauthorized access - invalid or unverifiable JWT","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2320001","message":"Authorization failed"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2320002","message":"Forbidden"}}}},"409":{"description":"Attachment naming conflict. Already has an attachment with this name","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2320004","message":"Attachments name exist"}}}}}}},"/attachments/2023-03/upload-link":{"post":{"x-namespace":"/attachments","tags":["Attachments"],"summary":"Request an attachment upload link generation.","description":"Start the attachment upload process by requesting an upload link generation.","security":[{"EarlyAccess":["attachments:request"]}],"parameters":[{"name":"Authorization","in":"header","description":"A token for access the api","required":true,"schema":{"type":"string","minLength":1,"maxLength":64},"example":"Bearer 2pUwO0zU7PTlWXVHE6G1GDI3niEVML"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"allowed_mime_types":{"type":"array","description":"The allowed MIME Types for this attachment","items":{"type":"string","description":"The allowed mime-type option"}}}},"example":{"allowed_mime_types":["audio/mp3","audio/wav"]}}}},"responses":{"200":{"description":"The newly generated upload link and request id","content":{"application/hal+json":{"schema":{"type":"object","required":["request_id","url"],"properties":{"request_id":{"type":"string","description":"ID that should be used as the request identifier (request_id) when creating the attachment"},"url":{"type":"string","description":"Upload link address"}}},"example":{"request_id":"1323567e89b12d3a343434545","url":"https://some.external.cdn.org/attachments/9821123e4567e89b12d3a456426655440010"}}}},"400":{"description":"Invalid validation constraints values","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2320000","message":"Bad request error"}}}},"401":{"description":"Unauthorized access - invalid or unverifiable JWT.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2320001","message":"Authorization failed"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2320002","message":"Forbidden"}}}}}}},"/attachments/2023-03/{id}":{"get":{"x-namespace":"/attachments","tags":["Attachments"],"summary":"Get Attachment","description":"Get an attachment by it's id","security":[{"EarlyAccess":["attachments:read"]}],"parameters":[{"name":"Authorization","in":"header","description":"A token for access the api","required":true,"schema":{"type":"string","minLength":7,"maximum":10240},"example":"Bearer 2pUwO0zU7PTlWXVHE6G1GDI3niEVML"},{"name":"id","in":"path","description":"the attachment idattachment_definition_response","required":true,"schema":{"type":"string","minLength":1,"maxLength":64}}],"responses":{"200":{"description":"Attachment details","content":{"application/hal+json":{"schema":{"type":"object","required":["id","name","state"],"properties":{"id":{"type":"string","description":"The ID of the attachment"},"name":{"type":"string","description":"the attachment name"},"state":{"type":"string","description":"The current state of the attachment"},"size":{"type":"integer","description":"the attachment size"},"type":{"type":"string","description":"The attachment type"},"metadata":{"type":"object","additionalProperties":true,"description":"The meta data"},"provider":{"type":"object","additionalProperties":true,"description":"The provider info"},"_links":{"type":"object","description":"HAL API related links.","properties":{"self":{"type":"object","description":"Link to fetch the detail of the Asset","properties":{"href":{"type":"string","description":"Address of the resource","default":"https://xxxx.talkdesk.com/assets/{id}"}}},"download_link":{"type":"object","description":"Link used to generate a download link","properties":{"href":{"type":"string","description":"Download link generation address","default":"https://xxxx.talkdesk.com/assets/{id}/download-link"}}}}}}},"example":{"id":"123e4567e89b12d3a456426655440010","name":"121233.jpg","state":"published","size":1024,"type":"image/jpeg","metadata":{"flow_id":"223e4567e89b12d3a456426655440011"},"provider":{"name":"aws","data":"aws-data"},"_links":{"self":{"href":"https://xxx.talkdesk.com/assets/123e4567e89b12d3a456426655440010"},"download_link":{"href":"https://xxxx.talkdesk.com/assets/123e4567e89b12d3a456426655440010/download-link"}}}}}},"401":{"description":"Unauthorized access - invalid or unverifiable JWT.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2320001","message":"Authorization failed"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2320002","message":"Forbidden"}}}},"404":{"description":"Attachment not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2320009","message":"Attachment do not exist"}}}}}},"delete":{"x-namespace":"/attachments","tags":["Attachments"],"summary":"Delete Attachment","description":"Delete an attachment by it's id","security":[{"EarlyAccess":["attachments:delete"]}],"parameters":[{"name":"Authorization","in":"header","description":"A token for access the api","required":true,"schema":{"type":"string","minLength":7,"maximum":10240},"example":"Bearer 2pUwO0zU7PTlWXVHE6G1GDI3niEVML"},{"name":"id","in":"path","description":"the attachment id","required":true,"schema":{"type":"string","minLength":1,"maxLength":64}}],"responses":{"204":{"description":"No content"},"401":{"description":"Unauthorized access - invalid or unverifiable JWT.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2320001","message":"Authorization failed"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2320002","message":"Forbidden"}}}},"404":{"description":"Attachment not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2320009","message":"Attachment do not exist"}}}}}}},"/attachments/2023-03/{id}/download-link":{"get":{"x-namespace":"/attachments","tags":["Attachments"],"summary":"Generate Download Link","description":"Generates a new link that grants temporary access (10 minutes) to the attachment's data.","security":[{"EarlyAccess":["attachments:download"]}],"parameters":[{"name":"Authorization","in":"header","description":"A token for access the api","required":true,"schema":{"type":"string","minLength":7,"maximum":10240},"example":"Bearer 2pUwO0zU7PTlWXVHE6G1GDI3niEVML"},{"name":"id","in":"path","description":"The attachment id","required":true,"schema":{"type":"string","minLength":1,"maxLength":64}}],"responses":{"200":{"description":"The newly generated attachment's download link","content":{"application/hal+json":{"schema":{"type":"object","required":["url","expire_time"],"properties":{"url":{"type":"string","description":"Address of the resource"},"expire_time":{"type":"integer","description":"Download link expiration time in seconds","default":600}}},"example":{"url":"https://some.external.cdn.org/attachments/9821123e4567e89b12d3a456426655440010","expire_time":600}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2320000","message":"Bad request error"}}}},"401":{"description":"Unauthorized access - invalid or unverifiable JWT","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2320001","message":"Authorization failed"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2320002","message":"Forbidden"}}}},"404":{"description":"Attachment not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2320009","message":"Attachment do not exist"}}}}}}},"/attributes":{"get":{"x-namespace":"/attributes","description":"Get the list of attributes","security":[{"GA":["attributes:read"]}],"summary":"Attributes list","tags":["Attributes"],"operationId":"GetAllAttributes","parameters":[{"in":"query","name":"active","description":"Whether to return active or inactive attributes. If not specified, returns both active and inactive attributes.","required":false,"schema":{"type":"boolean"}},{"in":"query","name":"name","description":"Filter by attribute 'name'.","required":false,"schema":{"type":"string"}},{"in":"query","name":"categories","description":"Filter attributes that belong to the attributes categories.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"in":"query","name":"proficiency","description":"Filter by proficiency type. Default behaviour does not filter the attributes.","required":false,"schema":{"type":"string"}},{"in":"query","name":"sort","description":"Sort by field. Allowed: 'name'. Default value is ascending. Use - for descending order.","required":false,"schema":{"type":"string","enum":["name","-name"],"minLength":4,"maxLength":5}},{"in":"query","name":"page","description":"Desired page. Defaults to 1.","required":false,"schema":{"type":"integer","default":1,"minimum":1,"maximum":10000000}},{"in":"query","name":"per_page","description":"Limit the number of attributes per page. Defaults to 50.","required":false,"schema":{"type":"integer","default":50,"minimum":1,"maximum":100}}],"responses":{"200":{"description":"Attributes list","content":{"application/json":{"schema":{"example":{"total":2,"count":1,"page":1,"per_page":1,"_embedded":{"attributes":[{"id":"123e4567-e89b-12d3-a456-426655440000","name":"Attribute 1","active":true,"category_id":"987e4567-jqw2-23b2-a456-122315440000","category_name":"Category 1","proficiency":"five_stars_scale","default_proficiency":60,"users_count":10,"flows_count":0,"_links":{"self":{"href":"http://api-docs.talkdesk.org/attributes/123e4567-e89b-12d3-a456-426655440000"},"attributes":{"href":"http://api-docs.talkdesk.org/attributes"}}}]},"_links":{"self":{"href":"http://api-docs.talkdesk.org/attributes"},"page":{"href":"http://api-docs.talkdesk.org/attributes?page=1"},"next":{"href":"http://api-docs.talkdesk.org/attributes?page=2"}}},"type":"object","properties":{"total":{"type":"integer"},"count":{"type":"integer"},"page":{"type":"integer"},"per_page":{"type":"integer"},"_embedded":{"type":"object","description":"The list of attributes","properties":{"attributes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The id of the attribute"},"name":{"type":"string","description":"The name of the attribute"},"active":{"type":"boolean","description":"Whether the attribute is active or inactive"},"category_id":{"type":"string","description":"The id of the attribute category"},"category_name":{"type":"string","description":"The name of the attribute category"},"proficiency":{"type":"string","description":"The type of proficiency","enum":["none","five_stars_scale"]},"default_proficiency":{"type":"integer","description":"The default value of the proficiency","minimum":0,"maximum":100},"users_count":{"type":"integer","description":"The count of users associated to the attribute"},"flows_count":{"type":"integer","description":"The count of flows using the attribute"},"_links":{"type":"object","description":"HAL API related links.","properties":{"self":{"type":"object","description":"Link to fetch the detail of the attribute","properties":{"href":{"type":"string","description":"Address of the resource","default":"http://api-docs.talkdesk.org/attributes/:id"}}},"attributes":{"type":"object","description":"Link to fetch the list of all attributes","properties":{"href":{"type":"string","description":"Address of the resource","default":"http://api-docs.talkdesk.org/attributes"}}}},"required":["self","attributes"]}},"required":["id","name","active","category_id","category_name","proficiency","default_proficiency","users_count","flows_count","_links"]}}},"required":["attributes"]},"_links":{"type":"object","description":"HAL API related links.","properties":{"self":{"type":"object","description":"Link to fetch a list of all the attributes","properties":{"href":{"type":"string","description":"Address of the resource","default":"http://api-docs.talkdesk.org/attributes"}}},"page":{"type":"object","properties":{"templated":{"type":"boolean"},"href":{"type":"string","default":"http://api-docs.talkdesk.org/attributes?page=1"}}},"next":{"type":"object","properties":{"templated":{"type":"boolean"},"href":{"type":"string","default":"http://api-docs.talkdesk.org/attributes?page=2"}}}}}},"required":["_embedded","_links"]}}}},"400":{"description":"Invalid parameter values submitted.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0360002","message":"Bad request."}}}},"401":{"description":"Missing or invalid 'Authorization' header.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0360000","message":"Missing or invalid 'Authorization' header."}}}},"403":{"description":"Insufficient permissions.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0360003","message":"Forbidden."}}}}}},"post":{"x-namespace":"/attributes","description":"Create a new attribute","security":[{"GA":["attributes:write"]}],"summary":"Create a new attribute","tags":["Attributes"],"operationId":"CreateAttribute","parameters":[],"responses":{"201":{"description":"The created Attribute.","content":{"application/json":{"schema":{"example":{"id":"123e4567-e89b-12d3-a456-426655440000","name":"Attribute 1","active":true,"category_id":"987e4567-jqw2-23b2-a456-122315440000","category_name":"Category 1","proficiency":"five_stars_scale","default_proficiency":60,"users_count":10,"flows_count":0,"_links":{"self":{"href":"http://api-docs.talkdesk.org/attributes/123e4567-e89b-12d3-a456-426655440000"},"attributes":{"href":"http://api-docs.talkdesk.org/attributes"}}},"type":"object","properties":{"id":{"type":"string","description":"The id of the attribute"},"name":{"type":"string","description":"The name of the attribute"},"active":{"type":"boolean","description":"Whether the attribute is active or inactive"},"category_id":{"type":"string","description":"The id of the attribute category"},"category_name":{"type":"string","description":"The name of the attribute category"},"proficiency":{"type":"string","description":"The type of proficiency","enum":["none","five_stars_scale"]},"default_proficiency":{"type":"integer","description":"The default value of the proficiency","minimum":0,"maximum":100},"users_count":{"type":"integer","description":"The count of users associated to the attribute"},"flows_count":{"type":"integer","description":"The count of flows using the attribute"},"_links":{"type":"object","description":"HAL API related links.","properties":{"self":{"type":"object","description":"Link to fetch the detail of the attribute","properties":{"href":{"type":"string","description":"Address of the resource","default":"http://api-docs.talkdesk.org/attributes/:id"}}},"attributes":{"type":"object","description":"Link to fetch the list of all attributes","properties":{"href":{"type":"string","description":"Address of the resource","default":"http://api-docs.talkdesk.org/attributes"}}}},"required":["self","attributes"]}},"required":["id","name","active","category_id","category_name","proficiency","default_proficiency","users_count","flows_count","_links"]}}}},"400":{"description":"Invalid parameter values submitted.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0360002","message":"Bad request."}}}},"401":{"description":"Missing or invalid 'Authorization' header.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0360000","message":"Missing or invalid 'Authorization' header."}}}},"403":{"description":"Insufficient permissions.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0360003","message":"Forbidden."}}}},"409":{"description":"Attribute creation conflict.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0360005","message":"Conflict."}}}}},"requestBody":{"description":"The body of the request","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The name of the attribute"},"category_id":{"type":"string","description":"The id of the attributes category"},"active":{"type":"boolean","description":"Boolean indicating if the attribute is active or not"},"proficiency":{"type":"string","description":"The type of proficiency","enum":["none","five_stars_scale"]},"default_proficiency":{"type":"integer","description":"Default value for proficiency","minimum":0,"maximum":100}},"required":["name","active","category_id","proficiency","default_proficiency"]}}}}}},"/attributes/{attribute_id}":{"get":{"x-namespace":"/attributes","description":"Get the details of an attribute","security":[{"GA":["attributes:read"]}],"summary":"Attribute details","operationId":"GetAttribute","parameters":[{"in":"path","name":"attribute_id","description":"The identifier of the attribute.","required":true,"schema":{"type":"string"}}],"tags":["Attributes"],"responses":{"200":{"description":"The Attribute details.","content":{"application/json":{"schema":{"example":{"id":"123e4567-e89b-12d3-a456-426655440000","name":"Attribute 1","active":true,"category_id":"987e4567-jqw2-23b2-a456-122315440000","category_name":"Category 1","proficiency":"five_stars_scale","default_proficiency":60,"users_count":10,"flows_count":0,"_links":{"self":{"href":"http://api-docs.talkdesk.org/attributes/123e4567-e89b-12d3-a456-426655440000"},"attributes":{"href":"http://api-docs.talkdesk.org/attributes"}}},"type":"object","properties":{"id":{"type":"string","description":"The id of the attribute"},"name":{"type":"string","description":"The name of the attribute"},"active":{"type":"boolean","description":"Whether the attribute is active or inactive"},"category_id":{"type":"string","description":"The id of the attribute category"},"category_name":{"type":"string","description":"The name of the attribute category"},"proficiency":{"type":"string","description":"The type of proficiency","enum":["none","five_stars_scale"]},"default_proficiency":{"type":"integer","description":"The default value of the proficiency","minimum":0,"maximum":100},"users_count":{"type":"integer","description":"The count of users associated to the attribute"},"flows_count":{"type":"integer","description":"The count of flows using the attribute"},"_links":{"type":"object","description":"HAL API related links.","properties":{"self":{"type":"object","description":"Link to fetch the detail of the attribute","properties":{"href":{"type":"string","description":"Address of the resource","default":"http://api-docs.talkdesk.org/attributes/:id"}}},"attributes":{"type":"object","description":"Link to fetch the list of all attributes","properties":{"href":{"type":"string","description":"Address of the resource","default":"http://api-docs.talkdesk.org/attributes"}}}},"required":["self","attributes"]}},"required":["id","name","active","category_id","category_name","proficiency","default_proficiency","users_count","flows_count","_links"]}}}},"401":{"description":"Missing or invalid 'Authorization' header.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0360000","message":"Missing or invalid 'Authorization' header."}}}},"403":{"description":"Insufficient permissions.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0360003","message":"Forbidden."}}}},"404":{"description":"Attribute Not Found.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0360004","message":"Not found."}}}}}},"put":{"x-namespace":"/attributes","description":"Update an attribute","security":[{"GA":["attributes:write"]}],"summary":"Update an attribute","tags":["Attributes"],"operationId":"UpdateAttribute","parameters":[{"in":"path","name":"attribute_id","description":"The identifier of the attribute.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The updated Attribute.","content":{"application/json":{"schema":{"example":{"id":"123e4567-e89b-12d3-a456-426655440000","name":"Attribute 1","active":true,"category_id":"987e4567-jqw2-23b2-a456-122315440000","category_name":"Category 1","proficiency":"five_stars_scale","default_proficiency":60,"users_count":10,"flows_count":0,"_links":{"self":{"href":"http://api-docs.talkdesk.org/attributes/123e4567-e89b-12d3-a456-426655440000"},"attributes":{"href":"http://api-docs.talkdesk.org/attributes"}}},"type":"object","properties":{"id":{"type":"string","description":"The id of the attribute"},"name":{"type":"string","description":"The name of the attribute"},"active":{"type":"boolean","description":"Whether the attribute is active or inactive"},"category_id":{"type":"string","description":"The id of the attribute category"},"category_name":{"type":"string","description":"The name of the attribute category"},"proficiency":{"type":"string","description":"The type of proficiency","enum":["none","five_stars_scale"]},"default_proficiency":{"type":"integer","description":"The default value of the proficiency","minimum":0,"maximum":100},"users_count":{"type":"integer","description":"The count of users associated to the attribute"},"flows_count":{"type":"integer","description":"The count of flows using the attribute"},"_links":{"type":"object","description":"HAL API related links.","properties":{"self":{"type":"object","description":"Link to fetch the detail of the attribute","properties":{"href":{"type":"string","description":"Address of the resource","default":"http://api-docs.talkdesk.org/attributes/:id"}}},"attributes":{"type":"object","description":"Link to fetch the list of all attributes","properties":{"href":{"type":"string","description":"Address of the resource","default":"http://api-docs.talkdesk.org/attributes"}}}},"required":["self","attributes"]}},"required":["id","name","active","category_id","category_name","proficiency","default_proficiency","users_count","flows_count","_links"]}}}},"400":{"description":"Invalid parameter values submitted.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0360002","message":"Bad request."}}}},"401":{"description":"Missing or invalid 'Authorization' header.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0360000","message":"Missing or invalid 'Authorization' header."}}}},"403":{"description":"Insufficient permissions.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0360003","message":"Forbidden."}}}},"404":{"description":"Attribute Not Found.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0360004","message":"Not found."}}}},"409":{"description":"Attribute update conflict.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0360005","message":"Conflict."}}}}},"requestBody":{"description":"The body of the request","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The name of the attribute"},"category_id":{"type":"string","description":"The id of the attributes category"},"active":{"type":"boolean","description":"Boolean indicating if the attribute is active or not"},"default_proficiency":{"type":"integer","description":"Default value for proficiency","minimum":0,"maximum":100}}}}}}}},"/attributes/{attribute_id}/users":{"get":{"x-namespace":"/attributes","description":"Get the list of users of a given attribute","security":[{"GA":["attributes:read"]}],"summary":"Attribute users list","tags":["Attributes"],"operationId":"GetAllAttributeUsers","parameters":[{"in":"path","name":"attribute_id","description":"The identifier of the attribute.","required":true,"schema":{"type":"string"}},{"in":"query","name":"page","description":"Desired page. Defaults to 1.","required":false,"schema":{"type":"integer","default":1,"minimum":1,"maximum":10000000}},{"in":"query","name":"per_page","description":"Limit the number of attributes per page. Defaults to 50.","required":false,"schema":{"type":"integer","default":50,"minimum":1,"maximum":100}},{"in":"query","name":"name","description":"Filter by attribute 'name'.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Attribute users list","content":{"application/json":{"schema":{"example":{"total":2,"count":1,"page":1,"per_page":1,"_embedded":{"attribute_users":[{"id":"eba9a399-4960-4499-952f-5867275b597a","name":"User 1","team":"Team","proficiency":60,"_links":{"attribute":{"href":"http://api-docs.talkdesk.org/attributes/123e4567-e89b-12d3-a456-426655440000"}}}]},"_links":{"self":{"href":"http://api-docs.talkdesk.org/attributes/123e4567-e89b-12d3-a456-426655440000/users"},"page":{"href":"http://api-docs.talkdesk.org/attributes/123e4567-e89b-12d3-a456-426655440000/users?page=1"},"next":{"href":"http://api-docs.talkdesk.org/attributes/123e4567-e89b-12d3-a456-426655440000/users?page=2"}}},"type":"object","properties":{"total":{"type":"integer"},"count":{"type":"integer"},"page":{"type":"integer"},"per_page":{"type":"integer"},"_embedded":{"type":"object","description":"The list of attributes","properties":{"attribute_users":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The id of the user"},"name":{"type":"string","description":"The name of the user"},"team":{"type":"string","description":"The team of the user"},"proficiency":{"type":"integer","description":"The proficiency of the user in a given attribute","minimum":0,"maximum":100},"_links":{"type":"object","description":"HAL API related links.","properties":{"attribute":{"type":"object","description":"Link to fetch the detail of the attribute","properties":{"href":{"type":"string","description":"Address of the resource","default":"http://api-docs.talkdesk.org/attributes/:id"}}}},"required":["attribute"]}},"required":["id","name","team","proficiency","_links"]}}},"required":["attribute_users"]},"_links":{"type":"object","description":"HAL API related links.","properties":{"self":{"type":"object","description":"Link to fetch a list of all the attributes","properties":{"href":{"type":"string","description":"Address of the resource","default":"http://api-docs.talkdesk.org/attributes/:id/users"}}},"page":{"type":"object","properties":{"templated":{"type":"boolean"},"href":{"type":"string","default":"http://api-docs.talkdesk.org/attributes/:id/users?page=1"}}},"next":{"type":"object","properties":{"templated":{"type":"boolean"},"href":{"type":"string","default":"http://api-docs.talkdesk.org/attributes/:id/users?page=2"}}}}}},"required":["_embedded","_links"]}}}},"400":{"description":"Invalid parameter values submitted.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0360002","message":"Bad request."}}}},"401":{"description":"Missing or invalid 'Authorization' header.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0360000","message":"Missing or invalid 'Authorization' header."}}}},"403":{"description":"Insufficient permissions.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0360003","message":"Forbidden."}}}},"404":{"description":"Attribute Not Found.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0360004","message":"Not found."}}}}}},"post":{"x-namespace":"/attributes","description":"Associates a set of users to a given attribute","security":[{"GA":["attributes:write"]}],"summary":"Associates users to an attribute","tags":["Attributes"],"operationId":"CreateAttributeUsers","parameters":[{"name":"attribute_id","in":"path","description":"The id of the attribute","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The users associated to the attribute.","content":{"application/json":{"schema":{"example":{"attributes_users":[{"id":"eba9a399-4960-4499-952f-5867275b597a","proficiency":60,"_links":{"attribute":{"href":"http://api-docs.talkdesk.org/attributes/123e4567-e89b-12d3-a456-426655440000"}}}]},"type":"object","properties":{"attributes_users":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The id of the user"},"proficiency":{"type":"integer","description":"The proficiency of the user in a given attribute","minimum":0,"maximum":100},"_links":{"type":"object","description":"HAL API related links.","properties":{"attribute":{"type":"object","description":"Link to fetch the detail of the attribute","properties":{"href":{"type":"string","description":"Address of the resource","default":"http://api-docs.talkdesk.org/attributes/:id"}}}},"required":["attribute"]}},"required":["id","proficiency"]}}},"required":["attribute_users"]}}}},"400":{"description":"Invalid parameter values submitted.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0360002","message":"Bad request."}}}},"401":{"description":"Missing or invalid 'Authorization' header.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0360000","message":"Missing or invalid 'Authorization' header."}}}},"403":{"description":"Insufficient permissions.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0360003","message":"Forbidden."}}}},"404":{"description":"Attribute Not Found.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0360004","message":"Not found."}}}}},"requestBody":{"description":"The body of the request","content":{"application/json":{"schema":{"type":"object","properties":{"attributes_users":{"description":"The users to be associated to the attribute","type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The id of the user to assign"},"proficiency":{"type":"integer","description":"The proficiency of the user for the attribute","minimum":0,"maximum":100}}}}},"required":["attributes_users"]}}}}},"delete":{"x-namespace":"/attributes","description":"Remove association of a set of users from a given attribute","security":[{"GA":["attributes:write"]}],"summary":"Remove assotiation of users to an attribute","tags":["Attributes"],"operationId":"DeleteAttributeUsers","parameters":[{"name":"attribute_id","in":"path","description":"The id of the attribute","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Users were disassociated from the attribute."},"400":{"description":"Invalid parameter values submitted.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0360002","message":"Bad request."}}}},"401":{"description":"Missing or invalid 'Authorization' header.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0360000","message":"Missing or invalid 'Authorization' header."}}}},"403":{"description":"Insufficient permissions.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0360003","message":"Forbidden."}}}},"404":{"description":"Attribute Not Found.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0360004","message":"Not found."}}}}},"requestBody":{"description":"The body of the request","content":{"application/json":{"schema":{"type":"object","properties":{"attributes_users":{"description":"The users to be disassociated from the attribute","type":"array","items":{"type":"string"}}}}}}}}},"/attributes-categories":{"get":{"x-namespace":"/attributes-categories","description":"Get the list of attributes categories","security":[{"GA":["attributes:read"]}],"summary":"Attributes Categories list","tags":["Attributes"],"operationId":"GetAllAttributesCategories","parameters":[{"in":"query","name":"sort","description":"Sort by field. Allowed: 'name'. Default value is ascending. Use - for descending order.","required":false,"schema":{"type":"string","enum":["name","-name"]}},{"in":"query","name":"page","description":"Desired page. Defaults to 1.","required":false,"schema":{"type":"integer","default":1,"minimum":1,"maximum":10000000}},{"in":"query","name":"per_page","description":"Limit the number of attributes per page. Defaults to 50.","required":false,"schema":{"type":"integer","default":50,"minimum":1,"maximum":100}}],"responses":{"200":{"description":"Attributes Categories list","content":{"application/json":{"schema":{"example":{"total":2,"count":1,"page":1,"per_page":1,"_embedded":{"categories":[{"id":"123e4567-e89b-12d3-a456-426655440000","name":"Category One","attribute_count":2,"_links":{"self":{"href":"http://api-docs.talkdesk.org/attributes-categories/123e4567-e89b-12d3-a456-426655440000"},"categories":{"href":"http://api-docs.talkdesk.org/attributes-categories"}}}]},"_links":{"self":{"href":"http://api-docs.talkdesk.org/attributes-categories"},"page":{"href":"http://api-docs.talkdesk.org/attributes-categories?page=1"},"next":{"href":"http://api-docs.talkdesk.org/attributes-categories?page=2"}}},"type":"object","properties":{"total":{"type":"integer"},"count":{"type":"integer"},"page":{"type":"integer"},"per_page":{"type":"integer"},"_embedded":{"type":"object","description":"The list of categories","properties":{"categories":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The id of the attributes category"},"name":{"type":"string","description":"The name of the attributes category"},"attribute_count":{"type":"integer","description":"The number of attributes associated with this category"},"_links":{"type":"object","description":"HAL API related links.","properties":{"self":{"type":"object","description":"Link to fetch the detail of the Attributes Category","properties":{"href":{"type":"string","description":"Address of the resource","default":"http://api-docs.talkdesk.org/attributes-categories/:id"}}},"categories":{"type":"object","description":"Link to fetch the list of all attributes categories","properties":{"href":{"type":"string","description":"Address of the resource","default":"http://api-docs.talkdesk.org/attributes-categories"}}}},"required":["self","categories"]}},"required":["id","name","attribute_count","_links"]}}},"required":["categories"]},"_links":{"type":"object","description":"HAL API related links.","properties":{"self":{"type":"object","description":"Link to fetch a list of all the categories","properties":{"href":{"type":"string","description":"Address of the resource","default":"http://api-docs.talkdesk.org/attributes-categories"}}},"page":{"type":"object","properties":{"templated":{"type":"boolean"},"href":{"type":"string","default":"http://api-docs.talkdesk.org/attributes-categories?page=1"}}},"next":{"type":"object","properties":{"templated":{"type":"boolean"},"href":{"type":"string","default":"http://api-docs.talkdesk.org/attributes-categories?page=2"}}}}}},"required":["_embedded","_links"]}}}},"400":{"description":"Invalid parameter values submitted.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0360002","message":"Bad request."}}}},"401":{"description":"Missing or invalid 'Authorization' header.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0360000","message":"Missing or invalid 'Authorization' header."}}}},"403":{"description":"Insufficient permissions.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0360003","message":"Forbidden."}}}}}},"post":{"x-namespace":"/attributes-categories","description":"Create a new Attribute Category","security":[{"GA":["attributes:write"]}],"summary":"Create a new Attribute Category","tags":["Attributes"],"operationId":"CreateAttributeCategory","parameters":[],"responses":{"201":{"description":"The created Attribute Category.","content":{"application/json":{"schema":{"example":{"id":"123e4567-e89b-12d3-a456-426655440000","name":"Category One","attribute_count":2,"_links":{"self":{"href":"http://api-docs.talkdesk.org/attributes-categories/123e4567-e89b-12d3-a456-426655440000"},"categories":{"href":"http://api-docs.talkdesk.org/attributes-categories"}}},"type":"object","properties":{"id":{"type":"string","description":"The id of the attributes category"},"name":{"type":"string","description":"The name of the attributes category"},"attribute_count":{"type":"integer","description":"The number of attributes associated with this category"},"_links":{"type":"object","description":"HAL API related links.","properties":{"self":{"type":"object","description":"Link to fetch the detail of the Attributes Category","properties":{"href":{"type":"string","description":"Address of the resource","default":"http://api-docs.talkdesk.org/attributes-categories/:id"}}},"categories":{"type":"object","description":"Link to fetch the list of all attributes categories","properties":{"href":{"type":"string","description":"Address of the resource","default":"http://api-docs.talkdesk.org/attributes-categories"}}}},"required":["self","categories"]}},"required":["id","name","attribute_count","_links"]}}}},"400":{"description":"Invalid parameter values submitted.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0360002","message":"Bad request."}}}},"401":{"description":"Missing or invalid 'Authorization' header.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0360000","message":"Missing or invalid 'Authorization' header."}}}},"403":{"description":"Insufficient permissions.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0360003","message":"Forbidden."}}}},"409":{"description":"Attribute Category creation conflict.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0360005","message":"Conflict."}}}}},"requestBody":{"description":"The body of the request","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The name of the attribute category"}},"required":["name"]}}}}}},"/attributes-categories/{category_id}":{"delete":{"x-namespace":"/attributes-categories","description":"Delete an Attribute Category","security":[{"GA":["attributes:write"]}],"summary":"Delete an Attribute Category","tags":["Attributes"],"operationId":"DeleteAttributeCategory","parameters":[{"in":"path","name":"category_id","description":"The identifier of the category.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Attribute Category deleted."},"401":{"description":"Missing or invalid 'Authorization' header.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0360000","message":"Missing or invalid 'Authorization' header."}}}},"403":{"description":"Insufficient permissions.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0360003","message":"Forbidden."}}}},"404":{"description":"Attribute Category not found.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0360004","message":"Not found."}}}}}},"patch":{"x-namespace":"/attributes-categories","description":"Update an Attribute Category","security":[{"GA":["attributes:write"]}],"summary":"Update an Attribute Category","tags":["Attributes"],"operationId":"PatchAttributeCategory","parameters":[{"in":"path","name":"category_id","description":"The identifier of the category.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Attribute Category updated","content":{"application/json":{"schema":{"example":{"id":"123e4567-e89b-12d3-a456-426655440000","name":"Category One","attribute_count":2,"_links":{"self":{"href":"http://api-docs.talkdesk.org/attributes-categories/123e4567-e89b-12d3-a456-426655440000"},"categories":{"href":"http://api-docs.talkdesk.org/attributes-categories"}}},"type":"object","properties":{"id":{"type":"string","description":"The id of the attributes category"},"name":{"type":"string","description":"The name of the attributes category"},"attribute_count":{"type":"integer","description":"The number of attributes associated with this category"},"_links":{"type":"object","description":"HAL API related links.","properties":{"self":{"type":"object","description":"Link to fetch the detail of the Attributes Category","properties":{"href":{"type":"string","description":"Address of the resource","default":"http://api-docs.talkdesk.org/attributes-categories/:id"}}},"categories":{"type":"object","description":"Link to fetch the list of all attributes categories","properties":{"href":{"type":"string","description":"Address of the resource","default":"http://api-docs.talkdesk.org/attributes-categories"}}}},"required":["self","categories"]}},"required":["id","name","attribute_count","_links"]}}}},"400":{"description":"Invalid parameter values submitted.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0360002","message":"Bad request."}}}},"401":{"description":"Missing or invalid 'Authorization' header.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0360000","message":"Missing or invalid 'Authorization' header."}}}},"403":{"description":"Insufficient permissions.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0360003","message":"Forbidden."}}}},"404":{"description":"Attribute Category not found.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0360004","message":"Not found."}}}},"409":{"description":"Attribute Category update conflict.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0360005","message":"Conflict."}}}}},"requestBody":{"description":"The body of the request","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The name of the attribute category"}},"required":["name"]}}}}}},"/bulk-imports/users":{"get":{"description":"Get list of imports","security":[{"GA":["bulk-imports:read"]}],"parameters":[{"in":"query","name":"page","schema":{"type":"integer","default":1,"minimum":1}},{"in":"query","name":"per_page","schema":{"type":"integer","default":20,"minimum":1,"maximum":250}},{"in":"query","name":"filter","schema":{"type":"string","x-operators":["eq","or"]},"required":false,"description":"Allows filtering by using comparison and logical operators, similar to OData/SCIM filters.
Regarding operators, we only support eq (exact match filter) + or for logical operators.

\nSupported fields: \nExamples: "},{"in":"query","name":"order_by","description":"Sorts by the indicated field in the specified direction, ascending or descending.
The expression format may contain the suffix asc or desc separated from the property name with a colon in between.

\nSupported fields: \nExamples: ","required":false,"schema":{"type":"string","default":"created_at:desc","x-sorting_default_order":"desc","x-sorting_fields":["created_at"]}}],"tags":["Bulk Import"],"responses":{"200":{"description":"Imports List","content":{"application/json":{"schema":{"type":"object","required":["_embedded","_links"],"properties":{"count":{"type":"integer","description":"The number of results in the current page"},"total":{"type":"integer","description":"The total number of results"},"page":{"type":"integer","description":"The current page"},"per_page":{"type":"integer","description":"The number of results per page"},"_embedded":{"type":"object","required":["imports"],"properties":{"imports":{"type":"array","description":"the results displayed in an array","items":{"type":"object","required":["_links"],"properties":{"id":{"type":"string","description":"the import unique identifier"},"filename":{"type":"string","description":"The name of the file that was submitted"},"total_records":{"type":"integer","description":"The total number of records to proccess"},"failed_records":{"type":"integer","description":"The number of records that failed to import"},"completed_records":{"type":"integer","description":"The number of records imported successfully imported"},"status":{"type":"string","minLength":6,"maxLength":21,"enum":["QUEUED","IN_PROGRESS","CANCELED","FAILED","SUCCESSFUL","COMPLETED_WITH_ERRORS"],"description":"The status of the import"},"type":{"type":"string","minLength":12,"maxLength":12,"enum":["CREATE_USERS","UPDATE_USERS","DELETE_USERS"],"description":"The import type"},"created_by":{"type":"string","description":"The id of the user who submitted the import"},"created_at":{"type":"string","format":"date-time","description":"The date when the import was submitted"},"updated_by":{"type":"string","description":"The id of the user/system who updated the import"},"updated_at":{"type":"string","format":"date-time","description":"The date when the import was updated"},"canceled_by":{"type":"string","description":"The id of the user/system who canceled the import"},"canceled_at":{"type":"string","description":"The date when the import was canceled","format":"date-time"},"_links":{"type":"object","description":"the defined links","required":["self"],"properties":{"self":{"type":"object","description":"the URI of the imports list","required":["href"],"properties":{"href":{"type":"string","description":"the URI value"}}},"records":{"type":"object","description":"the URI of the import records","required":["href"],"properties":{"href":{"type":"string","description":"the URI value"}}}}}},"additionalProperties":false}}},"additionalProperties":false},"_links":{"type":"object","description":"the defined links","required":["self"],"properties":{"self":{"type":"object","description":"the URI of the imports list","required":["href"],"properties":{"href":{"type":"string","description":"the URI value","example":"http://api-docs.talkdesk.org/bulk-imports/users"}}},"next":{"type":"object","description":"the URI of the next page of the imports list","properties":{"href":{"type":"string","description":"the URI value","example":"http://api-docs.talkdesk.org/bulk-imports/users?page=2"}}},"prev":{"type":"object","description":"the URI of the previous page of the imports list","properties":{"href":{"type":"string","description":"the URI value","example":"http://api-docs.talkdesk.org/bulk-imports/users?page=1"}}},"first":{"type":"object","description":"the URI of the first page of the imports list","properties":{"href":{"type":"string","description":"the URI value","example":"http://api-docs.talkdesk.org/bulk-imports/users?page=1"}}},"last":{"type":"object","description":"the URI of the last page of the imports list","properties":{"href":{"type":"string","description":"the URI value","example":"http://api-docs.talkdesk.org/bulk-imports/users?page=10"}}}}}},"additionalProperties":false},"example":{"count":1,"total":10,"page":2,"per_page":1,"_embedded":{"imports":[{"id":"182d828c-6731-4143-aaaf-24248e0c11bf","filename":"agents.csv","total_records":5000,"failed_records":38,"completed_records":2500,"status":"QUEUED","type":"CREATE_USERS","created_by":"F606da803c9b2adaefa4e573c","created_at":"2017-07-21T17:32:28.000Z","updated_by":"606da803c9b2adaefa4e573c","updated_at":"2017-07-21T17:32:28.000Z","canceled_by":"606da803c9b2adaefa4e573c","canceled_at":"2017-07-21T17:32:28.000Z","_links":{"self":{"href":"http://api-docs.talkdesk.org/bulk-imports/users/{import_id}"}}}]},"_links":{"self":{"href":"http://api-docs.talkdesk.org/bulk-imports/users"},"next":{"href":"http://api-docs.talkdesk.org/bulk-imports/users?page=3"},"prev":{"href":"http://api-docs.talkdesk.org/bulk-imports/users?page=1"},"first":{"href":"http://api-docs.talkdesk.org/bulk-imports/users?page=1"},"last":{"href":"http://api-docs.talkdesk.org/bulk-imports/users?page=10"}}}}}},"400":{"description":"Bad request when query parameters contain invalid values","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Query Parsing Failed":{"value":{"code":"1600001","message":"Query parsing failed","description":"Malformed query"}},"Invalid Pagination Parameters":{"value":{"code":"1600002","message":"Invalid pagination parameter(s)","description":"page query parameter must be 1 or greater"}},"Invalid Sort Criteria":{"value":{"code":"1600003","message":"Invalid sort criteria","description":"'field' is not a valid sort criteria"}}}}}},"401":{"description":"Missing authorization header","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1600004","message":"Missing Authorization header","description":"Invalid JWT token"}}}},"403":{"description":"Invalid authorization","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid Scopes":{"value":{"code":"1600005","message":"Forbidden","description":"Missing scopes"}},"Invalid Policies":{"value":{"code":"1600005","message":"Forbidden","description":"Invalid policies"}}}}}},"406":{"description":"Accept Format MIME Type Unsupported","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1600014","message":"Accept MIME type not supported","description":"Accept MIME type 'mime_type' is not supported"}}}}}},"post":{"description":"Create a new import","security":[{"GA":["bulk-imports:write"]}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"text/csv","minLength":1},"type":{"type":"string","minLength":12,"maxLength":12,"enum":["CREATE_USERS","UPDATE_USERS","DELETE_USERS"],"description":"The import type"}},"required":["type","file"]},"example":{"default":{"value":{"file":"my,sample,columns 1,2,3","type":"CREATE_USERS"}}}},"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","minLength":12,"maxLength":12,"enum":["EXPORT_USERS"],"description":"The import type"}},"required":["type"]},"examples":{"Export Users":{"value":{"type":"EXPORT_USERS"}}}}}},"tags":["Bulk Import"],"responses":{"202":{"description":"Import was successfully enqueued","headers":{"Location":{"schema":{"type":"string"},"description":"The resource URL of the created import","example":"http://api-docs.talkdesk.org/bulk-imports/users/{import_id}"}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"the import unique identifier"},"filename":{"type":"string","description":"The name of the file that was submitted"},"total_records":{"type":"integer","description":"The total number of records to proccess"},"failed_records":{"type":"integer","description":"The number of records that failed to import"},"completed_records":{"type":"integer","description":"The number of records imported successfully imported"},"updated_by":{"type":"string","description":"The id of the user/system who updated the import"},"updated_at":{"type":"string","format":"date-time","description":"The date when the import was updated"},"canceled_by":{"type":"string","description":"The id of the user/system who canceled the import","nullable":true},"canceled_at":{"type":"string","description":"The date when the import was canceled","format":"date-time","nullable":true},"status":{"type":"string","minLength":6,"maxLength":21,"enum":["QUEUED","IN_PROGRESS","CANCELED","FAILED","SUCCESSFUL","COMPLETED_WITH_ERRORS"],"description":"The status of the import"},"type":{"type":"string","minLength":12,"maxLength":12,"enum":["CREATE_USERS","UPDATE_USERS","DELETE_USERS"],"description":"The import type"},"created_by":{"type":"string","description":"The id of the user who submitted the import"},"created_at":{"type":"string","format":"date-time","description":"The date when the import was submitted"},"_links":{"type":"object","description":"the defined links","required":["self"],"properties":{"self":{"type":"object","description":"the URI of the imports list","required":["href"],"properties":{"href":{"type":"string","description":"the URI value"}}},"records":{"type":"object","description":"the URI of the import records","required":["href"],"properties":{"href":{"type":"string","description":"the URI value"}}}}}},"required":["id","filename","total_records","failed_records","completed_records","status","type","created_by","created_at","updated_at","_links"]},"example":{"id":"182d828c-6731-4143-aaaf-24248e0c11bf","filename":"agents.csv","total_records":5000,"failed_records":0,"completed_records":0,"status":"QUEUED","type":"CREATE_USERS","created_by":"F606da803c9b2adaefa4e573c","created_at":"2017-07-21T17:32:28.000Z","updated_by":"F606da803c9b2adaefa4e573c","updated_at":"2017-07-21T17:33:00.000Z","canceled_by":null,"canceled_at":null,"_links":{"self":{"href":"http://api-docs.talkdesk.org/bulk-imports/users/{import_id}"}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Empty CSV File/Only Contains Headers":{"value":{"code":"1600008","message":"Request failed due to invalid syntax","description":"CSV file is empty"}},"File Extension Not Supported":{"value":{"code":"1600009","message":"Request failed due to invalid syntax","description":"File extension is not supported"}},"Missing Required Header(s)":{"value":{"code":"1600011","message":"Request failed due to invalid syntax","description":"The request is missing required fields"}},"Maximum Lines in CSV Reached":{"value":{"code":"1600018","message":"The number of records is not within the allowed range","description":"The number of records should be between 1 and "}},"Invalid Import Type":{"value":{"code":"1600019","message":"Invalid Import Type","description":"Import type is not supported"}},"Missing Required Attribute":{"value":{"code":"1600020","message":"Request failed due to invalid syntax","description":"Attribute 'attribute' must not be null"}},"Invalid Payload":{"value":{"code":"1600021","message":"Request failed due to invalid syntax"}}}}}},"401":{"description":"Missing authorization header","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1600004","message":"Missing Authorization header","description":"Invalid JWT token"}}}},"403":{"description":"Invalid authorization","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid Scopes":{"value":{"code":"1600005","message":"Forbidden","description":"Missing scopes"}},"Invalid Policies":{"value":{"code":"1600005","message":"Forbidden","description":"Invalid policies"}}}}}},"406":{"description":"Accept Format MIME Type Unsupported","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1600014","message":"Accept MIME type not supported","description":"Accept MIME type 'mime_type' is not supported"}}}},"413":{"description":"Payload Too Large","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1600012","message":"File size is too large","description":"File size exceeds 5 megabytes limit"}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1600013","message":"Content type is not supported","description":"Provided Media type is not supported"}}}}}}},"/bulk-imports/users/{import_id}":{"get":{"description":"Get an import","security":[{"GA":["bulk-imports:read"]}],"parameters":[{"in":"path","name":"import_id","schema":{"type":"string","format":"uuid"},"required":true}],"tags":["Bulk Import"],"responses":{"200":{"description":"Import detail","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"the import unique identifier"},"filename":{"type":"string","description":"The name of the file that was submitted"},"total_records":{"type":"integer","description":"The total number of records to proccess"},"failed_records":{"type":"integer","description":"The number of records that failed to import"},"completed_records":{"type":"integer","description":"The number of records imported successfully imported"},"status":{"type":"string","minLength":6,"maxLength":21,"enum":["QUEUED","IN_PROGRESS","CANCELED","FAILED","SUCCESSFUL","COMPLETED_WITH_ERRORS"],"description":"The status of the import"},"type":{"type":"string","minLength":12,"maxLength":12,"enum":["CREATE_USERS","UPDATE_USERS","DELETE_USERS"],"description":"The import type"},"created_by":{"type":"string","description":"The id of the user who submitted the import"},"created_at":{"type":"string","format":"date-time","description":"The date when the import was submitted"},"updated_by":{"type":"string","description":"The id of the user/system who updated the import"},"updated_at":{"type":"string","format":"date-time","description":"The date when the import was updated"},"canceled_by":{"type":"string","description":"The id of the user/system who canceled the import"},"canceled_at":{"type":"string","description":"The date when the import was canceled","format":"date-time"},"_links":{"type":"object","description":"the defined links","properties":{"self":{"type":"object","description":"the URI of the imports list","required":["href"],"properties":{"href":{"type":"string","description":"the URI value"}}},"records":{"type":"object","description":"the URI of the import records","required":["href"],"properties":{"href":{"type":"string","description":"the URI value"}}}}}}},"example":{"id":"182d828c-6731-4143-aaaf-24248e0c11bf","filename":"agents.csv","total_records":5000,"failed_records":38,"completed_records":2500,"status":"QUEUED","type":"CREATE_USERS","created_by":"F606da803c9b2adaefa4e573c","created_at":"2017-07-21T17:32:28.000Z","updated_by":"606da803c9b2adaefa4e573c","updated_at":"2017-07-21T17:32:28.000Z","canceled_by":"606da803c9b2adaefa4e573c","canceled_at":"2017-07-21T17:32:28.000Z","_links":{"self":{"href":"http://api-docs.talkdesk.org/bulk-imports/users/{import_id}"}}}}}},"401":{"description":"Missing authorization header","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1600004","message":"Missing Authorization header","description":"Invalid JWT token"}}}},"403":{"description":"Invalid authorization","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid Scopes":{"value":{"code":"1600005","message":"Forbidden","description":"Missing scopes"}},"Invalid Policies":{"value":{"code":"1600005","message":"Forbidden","description":"Invalid policies"}}}}}},"404":{"description":"Import not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1600007","message":"The import with the specified id was not found","description":"Import with id 'import-id' was not found"}}}},"406":{"description":"Accept Format MIME Type Unsupported","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1600014","message":"Accept MIME type not supported","description":"Accept MIME type 'mime_type' is not supported"}}}}}},"patch":{"description":"Updates one import","security":[{"GA":["bulk-imports:write"]}],"parameters":[{"in":"path","name":"import_id","schema":{"type":"string","format":"uuid"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","description":"The status to be altered","minLength":8,"maxLength":8,"enum":["CANCELED"]}},"required":["status"]},"example":{"status":"CANCELED"}}}},"tags":["Bulk Import"],"responses":{"200":{"description":"The updated import","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"the import unique identifier"},"filename":{"type":"string","description":"The name of the file that was submitted"},"total_records":{"type":"integer","description":"The total number of records to proccess"},"failed_records":{"type":"integer","description":"The number of records that failed to import"},"completed_records":{"type":"integer","description":"The number of records imported successfully imported"},"status":{"type":"string","minLength":6,"maxLength":21,"enum":["QUEUED","IN_PROGRESS","CANCELED","FAILED","SUCCESSFUL","COMPLETED_WITH_ERRORS"],"description":"The status of the import"},"type":{"type":"string","minLength":12,"maxLength":12,"enum":["CREATE_USERS","UPDATE_USERS","DELETE_USERS"],"description":"The import type"},"created_by":{"type":"string","description":"The id of the user who submitted the import"},"created_at":{"type":"string","format":"date-time","description":"The date when the import was submitted"},"updated_by":{"type":"string","description":"The id of the user/system who updated the import"},"updated_at":{"type":"string","format":"date-time","description":"The date when the import was updated"},"canceled_by":{"type":"string","description":"The id of the user/system who canceled the import"},"canceled_at":{"type":"string","description":"The date when the import was canceled","format":"date-time"},"_links":{"type":"object","description":"the defined links","properties":{"self":{"type":"object","description":"the URI of the imports list","required":["href"],"properties":{"href":{"type":"string","description":"the URI value"}}},"records":{"type":"object","description":"the URI of the import records","required":["href"],"properties":{"href":{"type":"string","description":"the URI value"}}}}}}},"example":{"id":"182d828c-6731-4143-aaaf-24248e0c11bf","filename":"agents.csv","total_records":5000,"failed_records":38,"completed_records":2500,"status":"QUEUED","type":"CREATE_USERS","created_by":"F606da803c9b2adaefa4e573c","created_at":"2017-07-21T17:32:28.000Z","updated_by":"606da803c9b2adaefa4e573c","updated_at":"2017-07-21T17:32:28.000Z","canceled_by":"606da803c9b2adaefa4e573c","canceled_at":"2017-07-21T17:32:28.000Z","_links":{"self":{"href":"http://api-docs.talkdesk.org/bulk-imports/users/{import_id}"}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Import Not Queued":{"value":{"code":"1600016","message":"Import Status is not Queued","description":"The Import with the given id is not in a Queued state"}},"Invalid Import Status":{"value":{"code":"1600017","message":"Invalid Import Status","description":"Value 'status' is not a valid Import Status"}},"Invalid Payload":{"value":{"code":"1600021","message":"Request failed due to invalid syntax"}}}}}},"401":{"description":"Missing authorization header","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1600004","message":"Missing Authorization header","description":"Invalid JWT token"}}}},"403":{"description":"Invalid authorization","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid Scopes":{"value":{"code":"1600005","message":"Forbidden","description":"Missing scopes"}},"Invalid Policies":{"value":{"code":"1600005","message":"Forbidden","description":"Invalid policies"}}}}}},"404":{"description":"Import not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1600007","message":"The import with the specified id was not found","description":"Import with id 'import-id' was not found"}}}},"406":{"description":"Accept Format MIME Type Unsupported","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1600014","message":"Accept MIME type not supported","description":"Accept MIME type 'mime_type' is not supported"}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1600013","message":"Content type is not supported","description":"Provided Media type is not supported"}}}}}}},"/bulk-imports/users/{import_id}/errors":{"get":{"description":"Get a CSV file containing errors from an import","security":[{"GA":["bulk-imports:read"]}],"parameters":[{"in":"path","name":"import_id","schema":{"type":"string","format":"uuid"},"required":true}],"tags":["Bulk Import"],"responses":{"200":{"description":"CSV file containing an extra column with Import Record's errors","content":{"text/csv":{}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid Import Status":{"value":{"code":"1600017","message":"Invalid Import Status","description":"The current Import Status doesn't match the expected [COMPLETED_WITH_ERRORS, FAILED]"}}}}}},"401":{"description":"Missing authorization header","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1600004","message":"Missing Authorization header","description":"Invalid JWT token"}}}},"403":{"description":"Invalid authorization","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid Scopes":{"value":{"code":"1600005","message":"Forbidden","description":"Missing scopes"}},"Invalid Policies":{"value":{"code":"1600005","message":"Forbidden","description":"Invalid policies"}}}}}},"404":{"description":"Import not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Import not found":{"value":{"code":"1600007","message":"The import with the specified id was not found","description":"Import with id 'import-id' was not found"}},"No access to errors file":{"value":{"code":"1600007","message":"The import with the specified id was not found","description":"User cannot access the errors file"}}}}}},"406":{"description":"Accept Format MIME Type Unsupported","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1600014","message":"Accept MIME type not supported","description":"Accept MIME type 'mime_type' is not supported"}}}}}}},"/bulk-imports/users/{import_id}/outputs":{"get":{"description":"Get the outputs of an export job","security":[{"GA":["bulk-imports:read"]}],"parameters":[{"in":"path","name":"import_id","schema":{"type":"string","format":"uuid"},"required":true}],"tags":["Bulk Import"],"responses":{"200":{"description":"Links to the outputs of the export job","content":{"application/hal+json":{"schema":{"type":"object","properties":{"outputs":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"The URL of the output file"},"metadata":{"type":"object","properties":{"type":{"type":"string","enum":["EXPORT"],"minLength":6,"maxLength":6,"description":"The type of the output"},"expires_at":{"type":"string","format":"date-time","description":"The expiration date of the output"}},"required":["type","expires_at"]}},"required":["url","metadata"]}}},"required":["outputs"]},"example":{"outputs":{"url":"http://path-to-output-file.com/job_id.csv","metadata":{"type":"EXPORT","expires_at":"2017-07-21T17:32:28.000Z"}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid Import Status":{"value":{"code":"1600017","message":"Invalid Import Status","description":"The current Import Status doesn't match the expected [SUCCESSFUL]"}}}}}},"401":{"description":"Missing authorization header","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1600004","message":"Missing Authorization header","description":"Invalid JWT token"}}}},"403":{"description":"Invalid authorization","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid Scopes":{"value":{"code":"1600005","message":"Forbidden","description":"Missing scopes"}},"Invalid Policies":{"value":{"code":"1600005","message":"Forbidden","description":"Invalid policies"}}}}}},"404":{"description":"Import not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Import not found":{"value":{"code":"1600007","message":"The import with the specified id was not found","description":"Import with id 'import-id' was not found"}},"No access to outputs files":{"value":{"code":"1600007","message":"The import with the specified id was not found","description":"User cannot access the output files"}}}}}},"406":{"description":"Accept Format MIME Type Unsupported","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1600014","message":"Accept MIME type not supported","description":"Accept MIME type 'mime_type' is not supported"}}}}}}},"/ring-groups":{"get":{"description":"Get list of ring groups","security":[{"GA":["ring-groups:read"]}],"parameters":[{"name":"page","in":"query","description":"Desired page. Defaults to 1.","required":false,"schema":{"type":"integer","default":1}},{"name":"per_page","in":"query","description":"Limit the number of keys to display","required":false,"schema":{"type":"integer","default":50}},{"name":"name","in":"query","description":"Filter the results by ring group whose name partially match with the provided argument","required":false,"schema":{"type":"string"}},{"name":"order_by","in":"query","description":"The order_by parameter allows you to sort the retrieved interaction contacts.\n\nSupported sort fields\n* `name` - Sort by ring group name\n\nBy default, the sort direction is ascending, i.e. `:asc`, however you can request to retrieve the results in\ndescending order by specifying `:desc` with the field.\n\nIf no order_by is not provided the ring groups come in an undefined order.\n\nExamples\n* `order_by=name:desc`\n","required":false,"schema":{"type":"string","x-sorting_default_order":"asc","x-sorting_fields":["name"]}}],"tags":["Ring Groups"],"responses":{"200":{"description":"List of ring groups","content":{"application/json":{"schema":{"example":{"total":10,"page":2,"per_page":2,"count":2,"_embedded":{"ring_groups":[{"name":"agents"},{"name":"sales","short_abandoned_threshold":5,"wait_time_threshold":20},{"name":"support","short_abandoned_threshold":5},{"name":"returns","wait_time_threshold":25}]},"_links":{"self":{"href":"https://api-docs.talkdesk.org/ring-groups?page=2&per_page=2"},"next":{"href":"https://api-docs.talkdesk.org/ring-groups?page=3&per_page=2"},"previous":{"href":"https://api-docs.talkdesk.org/ring-groups?page=1&per_page=2"},"page":{"templated":true,"href":"https://api-docs.talkdesk.org/ring-groups?page={page}&per_page=2"}}},"type":"object","properties":{"total":{"type":"integer"},"page":{"type":"integer"},"per_page":{"type":"integer"},"count":{"type":"integer"},"_embedded":{"type":"object","description":"A subset of the list of Ring Groups for the account","properties":{"ring_groups":{"type":"array","uniqueItems":true,"items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The name that represents the ring group"},"short_abandoned_threshold":{"type":"integer","description":"Short calls that abandon before this threshold will not be reported as abandoned."},"wait_time_threshold":{"type":"integer","description":"Calls answered within the threshold will be considered as meeting Service Level."}}}}}},"_links":{"type":"object","description":"HAL API related links.","properties":{"self":{"type":"object","properties":{"href":{"type":"string"}}},"next":{"type":"object","properties":{"href":{"type":"string"}}},"previous":{"type":"object","properties":{"href":{"type":"string"}}},"page":{"type":"object","properties":{"templated":{"type":"boolean"},"href":{"type":"string"}}}}}}}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid ring group":{"value":{"code":"0300006","message":"Invalid ring group."}},"User without ring group":{"value":{"code":"0300008","message":"One or more users will be without ring groups."}},"Error Assigning chained ring group to user":{"value":{"code":"0300009","message":"Error assigning a chained ring group to a user."}},"Max ring groups allowed for agents":{"value":{"code":"0300010","message":"The agent reached the max ring groups allowed."}},"Invalid order_by parameter":{"value":{"code":"0300011","message":"Invalid order_by parameter."}}}}}},"401":{"description":"The request does not contain one of the mandatory headers.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0300001","message":"Access denied."}}}},"403":{"description":"The user is authenticated but does not have sufficient permissions to perform the action.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0300002","message":"Forbidden access."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0300004","message":"Account not found."}}}}}}},"/ring-groups/{id}/users":{"get":{"description":"Get list of users assigned to ring group","security":[{"GA":["user-ring-groups:read"]}],"parameters":[{"name":"id","in":"path","description":"Identifier of the ring group","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Desired page. Defaults to 1.","required":false,"schema":{"type":"integer","default":1}},{"name":"per_page","in":"query","description":"Limit the number of keys to display","required":false,"schema":{"type":"integer","default":50}},{"name":"active","in":"query","description":"Filter the results by active flag","required":false,"schema":{"type":"boolean"}}],"tags":["Ring Groups"],"responses":{"200":{"description":"List of users assigned to ring group","content":{"application/json":{"schema":{"example":{"total":10,"page":2,"per_page":2,"count":2,"ring_group":"agents","_embedded":{"users":[{"id":"5d94b9e9a29b78447056c775","_links":{"self":{"href":"https://api-docs.talkdesk.org/users/{user_id}"}}},{"id":"5d94b9e9a29b78447056c775","_links":{"self":{"href":"https://api-docs.talkdesk.org/users/{user_id}"}}}]},"_links":{"self":{"href":"https://api-docs.talkdesk.org/ring-groups/agents/users?page=2&per_page=2"},"next":{"href":"https://api-docs.talkdesk.org/ring-groups/agents/users?page=3&per_page=2"},"previous":{"href":"https://api-docs.talkdesk.org/ring-groups/agents/users?page=1&per_page=2"},"page":{"templated":true,"href":"https://api-docs.talkdesk.org/ring-groups/agents/users?page={page}&per_page=2"}}},"type":"object","properties":{"total":{"type":"integer"},"page":{"type":"integer"},"per_page":{"type":"integer"},"count":{"type":"integer"},"ring_group":{"type":"string"},"_embedded":{"type":"object","description":"A subset of the list of Users for the Ring Group","properties":{"users":{"type":"array","uniqueItems":true,"items":{"type":"object","required":["id","_links"],"properties":{"id":{"type":"string","description":"the Id of the user"},"_links":{"type":"object","description":"the defined links","properties":{"self":{"type":"object","description":"the URI of the details of the user","properties":{"href":{"type":"string","default":"http://api-docs.talkdesk.org/users/:id"}}}}}}}}}},"_links":{"type":"object","description":"HAL API related links.","properties":{"self":{"type":"object","properties":{"href":{"type":"string"}}},"next":{"type":"object","properties":{"href":{"type":"string"}}},"previous":{"type":"object","properties":{"href":{"type":"string"}}},"page":{"type":"object","properties":{"templated":{"type":"boolean"},"href":{"type":"string"}}}}}}}}}},"401":{"description":"The request does not contain one of the mandatory headers.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0300001","message":"Access denied."}}}},"403":{"description":"The user is authenticated but does not have sufficient permissions to perform the action.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0300002","message":"Forbidden access."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0300007","message":"Ring Group not found."}}}}}}},"/actions/users/assign-ring-groups":{"post":{"description":"Assigns multiple ring groups to multiple agents. Some relevant caveats about the operation:\n* The operation is idempotent and it returns successfully even if some users already have some of the ring\n groups (and for those cases the operation is a noop).\n\n* As ring groups aren't really a resource on our domain, assigning a \"non-existent\" ring group to an agent has the\n side-effect of \"creating\" the ring group (e.g. the account ring groups endpoint will start listing it).\n\n* The operation is non-transactional. This means that in case of an error the operation can be partially applied,\n even if a error status code is returned.\n","operationId":"AssignUserRingGroups","security":[{"EarlyAccess":["user-ring-groups:write"]}],"tags":["Ring Groups"],"parameters":[],"responses":{"204":{"description":"The ring groups were associated"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"General bad request":{"value":{"code":"0300012","message":"Bad request."}},"Invalid ring groups":{"value":{"code":"0300006","message":"There are ring groups with invalid names: large_ring_group, large_ring_group_2"}},"Bulk operations limit exceed":{"value":{"code":"0300007","message":"Bulk operations limit exceeded. Found: 101. Allowed: 100."}},"Assigned chained ring group to user error":{"value":{"code":"0300009","message":"Chained ring groups cannot be assigned to users: ring_group_name"}},"Ring group size error":{"value":{"code":"0300010","message":"One of the agents reached the max ring groups allowed."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0300001","message":"Access denied."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0300002","message":"Forbidden access."}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0300003","message":"An error has occurred, please contact Talkdesk support."}}}}},"requestBody":{"description":"The body of the request.","required":true,"content":{"application/hal+json":{"schema":{"type":"array","items":{"type":"object","properties":{"user_id":{"type":"string","description":"The user id of the user to which the ring groups should be assigned to."},"ring_groups":{"type":"array","description":"The list of ring groups to be associated with the user.","uniqueItems":true,"items":{"type":"string"}}},"required":["ring_groups","user_id"]}},"example":[{"user_id":"dc54ca5f13994a679fbf448bf017c995","ring_groups":["support-en","support-es","agents-en","agents-es","agents"]},{"user_id":"25f6e1db36ec4e5cbaf46eae9bfb4f08","ring_groups":["support-pt","agents-pt","agents"]}]}}}}},"/actions/users/unassign-ring-groups":{"post":{"description":"Unassigns multiple ring groups from multiple agents.\nSome relevant caveats about the operation:\n* The operation is idempotent and it successfully even if some ring groups are already missing from the user\n (for those cases the operation is a noop).\n\n* The operation is non-transactional. This means that in case of an error the operation can be partially applied,\n even if a error status code is returned.\n","operationId":"UnassignUserRingGroups","security":[{"EarlyAccess":["user-ring-groups:write"]}],"tags":["Ring Groups"],"parameters":[],"responses":{"204":{"description":"The ring groups were dissociated"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"General bad request":{"value":{"code":"0300012","message":"Bad request."}},"Invalid ring groups":{"value":{"code":"0300006","message":"There are ring groups with invalid names: large_ring_group, large_ring_group_2"}},"Bulk operations limit exceed":{"value":{"code":"0300007","message":"Bulk operations limit exceeded. Found: 101. Allowed: 100."}},"Invalid user ring groups":{"value":{"code":"0300008","message":"One or more users will be without ring groups."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0300001","message":"Access denied."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0300002","message":"Forbidden access."}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0300003","message":"An error has occurred, please contact Talkdesk support."}}}}},"requestBody":{"description":"The body of the request.","required":true,"content":{"application/hal+json":{"schema":{"type":"array","items":{"type":"object","properties":{"user_id":{"type":"string","description":"The user id of the user to which the ring groups should be assigned to."},"ring_groups":{"type":"array","description":"The list of ring groups to be associated with the user.","uniqueItems":true,"items":{"type":"string"}}},"required":["ring_groups","user_id"]}},"example":[{"user_id":"dc54ca5f13994a679fbf448bf017c995","ring_groups":["support-en","support-es","agents-en","agents-es","agents"]},{"user_id":"25f6e1db36ec4e5cbaf46eae9bfb4f08","ring_groups":["support-pt","agents-pt","agents"]}]}}}}},"/users/{id}/ring-groups":{"put":{"description":"Update the ring groups associated to an user.","operationId":"UpdateUserRingGroups","x-namespace":"/users","security":[{"EarlyAccess":["user-ring-groups:write"]}],"tags":["Ring Groups"],"parameters":[{"name":"id","in":"path","description":"The user identifier.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"The ring groups were associated"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"General bad request":{"value":{"code":"0300012","message":"Bad request."}},"Invalid ring groups":{"value":{"code":"0300006","message":"There are ring groups with invalid names: large_ring_group, large_ring_group_2"}},"Invalid user ring groups":{"value":{"code":"0300008","message":"The user cannot be without ring groups."}},"Assigned chained ring group to user error":{"value":{"code":"0300009","message":"Chained ring groups cannot be assigned to users: ring_group_name"}},"Ring group size error":{"value":{"code":"0300010","message":"One of the agents reached the max ring groups allowed."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0300001","message":"Access denied."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0300002","message":"Forbidden access."}}}},"404":{"description":"User not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0300005","message":"User not found."}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0300003","message":"An error has occurred, please contact Talkdesk support."}}}}},"requestBody":{"description":"The body of the request.","content":{"application/hal+json":{"schema":{"type":"object","properties":{"ring_groups":{"type":"array","description":"The list of ring groups to be associated with the user.","uniqueItems":true,"items":{"type":"string"}}},"required":["ring_groups"]},"example":{"type":"object","properties":{"user_id":{"type":"string","description":"The user id of the user to which the ring groups should be assigned to."},"ring_groups":{"type":"array","description":"The list of ring groups to be associated with the user.","uniqueItems":true,"items":{"type":"string"}}},"required":["ring_groups","user_id"]}}}}}},"/calls/{call_id}/recordings":{"get":{"description":"Get list of recordings for a call, screen recording is not included","security":[{"GA":["recordings:read"]}],"parameters":[{"name":"call_id","in":"path","description":"The call id (interaction id)","required":true,"schema":{"type":"string"}}],"tags":["Recordings"],"responses":{"200":{"description":"List of recordings","content":{"application/json":{"schema":{"example":{"total":2,"count":2,"page":1,"per_page":2,"_embedded":{"recordings":[{"id":"1ba635df-963d-4f35-b22f-8b3271e43e41","call_id":"89efa1c4-2ac1-4241-9ab5-821251694584","created_at":"2016-07-11T16:34:50.000Z","index":0,"duration":5,"type":"conversation","agents":{"channel_1":[{"participant_type":"AGENT","participant_id":"0190ef26f59b750d84fc04128b211bd2"}],"channel_2":[{"participant_type":"CONTACT","participant_id":null}]},"_links":{"self":{"href":"http://api-docs.talkdesk.org/recordings/{recording_id}"},"media":{"href":"http://api-docs.talkdesk.org/recordings/{recording_id}/content?token=some.token.signed"}}},{"id":"8c062997-f8d0-4d82-b128-6f37b67e1169","call_id":"89efa1c4-2ac1-4241-9ab5-821251694584","created_at":"2016-07-11T16:34:50.000Z","index":1,"duration":15,"type":"consultation","agents":{"channel_1":[{"participant_type":"EXTERNAL_NUM","participant_id":null}],"channel_2":[{"participant_type":"AGENT","participant_id":"0190ef26f59b750d84fc04128b211bd2"},{"participant_type":"AGENT","participant_id":"0190ef277e777e6cad7f85e9e264821f"}]},"_links":{"self":{"href":"http://api-docs.talkdesk.org/recordings/{recording_id}"},"media":{"href":"http://api-docs.talkdesk.org/recordings/{recording_id}/content?token=some.token.signed"}}}]},"_links":{"self":{"href":"http://api-docs.talkdesk.org/calls/{call_id}/recordings"},"page":{"templated":true,"href":"http://api-docs.talkdesk.org/calls/{call_id}/recordings"},"next":{"href":"http://api-docs.talkdesk.org/calls/{call_id}/recordings?page=1"}}},"type":"object","properties":{"total":{"type":"integer"},"count":{"type":"integer"},"page":{"type":"integer"},"per_page":{"type":"integer"},"_embedded":{"type":"object","properties":{"recordings":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"call_id":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"index":{"type":"integer"},"duration":{"type":"integer"},"type":{"description":"The type of content that was recorded.","type":"string","enum":["conversation","voicemail","agent","consultation"]},"agents":{"type":"object","properties":{"channel_1":{"type":"array","items":{"type":"object","properties":{"participant_type":{"type":"string","enum":["AGENT","CONTACT","EXTERNAL_NUM"]},"participant_id":{"type":"string"}}}},"channel_2":{"type":"array","items":{"type":"object","properties":{"participant_type":{"type":"string","enum":["AGENT","CONTACT","EXTERNAL_NUM"]},"participant_id":{"type":"string"}}}}}},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","default":"http://api-docs.talkdesk.org/recordings/:id"}}},"media":{"type":"object","properties":{"href":{"type":"string","default":"http://api-docs.talkdesk.org/recordings/:id/media"}}}}}}}}}},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","default":"http://api-docs.talkdesk.org/calls/:call_id/recordings"}}},"page":{"type":"object","properties":{"templated":{"type":"boolean"},"href":{"type":"string","default":"http://api-docs.talkdesk.org/calls/:call_id/recordings"}}},"next":{"type":"object","properties":{"href":{"type":"string","default":"http://api-docs.talkdesk.org/calls/:call_id/recordings?page=2"}}}}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0011009","message":"Unauthorized"}}}},"403":{"description":"Forbidden access","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0050003","message":"Forbidden access"}}}},"404":{"description":"Recordings not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0050005","message":"Recordings not found"}}}}}}},"/calls/callback":{"post":{"description":"Request a new direct callback, either to Callback API or Legacy Central (dependant on a Split IO Feature Flag)","security":[{"GA":["callback:write"]}],"tags":["Calls"],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Missing parameters":{"value":{"code":"0020006","message":"Missing parameter(s)"}},"Invalid json":{"value":{"code":"0020007","message":"Invalid JSON in request body"}},"Invalid context fields":{"value":{"code":"0020008","message":"Invalid fields","fields":[{"name":"field_name","description":"Field error description"}]}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid authentication":{"value":{"code":"0020002","message":"Invalid authentication"}},"Account does not exist":{"value":{"code":"0020004","message":"Account doesn't exist"}}}}}},"403":{"description":"Forbidden access","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0030009","message":"Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0020005","message":"talkdesk_phone_number doesn't belongs to account"}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0020001","message":"Unsupported Media Type"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0020003","message":"Invalid account_id"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0020017","message":"Load Shedding is enabled","fields":[{"name":"retry-after","description":"How long the user agent should wait before making a follow-up request"}]}}}}},"requestBody":{"description":"The body of the request","content":{"application/json":{"schema":{"type":"object","properties":{"talkdesk_phone_number":{"type":"string","description":"The E.164 compliant phone number that will receive the call"},"contact_phone_number":{"type":"string","description":"The E.164 compliant phone number of the contact requesting the callback"},"context":{"type":"object","required":["fields"],"properties":{"fields":{"type":"array","description":"Context fields","items":{"type":"object","required":["name","display_name","tooltip_text","data_type","value"],"properties":{"name":{"type":"string","description":"Identifier for the field, in the scope of the entire context"},"display_name":{"type":"string","description":"The field name as it is shown to the user"},"tooltip_text":{"type":"string","description":"A tooltip regarding the field, shown to the user"},"data_type":{"type":"string","enum":["phone","text","url"],"description":"Data_type of an enumeration of possible values (these enums can imply validation of the 'value' field and detailed error responses will be provided for the fields we discard)"},"value":{"type":"string","description":"Field value"}}}}}}}}}}}}},"/contacts":{"get":{"summary":"Get contacts list","description":"The endpoint allows you to retrieve a list of contacts based on specific query parameters.\nThis endpoint provides a flexible and efficient way to retrieve contact information based on different criteria.\n","security":[{"GA":["contacts:read"]}],"parameters":[{"name":"ids","in":"query","description":"Filter by 'Contact IDs'.","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"maxItems":50}},{"name":"name","in":"query","description":"Filter by 'Contact full name'.","required":false,"schema":{"type":"string"}},{"name":"name.loose","in":"query","description":"Filter by 'Contact full name' (loose matching).","required":false,"schema":{"type":"string"}},{"name":"company","in":"query","description":"Filter by 'Contact company name'.","required":false,"schema":{"type":"string"}},{"name":"company.loose","in":"query","description":"Filter by 'Contact company name' (loose matching).","required":false,"schema":{"type":"string"}},{"name":"integration","in":"query","description":"Filter by 'Integration name and external id'. The format to use is: `integration_name:external_id` where:\n* `integration_name` is the integration name.\n* `external_id` is the contact identifier in the integration.\n\nExample: `salesforce:123`","required":false,"schema":{"type":"string"}},{"name":"emails","in":"query","description":"Filter by 'Contact emails'","required":false,"explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"phones","in":"query","description":"Filter by 'Contact phone numbers' in [E.164](https://en.wikipedia.org/wiki/E.164) format","required":false,"explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"page","in":"query","description":"Requested page number.","required":false,"schema":{"type":"integer","default":1,"minimum":1}},{"name":"per_page","in":"query","description":"Number of elements per page.","required":false,"schema":{"type":"integer","default":50,"minimum":1,"maximum":50}}],"tags":["Contacts"],"responses":{"200":{"description":"Get a contact response","content":{"application/json":{"schema":{"example":{"total":3,"_embedded":{"contacts":[{"id":"f68519eb9e5047b59dbf1c0e","name":"Daniel Craig","company":"Talkdesk","phones":[{"label":"Mobile","number":"+351987654321"},{"label":"Business","number":"+321212345678"}],"_links":{"self":{"href":"https://api.talkdeskapp.com/contacts/f68519eb9e5047b59dbf1c0e"},"integrations":{"href":"https://api.talkdeskapp.com/contacts/f68519eb9e5047b59dbf1c0e/integrations"}}}]},"count":1,"_links":{"self":{"href":"https://api.talkdeskapp.com/contacts?page=2&per_page=1"},"prev":{"href":"https://api.talkdeskapp.com/contacts?page=1&per_page=1"},"next":{"href":"https://api.talkdeskapp.com/contacts?page=3&per_page=1"}}},"type":"object","required":["total","_embedded","count","_links"],"properties":{"total":{"type":"integer"},"_embedded":{"type":"object","properties":{"contacts":{"type":"array","items":{"type":"object","required":["id","name","company","_links"],"properties":{"id":{"type":"string","description":"Contact ID"},"name":{"type":"string","description":"Contact name"},"company":{"type":"string","description":"Contact company"},"emails":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","description":"Email label"},"number":{"type":"string","description":"Email address"}}}},"phones":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","description":"Phone number label"},"number":{"type":"string","description":"Phone number in E.164 format"}}}},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","default":"https://api.talkdeskapp.com/contacts/:contact_id"}}},"integrations":{"type":"object","properties":{"href":{"type":"string","default":"https://api.talkdeskapp.com/contacts/:contact_id/integrations"}}}}}}}}}},"count":{"type":"integer"},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","default":"https://api.talkdeskapp.com/contacts?page=:page&per_page=:per_page"}}},"prev":{"type":"object","properties":{"href":{"type":"string","default":"https://api.talkdeskapp.com/contacts?page=:page&per_page=:per_page"}}},"next":{"type":"object","properties":{"href":{"type":"string","default":"https://api.talkdeskapp.com/contacts?page=:page&per_page=:per_page"}}}}}}}}}}}}},"/contacts/{contact_id}":{"get":{"summary":"Get a contact by id","description":"The endpoint allows you to retrieve a specific contact by providing its unique contact ID as a path parameter.\nThis endpoint provides a convenient way to fetch detailed information about a particular contact based on its ID.\n","security":[{"GA":["contacts:read"]}],"parameters":[{"name":"contact_id","in":"path","description":"The contact id","required":true,"schema":{"type":"string"}}],"tags":["Contacts"],"responses":{"200":{"description":"Get a contact response","content":{"application/json":{"schema":{"example":{"id":"f68519eb9e5047b59dbf1c0e","name":"Daniel Craig","company":"Talkdesk","phones":[{"label":"Mobile","number":"+351987654321"},{"label":"Business","number":"+321212345678"}],"_links":{"self":{"href":"https://api.talkdeskapp.com/contacts/f68519eb9e5047b59dbf1c0e"},"integrations":{"href":"https://api.talkdeskapp.com/contacts/f68519eb9e5047b59dbf1c0e/integrations"}}},"type":"object","properties":{"contact":{"type":"object","required":["id","name","company","_links"],"properties":{"id":{"type":"string","description":"Contact ID"},"name":{"type":"string","description":"Contact name"},"company":{"type":"string","description":"Contact company"},"emails":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","description":"Email label"},"number":{"type":"string","description":"Email address"}}}},"phones":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","description":"Phone number label"},"number":{"type":"string","description":"Phone number in E.164 format"}}}},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","default":"https://api.talkdeskapp.com/contacts/:contact_id"}}},"integrations":{"type":"object","properties":{"href":{"type":"string","default":"https://api.talkdeskapp.com/contacts/:contact_id/integrations"}}}}}}}}}}}},"404":{"description":"Contact not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0210001","message":"Contact not found"}}}}}},"delete":{"summary":"Delete a contact by id","security":[{"GA":["contacts:write"]}],"parameters":[{"name":"contact_id","in":"path","description":"The contact id","required":true,"schema":{"type":"string"}}],"tags":["Contacts"],"responses":{"204":{"description":"Deleted contact response"},"404":{"description":"Contact not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0210001","message":"Contact not found"}}}}}}},"/contacts/{contact_id}/integrations":{"get":{"summary":"Get a list of contact's integrations","security":[{"GA":["contacts-integrations:read"]}],"parameters":[{"name":"contact_id","in":"path","description":"The contact id","required":true,"schema":{"type":"string"}}],"tags":["Contacts"],"responses":{"200":{"description":"List of contact's integrations response","content":{"application/json":{"schema":{"example":{"_embedded":{"integrations":[{"integration_name":"salesforce","external_url":"https://na73.salesforce.com/0031I0XQWE08i4qmQAA"}]},"_links":{"self":{"href":"https://api.talkdeskapp.com/contacts/f68519eb9e5047b59dbf1c0e/integrations"}}},"type":"object","properties":{"_embedded":{"type":"object","properties":{"integrations":{"type":"array","description":"List of integrations where the contact is","required":["integration_name","external_url"],"properties":{"integration_name":{"type":"string","enum":["a1solar","ackcontact","autoreach","azorus","azorus-edgehilluniversity","azorus-universityofbradford","better","bigcommerce","contacts-generator","convoy","csv_loader","desk","dmopc","dynamics","eisintro","email","eventmobi","front","gcontacts","groove","healthjoy_dev","helpscout","helpscout_test","hexaware","highrise","http","infusionsoft","intercom","kustomer","livechat","medicarecompare","nimble","now-data-bridge","okta","olark","planetart","radiusbob","relateiq","rs-admin","salesforce","senior_market_advisors","servicenow","simplex","slack","snapengage","studentstay","sugarcrm","talkdesk","zendesk","zoho"]},"external_url":{"type":"string"}}}}},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","default":"https://api.talkdeskapp.com/contacts/:contact_id/integrations"}}}}}}}}}},"404":{"description":"Contact not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0210001","message":"Contact not found"}}}}}}},"/contacts/{contact_id}/custom-fields":{"get":{"summary":"Get a list of contact's custom fields","x-namespace":"/contacts","security":[{"EarlyAccess":["contacts-custom-fields:read"]}],"parameters":[{"name":"contact_id","in":"path","description":"The contact id","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","example":1,"minimum":1,"maximum":2147483647,"default":1}},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","example":5,"minimum":1,"maximum":50,"default":5}},{"name":"search","in":"query","schema":{"type":"string","x-search_operators":["or"],"x-search_fields":["key"]}}],"tags":["Contacts"],"responses":{"200":{"description":"List of contact's custom fields","content":{"application/json":{"schema":{"type":"object","required":["total","_embedded","count","_links"],"properties":{"total":{"type":"integer"},"_embedded":{"type":"object","properties":{"custom_fields":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}}}},"count":{"type":"integer"},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","default":"https://api.talkdeskapp.com/contacts/{contact_id}/custom-fields?page=:page&per_page=:per_page"}}},"prev":{"type":"object","properties":{"href":{"type":"string","default":"https://api.talkdeskapp.com/contacts/{contact_id}/custom-fields?page=:page&per_page=:per_page"}}},"next":{"type":"object","properties":{"href":{"type":"string","default":"https://api.talkdeskapp.com/contacts/{contact_id}/custom-fields?page=:page&per_page=:per_page"}}}}}}},"example":{"total":2,"count":2,"_embedded":{"custom_fields":[{"key":"cf001","value":"value for cf 01"},{"key":"cf002","value":"value for cf 02"}]},"_links":{"self":{"href":"http://api-docs.talkdesk.org/contacts/5ec68414dd99ad000bc48a45/custom-fields"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0210004","message":"Bad request"}}}},"401":{"description":"Unauthorized Error","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0210002","message":"Invalid JWT token"}}}},"403":{"description":"Forbidden Error","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0210003","message":"Required scopes are missing"}}}},"404":{"description":"Contact not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0210001","message":"Contact not found"}}}}}}},"/internal-contacts/gdpr":{"post":{"description":"GDPR contacts by dates, list of phones or emails, tags, or contact ids","security":[{"GA":["contact-gdpr:write"]}],"summary":"GDPR contacts by dates, list of phones or emails, tags, or contact ids","tags":["Contacts"],"requestBody":{"description":"The contact's search criteria","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"phones":{"type":"array","description":"Array of phone numbers","items":{"type":"string","minLength":1,"maxLength":32,"description":"Phone number"}},"emails":{"type":"array","description":"Array of emails","items":{"minLength":1,"maxLength":256,"type":"string","description":"Email"}},"ids":{"type":"array","description":"Array of contact ID's","items":{"minLength":1,"maxLength":256,"type":"string","description":"ID"}},"created_at":{"type":"object","description":"Created at criteria","properties":{"start_time":{"type":"string","minLength":1,"maxLength":256,"description":"Start time to search for contacts creation date"},"end_time":{"type":"string","minLength":1,"maxLength":256,"description":"End time to search for contacts creation date"}}},"tags":{"type":"array","description":"Array of tags","items":{"type":"string","minLength":1,"maxLength":256,"description":"tag"}},"reason":{"type":"string","description":"Reason for contact deletion","minLength":1,"maxLength":256,"enum":["rtbf","account_removal"],"default":"rtbf"}}},"examples":{"Example 0":{"value":{"phones":["+351919993322","351910009933"],"reason":"rtbf"}},"Example 1":{"value":{"emails":["test@talkdesk.com","test@mail.com"]}},"Example 2":{"value":{"ids":["t5da5c0e9a7fa0b00046033ed","3005c0e9a7fa0b000460aaaa"]}},"Example 3":{"value":{"created_at":{"start_date":"1980-01-01 00:00","end_date":"2024-01-28 23:59"}}},"Example 4":{"value":{"tags":["salesforce","zendesk"]}}}}}},"responses":{"204":{"description":"GDPR successful response"},"401":{"description":"Unauthorized Error","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0210002","message":"Unauthorized"}}}},"403":{"description":"Forbidden Error","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0210002","message":"Unauthorized"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0210003","message":"Required scopes are missing"}}}}}}},"/conversations/interactions":{"get":{"description":"Retrieves all interactions that started within a specified time range (up to a 7-day interval), filtered by the account ID contained in the JWT token. The result includes the interaction metadata and associated messages. Results are paginated using a cursor-based mechanism. The interaction_ended parameter refers to the end of the interaction start time range, not when the interaction itself ended. This endpoint only returns interactions that started between the interaction_started and interaction_ended timestamps.","security":[{"EarlyAccess":["interactions-public:read"]}],"summary":"Query interactions and their messages based from the provided interaction start date.","tags":["Conversations"],"operationId":"GetInteractions","parameters":[{"in":"query","name":"interaction_started","description":"The start of the time range. Only interactions that started after or at this timestamp will be included.","required":false,"schema":{"type":"string","format":"date-time","minLength":20,"example":"2023-06-16T00:00:02Z"}},{"in":"query","name":"interaction_ended","description":"The end of the time range. This refers to the end of the start time range — not when the interaction ended. Only interactions that started before or at this timestamp will be included.","required":false,"schema":{"type":"string","format":"date-time","minLength":20,"example":"2023-06-16T00:00:02Z"}},{"in":"query","name":"cursor","description":"The cursor to use for pagination.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved the interactions.","content":{"application/hal+json":{"schema":{"description":"Paginated response with interactions containing the matched time period.","type":"object","properties":{"_embedded":{"type":"object","description":"Embedded object of a paginated response.","properties":{"interactions":{"items":{"description":"The list of interactions that occurred in the date range search.","type":"object","properties":{"id":{"type":"string","description":"The ID of the interaction.","example":"597a2201-9d7e-470e-a699-abc5ec114973"},"customer_id":{"type":"string","description":"The ID of the customer.","example":"e7a89c2e-4257-4e38-81f1-854dd94d6574"},"started_at":{"type":"string","format":"date-time","description":"The datetime when the interaction started.","example":"2020-03-10T00:00:00.000000Z"},"ended_at":{"type":"string","format":"date-time","description":"The datetime when the interaction ended.","example":"2020-03-10T00:04:00.000000Z"},"direction":{"type":"string"},"ring_groups":{"type":"array","items":{"type":"string"},"description":"The ring groups of the user (agent)."},"messages":{"type":"array","items":{"description":"The list of messages in an interaction that corresponds to the search.","type":"object","properties":{"message_id":{"type":"string","description":"The original utterance ID."},"text":{"type":"string","description":"The text of the transcription message."},"channel":{"type":"string","description":"The channel that generated the message."},"participant":{"type":"string"},"sentiment":{"type":"string"},"intent":{"type":"string","description":"The intent associated to the message."},"intent_confidence_score":{"type":"number","format":"float","description":"The confidence score of the intent."},"intent_is_fallback":{"type":"boolean","description":"Determines if it is a fallback intent."},"start_time":{"type":"number","format":"float","description":"The time position in seconds where the message appears in audio."},"end_time":{"type":"number","format":"float","description":"the time position in seconds where the message stops in the audio."},"transcription_type":{"type":"string"},"source_system":{"type":"string","description":"System in which the message was generated in.","example":"STT"},"recording_id":{"type":"string","description":"Id that identifies the recording to which the message belongs. Only applicable to STT source_system."},"recording_index":{"type":"number","format":"integer","description":"Index that identifies the recording to which the message belongs. Only applicable to STT source_system."},"message_index":{"type":"number","format":"integer","description":"Index that identifies the message order within a interaction/recording."},"message_start_at":{"type":"string","format":"date-time","description":"The datetime when the message started.","example":"2020-03-10T00:00:00.000000Z"},"agent_id":{"type":"string","description":"The ID of the agent.","example":"2cfc7d5a-7e89-403d-b257-891247b88829"}},"required":["message_id","text","channel","participant","sentiment","start_time","end_time","source_system"]}},"agents":{"type":"array","items":{"description":"The list of agents that participated in the interaction.","type":"object","properties":{"id":{"type":"string","description":"The ID of the agent.","example":"2cfc7d5a-7e89-403d-b257-891247b88829"}},"required":["id"]}}},"required":["agents","customer_id","started_at","ended_at","direction","ring_groups","messages"]},"type":"array"}},"required":["interactions"]},"_links":{"type":"object","description":"The page links.","properties":{"next":{"description":"The link to the next page","type":"object","properties":{"href":{"description":"The hypertext reference describing this link.","example":"https://conversations.talkdesk.com/interactions?cursor=Zc2pJPVrJFeH0fGPjDanmw==","type":"string"}},"required":["href"]}}}},"required":["_embedded","_links"]},"example":{"_embedded":{"interactions":[{"id":"a45038e1-d2b7-4778-b8aa-157e31846e16","customer_id":"ba3166d1-3d01-4333-bdfa-58c238788267","started_at":"2020-03-30T00:00:00.000000Z","ended_at":"2020-03-30T00:08:00.000000Z","direction":"OUT","ring_groups":["billing","reporting"],"messages":[{"message_id":"c9d499a2-5033-43ed-9de6-63afddee4b30","text":"Sorry for the inconvenience sir. May I have your account number please?","channel":"VOICE","participant":"USER","sentiment":"POSITIVE","intent":"Apologize","intent_confidence_score":0.75,"intent_is_fallback":true,"start_time":30,"end_time":37,"transcription_type":"POST_CALL","source_system":"STT","recording_id":"f883958122244cbfb8ed5606e556a694","recording_index":0,"message_index":4,"message_start_at":"2020-03-30T00:00:30.000000Z","agent_id":"4c607db0-167c-410a-a825-92d5f4162961"}],"agents":[{"id":"4c607db0-167c-410a-a825-92d5f4162961"}]}]},"_links":{"next":{"href":"https://conversations.talkdesk.com/interactions?cursor=Zc2pJPVrJFeH0fGPjDanmw=="}}}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1904000","message":"Invalid query parameters. (Bad Request)"}}}},"401":{"description":"Unauthorized access, invalid or unverifiable JWT.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1904010","message":"The provided JWT is not valid. (Unauthenticated)"}}}},"403":{"description":"Forbidden access.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1904030","message":"The required scope is not present in the JWT. (Forbidden)"}}}},"500":{"description":"Unexpected error.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1905000","message":"An unexpected error has occurred. Contact Talkdesk Support."}}}}}}},"/do-not-call-lists/{id}/entries/{id_entry}":{"get":{"summary":"Get one entry from a do not call list","tags":["Do Not Call Lists"],"security":[{"EarlyAccess":["do-not-call-lists:read"]}],"parameters":[{"name":"id","in":"path","description":"The identifier of the do not call list.","required":true,"schema":{"type":"string"}},{"name":"id_entry","in":"path","description":"Entry id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Get a entry","content":{"application/hal+json":{"schema":{"example":{"id":"27b197c0-4a66-49e4-becb-50eff2be97b5","do_not_call_list_id":"594ba829-8b1c-4ec2-bfc5-d5a26bafdf1c","phone_number":"+351929312312","reason":"customer request","expiration_date":"2021-12-31","created_at":"2020-02-24T11:48:40.503Z","updated_at":"2020-02-24T11:48:40.503Z","_links":{"self":{"href":"https://api.talkdeskapp.com/do-not-call-lists/594ba829-8b1c-4ec2-bfc5-d5a26bafdf1c/entries/27b197c0-4a66-49e4-becb-50eff2be97b5"},"do_not_call_list":{"href":"https://api.talkdeskapp.com/do-not-call-lists/594ba829-8b1c-4ec2-bfc5-d5a26bafdf1c"}}},"type":"object","description":"Entry object","properties":{"id":{"type":"string","format":"uuid","description":"entry id"},"do_not_call_list_id":{"type":"string","format":"uuid","description":"Do not call list id"},"phone_number":{"type":"string","description":"phone number of the record"},"reason":{"type":"string","description":"reason for the phone number is being added to do not call list"},"expiration_date":{"type":"string","description":"date where the dncl entry expires"},"created_at":{"type":"string","description":"Record creation date"},"updated_at":{"type":"string","description":"Record updated date"},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string"}}}}}}}}}},"401":{"description":"Unauthorized","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0531501","message":"Missing or invalid authentication token."}}}},"403":{"description":"Forbidden","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0531502","message":"Insufficient scopes for the requested operation."}}}},"404":{"description":"Entry not found","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0531520","message":"Entry not found."}}}}}},"patch":{"summary":"Update one entry inside a do not call list","tags":["Do Not Call Lists"],"security":[{"EarlyAccess":["do-not-call-lists:manage"]}],"parameters":[{"name":"id","in":"path","description":"The identifier of the do not call list.","required":true,"schema":{"type":"string"}},{"name":"id_entry","in":"path","description":"Entry id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Update expirationDate of entry","required":true,"content":{"application/json-patch+json":{"schema":{"type":"array","items":{"type":"object","required":["op","path"],"properties":{"op":{"type":"string","description":"Operation to perform on path."},"path":{"type":"string","description":"Path to perform operation."},"value":{"type":"string","description":"New value of path, if operation is replace."}}}},"example":[{"op":"replace","path":"/expiration_date","value":"2022-11-30"}]}}},"responses":{"200":{"description":"Entry updated","content":{"application/hal+json":{"schema":{"type":"object","description":"Entry object","properties":{"id":{"type":"string","format":"uuid","description":"entry id"},"do_not_call_list_id":{"type":"string","format":"uuid","description":"Do not call list id"},"phone_number":{"type":"string","description":"phone number of the record"},"reason":{"type":"string","description":"reason for the phone number is being added to do not call list"},"expiration_date":{"type":"string","description":"date where the dncl entry expires"},"created_at":{"type":"string","description":"Record creation date"},"updated_at":{"type":"string","description":"Record updated date"},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string"}}}}}}},"example":{"id":"27b197c0-4a66-49e4-becb-50eff2be97b5","do_not_call_list_id":"594ba829-8b1c-4ec2-bfc5-d5a26bafdf1c","phone_number":"+351929312312","reason":"customer request","expiration_date":"2021-12-31","created_at":"2020-02-24T11:48:40.503Z","updated_at":"2020-02-24T11:48:40.503Z","_links":{"self":{"href":"https://api.talkdeskapp.com/do-not-call-lists/594ba829-8b1c-4ec2-bfc5-d5a26bafdf1c/entries/27b197c0-4a66-49e4-becb-50eff2be97b5"},"do_not_call_list":{"href":"https://api.talkdeskapp.com/do-not-call-lists/594ba829-8b1c-4ec2-bfc5-d5a26bafdf1c"}}}}}},"400":{"description":"Errors were found in the submitted data","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0531500","message":"Errors were found in the submitted data."}}}},"401":{"description":"Unauthorized","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0531501","message":"Missing or invalid authentication token."}}}},"403":{"description":"Forbidden","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0531502","message":"Insufficient scopes for the requested operation."}}}},"404":{"description":"Entry not found","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0531520","message":"Entry not found."}}}},"422":{"description":"Unprocessable Entity","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0531505","message":"Resource is not available for this operation."}}}}}},"delete":{"summary":"Delete one entry from a do not call list","tags":["Do Not Call Lists"],"security":[{"EarlyAccess":["do-not-call-lists:manage","role-permissions:skip"]}],"parameters":[{"name":"id","in":"path","description":"The identifier of the do not call list.","required":true,"schema":{"type":"string"}},{"name":"id_entry","in":"path","description":"Entry id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Entry deleted"},"401":{"description":"Unauthorized","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0531501","message":"Missing or invalid authentication token."}}}},"403":{"description":"Forbidden","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0531502","message":"Insufficient scopes for the requested operation."}}}},"404":{"description":"Entry not found","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0531520","message":"Entry not found."}}}}}}},"/do-not-call-lists/{id}/entries":{"get":{"summary":"Get all entries from a do not call list","tags":["Do Not Call Lists"],"security":[{"EarlyAccess":["do-not-call-lists:manage"]}],"parameters":[{"name":"id","in":"path","description":"The identifier of the do not call list.","required":true,"schema":{"type":"string"}},{"name":"phone_number","in":"query","description":"Filter Entries by phone number","schema":{"type":"string"}},{"name":"page","in":"query","description":"number of the page listed","schema":{"type":"integer"}},{"name":"per_page","in":"query","description":"Number of max items per page","schema":{"type":"integer"}},{"name":"order_by","in":"query","description":"Order by Entries for expiration date, created_at, updated_at","schema":{"example":"expiration_date:desc,created_at:desc,updated_at:asc","default":"created_at:desc","x-sorting_default_order":"asc","x-sorting_fields":["expiration_date","created_at","updated_at"],"type":"string"}}],"responses":{"200":{"description":"Get a list of entries","content":{"application/hal+json":{"schema":{"example":{"page":2,"total_pages":3,"per_page":1,"total":3,"count":1,"_links":{"self":{"href":"https://api.talkdeskapp.com/do-not-call-lists/594ba829-8b1c-4ec2-bfc5-d5a26bafdf1c/entries?page=2&per_page=1"},"next":{"href":"https://api.talkdeskapp.com/do-not-call-lists/594ba829-8b1c-4ec2-bfc5-d5a26bafdf1c/entries?page=3&per_page=1"},"prev":{"href":"https://api.talkdeskapp.com/do-not-call-lists/594ba829-8b1c-4ec2-bfc5-d5a26bafdf1c/entries?page=1&per_page=1"},"first":{"href":"https://api.talkdeskapp.com/do-not-call-lists/594ba829-8b1c-4ec2-bfc5-d5a26bafdf1c/entries?page=1&per_page=1"},"last":{"href":"https://api.talkdeskapp.com/do-not-call-lists/594ba829-8b1c-4ec2-bfc5-d5a26bafdf1c/entries?page=3&per_page=1"}},"_embedded":{"entries":[{"id":"27b197c0-4a66-49e4-becb-50eff2be97b5","do_not_call_list_id":"594ba829-8b1c-4ec2-bfc5-d5a26bafdf1c","phone_number":"+351929312312","reason":"customer request","expiration_date":"2021-12-31","created_at":"2020-03-24T11:48:40.503Z","updated_at":"2020-03-24T11:48:40.503Z","_links":{"self":{"href":"https://api.talkdeskapp.com/do-not-call-lists/594ba829-8b1c-4ec2-bfc5-d5a26bafdf1c/entries/27b197c0-4a66-49e4-becb-50eff2be97b5"},"do-not-call-list":{"href":"https://api.talkdeskapp.com/do-not-call-lists/594ba829-8b1c-4ec2-bfc5-d5a26bafdf1c"}}}]}},"description":"List with the paginated samples","properties":{"per_page":{"description":"The number of items per page","type":"integer"},"total":{"description":"The total number of items.","type":"integer"},"count":{"description":"The number of items in the page","type":"integer"},"page":{"description":"The number of the current page","type":"integer"},"total_pages":{"description":"The total number of pages","type":"integer"},"_links":{"description":"HAL API related links.","type":"object","properties":{"href":{"description":"Address of the resource","type":"string"}}},"_embedded":{"properties":{"entries":{"description":"List of entries paginated.","items":{"description":"Record HAL object.","readOnly":true,"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"entry id"},"do_not_call_list_id":{"type":"string","format":"uuid","description":"Do not call list id"},"phone_number":{"type":"string","description":"phone number of the record"},"reason":{"type":"string","description":"reason for the phone number is being added to do not call list"},"expiration_date":{"type":"string","description":"date where the dncl entry expires"},"created_at":{"type":"string","description":"Record creation date"},"updated_at":{"type":"string","description":"Record updated date"},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string"}}}}}}},"type":"array"}},"type":"object"}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0531501","message":"Missing or invalid authentication token."}}}},"403":{"description":"Forbidden","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0531502","message":"Insufficient scopes for the requested operation."}}}},"404":{"description":"Do not call list not found","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0531510","message":"Do Not Call List not found."}}}}}},"post":{"summary":"Creates an entry","tags":["Do Not Call Lists"],"description":"Creates an entry in the do not call list","security":[{"EarlyAccess":["do-not-call-lists:manage"]}],"parameters":[{"name":"id","in":"path","description":"The identifier of the do not call list","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"parameters needed to create a Entry","required":true,"content":{"application/hal+json":{"schema":{"example":{"phone_number":"+351929312312","expiration_date":"2021-12-31","reason":"custom request"},"type":"object","description":"Record object","required":["phone_number"],"properties":{"phone_number":{"type":"string","description":"phone number of the entry"},"expiration_date":{"type":"string","description":"date where the dncl entry expires"}}}}}},"responses":{"201":{"description":"Entry created","content":{"application/hal+json":{"schema":{"example":{"id":"27b197c0-4a66-49e4-becb-50eff2be97b5","do_not_call_list_id":"594ba829-8b1c-4ec2-bfc5-d5a26bafdf1c","phone_number":"+351929312312","reason":"customer request","expiration_date":"2021-12-31","created_at":"2020-02-24T11:48:40.503Z","updated_at":"2020-02-24T11:48:40.503Z","_links":{"self":{"href":"https://api.talkdeskapp.com/do-not-call-lists/594ba829-8b1c-4ec2-bfc5-d5a26bafdf1c/entries/27b197c0-4a66-49e4-becb-50eff2be97b5"},"do_not_call_list":{"href":"https://api.talkdeskapp.com/do-not-call-lists/594ba829-8b1c-4ec2-bfc5-d5a26bafdf1c"}}},"type":"object","description":"Entry object","properties":{"id":{"type":"string","format":"uuid","description":"entry id"},"do_not_call_list_id":{"type":"string","format":"uuid","description":"Do not call list id"},"phone_number":{"type":"string","description":"phone number of the record"},"reason":{"type":"string","description":"reason for the phone number is being added to do not call list"},"expiration_date":{"type":"string","description":"date where the dncl entry expires"},"created_at":{"type":"string","description":"Record creation date"},"updated_at":{"type":"string","description":"Record updated date"},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string"}}}}}}}}}},"400":{"description":"Errors were found in the submitted data","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0531500","message":"Errors were found in the submitted data."}}}},"401":{"description":"Unauthorized","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0531501","message":"Missing or invalid authentication token."}}}},"403":{"description":"Forbidden","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0531502","message":"Insufficient scopes for the requested operation."}}}},"404":{"description":"Do not call list not found","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0531510","message":"Do Not Call List not found."}}}}}},"patch":{"summary":"Update multiple entries inside a do not call list","tags":["Do Not Call Lists"],"description":"Update multiple entries inside a do not call list","security":[{"EarlyAccess":["do-not-call-lists:manage"]}],"parameters":[{"name":"id","in":"path","description":"The identifier of the do not call list.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"An array of parameters needed to update multiple entries","required":true,"content":{"application/hal+json":{"schema":{"type":"array","items":{"type":"object","required":["op","path"],"properties":{"op":{"type":"string","description":"Operation to perform on path."},"path":{"type":"string","description":"Path to perform operation."},"value":{"type":"string","description":"New value of path, if operation is replace."}}}},"example":[{"op":"replace","path":"/c45f361f-2944-4844-8a21-dbfe7b000b2a/expiration_date","value":"2022-12-01"},{"op":"replace","path":"/c45f361f-2944-4844-8a21-dbfe7b000b2b/expiration_date","value":"2022-12-15"},{"op":"replace","path":"/c45f361f-2944-4844-8a21-dbfe7b000b2c/expiration_date","value":"2022-12-30"}]}}},"responses":{"200":{"description":"Multiple entries updated","content":{"application/hal+json":{"schema":{"type":"object","description":"Response for multiple entries updated","properties":{"do_not_call_list_id":{"type":"string","description":"Do not call list id"},"has_errors":{"type":"boolean","description":"True if entries updated has errors"},"total_errors":{"type":"integer","description":"Total number of errors found in the multiple entries updated","minimum":0,"maximum":100},"total_updated":{"type":"integer","description":"Total number of entries updated in multiple entries request","minimum":0,"maximum":100},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string"}}},"do_not_call_list":{"type":"object","properties":{"href":{"type":"string"}}}}},"_embedded":{"type":"object","description":"List of entries resulted from updates.","properties":{"entries":{"type":"array","description":"Array of entries","items":{"type":"object","description":"Entry is completed with details if it was updated or is annotated with errors otherwise.","properties":{"id":{"type":"string","description":"Entry id"},"do_not_call_list_id":{"type":"string","description":"Do not call list id"},"phone_number":{"type":"string","description":"Phone number of the Entry"},"reason":{"type":"string","description":"Reason for the phone number is being added to do not call list"},"expiration_date":{"type":"string","description":"Date where the dncl entry expires"},"created_at":{"type":"string","description":"Entry creation date"},"updated_at":{"type":"string","description":"Entry updated date"},"errors":{"type":"array","items":{"type":"string","description":"Entry errors","enum":["EXPIRATION_DATE_INVALID","ENTRY_NOT_FOUND"]}},"un_allowed_patch":{"type":"object","properties":{"op":{"type":"string"},"path":{"type":"string"},"value":{"type":"string"}}},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string"}}},"do_not_call_list":{"type":"object","properties":{"href":{"type":"string"}}}}}}}}}}}},"examples":{"Entries without errors":{"value":{"do_not_call_list_id":"b3eb858c-e880-4938-bba3-bd5b733dd9b5","has_errors":false,"total_errors":0,"total_updated":2,"_links":{"self":{"href":"https://api.talkdeskapp.com/do-not-call-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5/entries?per_page=100&page=1"},"do_not_call_list":{"href":"https://api.talkdeskapp.com/do-not-call-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5"}},"_embedded":{"entries":[{"id":"c45f361f-2944-4844-8a21-dbfe7b000b1c","do_not_call_list_id":"b3eb858c-e880-4938-bba3-bd5b733dd9b5","phone_number":"+351929312312","reason":"custom request","expiration_date":"2021-12-31","created_at":"2021-11-24T11:48:40.503Z","updated_at":"2021-11-24T11:48:40.503Z","_links":{"self":{"href":"https://api.talkdeskapp.com/do-not-call-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5/entries/c45f361f-2944-4844-8a21-dbfe7b000b1c"},"do_not_call_list":{"href":"https://api.talkdeskapp.com/do-not-call-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5"}}},{"id":"c45f361f-2944-4844-8a21-dbfe7b000b1b","do_not_call_list_id":"b3eb858c-e880-4938-bba3-bd5b733dd9b5","phone_number":"+351929312313","reason":"custom request","expiration_date":"2021-12-31","created_at":"2021-11-24T11:48:40.503Z","updated_at":"2021-11-24T11:48:40.503Z","_links":{"self":{"href":"https://api.talkdeskapp.com/do-not-call-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5/entries/c45f361f-2944-4844-8a21-dbfe7b000b1b"},"do_not_call_list":{"href":"https://api.talkdeskapp.com/do-not-call-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5"}}}]}}},"Entries with errors":{"value":{"do_not_call_list_id":"b3eb858c-e880-4938-bba3-bd5b733dd9b5","has_errors":true,"total_errors":2,"total_updated":1,"_links":{"self":{"href":"https://api.talkdeskapp.com/do-not-call-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5/entries?per_page=100&page=1"},"do_not_call_list":{"href":"https://api.talkdeskapp.com/do-not-call-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5"}},"_embedded":{"entries":[{"id":"c45f361f-2944-4844-8a21-dbfe7b000b1c","do_not_call_list_id":"b3eb858c-e880-4938-bba3-bd5b733dd9b5","phone_number":"+351929312312","reason":"custom request","expiration_date":"2021-12-31","created_at":"2021-11-24T11:48:40.503Z","updated_at":"2021-11-24T11:48:40.503Z","_links":{"self":{"href":"https://api.talkdeskapp.com/do-not-call-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5/entries/c45f361f-2944-4844-8a21-dbfe7b000b1c"},"do_not_call_list":{"href":"https://api.talkdeskapp.com/do-not-call-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5"}}},{"id":"c45f361f-2944-4844-8a21-dbfe7b000b2c","errors":["EXPIRATION_DATE_INVALID","ENTRY_NOT_FOUND"]},{"un_allowed_patch":{"op":"add","path":"/c45f361f-2944-4844-8a21-dbfe7b000b2a/expiration_date","value":"2022-12-01"}}]}}}}}}},"400":{"description":"Errors were found in the submitted data","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0531500","message":"Errors were found in the submitted data."}}}},"401":{"description":"Unauthorized","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0531501","message":"Missing or invalid authentication token."}}}},"403":{"description":"Forbidden","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0531502","message":"Insufficient scopes for the requested operation."}}}},"404":{"description":"Do not call list not found","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0531510","message":"Do Not Call List not found."}}}},"413":{"description":"Payload too large","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0531508","message":"Exceeded limit of entries to update."}}}},"422":{"description":"Unprocessable Entities","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0531505","message":"Resource is not available for this operation."}}}}}},"delete":{"summary":"Bulk delete entries","description":"Bulk delete entries","x-namespace":"/do-not-call-lists","tags":["Do Not Call Lists"],"security":[{"EarlyAccess":["do-not-call-lists:manage","role-permissions:skip"]}],"parameters":[{"name":"id","in":"path","description":"The identifier of the do not call list.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"An array of parameters needed to delete multiple Records.","required":true,"content":{"application/hal+json":{"schema":{"type":"array","description":"entry ids.","minItems":1,"maxItems":200,"items":{"type":"object","required":["id"],"properties":{"id":{"type":"string","maxLength":36}}}},"examples":{"Example 1":{"value":[{"id":"8858c834-481d-4a02-8176-cffc02c50350"},{"id":"f03004be-2853-4660-b6e8-060cc383ddbe"},{"id":"ba85ef13-ed0c-4acc-8799-4b2e81e91dcb"}]}}}}},"responses":{"200":{"description":"Get a list of entries","content":{"application/hal+json":{"schema":{"description":"Bulk deleted entries response samples.","type":"object","required":["id","has_errors","total_errors","total_deleted"],"properties":{"id":{"description":"The id of do not call list.","type":"string","minLength":1},"has_errors":{"type":"boolean","description":"True if entries deleted has errors."},"total_errors":{"type":"integer","description":"The number of the total errors.","minimum":0,"maximum":100},"total_deleted":{"type":"integer","description":"The total number of deleted.","minimum":0,"maximum":100},"_links":{"type":"object","description":"HAL API related links.","required":["self"],"properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}},"description":"The records page link."},"do_not_call_list":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}},"description":"The do-not-call-lists page link."}}},"_embedded":{"type":"object","required":["failed_records"],"properties":{"failed_records":{"description":"The number of records that failed to delete.","type":"array","items":{"type":"object","description":"Failed Entries HAL object.","required":["id"],"properties":{"id":{"type":"string","description":"Entry id"},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}}}}}}}}}}},"example":{"id":"b3eb858c-e880-4938-bba3-bd5b733dd9b5","has_errors":true,"total_errors":1,"total_deleted":2,"_links":{"self":{"href":"https://api.talkdeskapp.com/do-not-call-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5/records"},"do_not_call_list":{"href":"https://api.talkdeskapp.com/do-not-call-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5"}},"_embedded":{"failed_entries":[{"id":"e524ee5d-4c95-4d08-8e30-13b2111740f3","_links":{"self":{"href":"https://api.talkdeskapp.com/do-not-call-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5/records"}}}],"reason":{"bad_request_param":["b3eb858c-e880-4938-bba3-bd5b733dd9b5"],"record_not_found":["b3eb858c-e880-4938-bba3-bd5b733dd9b5"]}}}}}},"400":{"description":"Errors were found in the submitted data","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0531500","message":"Errors were found in the submitted data."}}}},"401":{"description":"Unauthorized","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0531501","message":"Missing or invalid authentication token."}}}},"403":{"description":"Forbidden","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0531502","message":"Insufficient scopes for the requested operation."}}}},"404":{"description":"Do not call list not found","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0531510","message":"Do Not Call List not found."}}}}}}},"/events/signature-keys/{key_id}":{"get":{"description":"Get public key used to validate events-api requests signature","parameters":[{"name":"key_id","in":"path","description":"The public key id. You can use latest, to retrieve the latest public key available","required":true,"schema":{"type":"string"}}],"tags":["Events"],"responses":{"200":{"description":"Public key and public key id","content":{"application/json":{"schema":{"example":{"public_key":"public_key","public_key_id":"key_id","created_at":"2017-07-21T17:32:28Z","expires_at":"2017-07-25T17:32:28Z"},"type":"object","required":["public_key","key_id","created_at"],"properties":{"public_key":{"type":"string","description":"The public key used to validate events-api request signature"},"key_id":{"type":"string","description":"The public key id"},"created_at":{"type":"string","format":"datetime","description":"Creation date of the key"},"expires_at":{"type":"string","format":"datetime","description":"Expiration date of the day"}}}}}},"404":{"description":"Key not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0080021","message":"Signature key not found"}}}}}}},"/external-credentials/certs":{"get":{"summary":"List public certificates (JWKs)","description":"Public endpoint that returns JSON Web Keys (JWKs). Certificates can optionally be filtered by one or more tags.\n","operationId":"external-credentials-get-certificates","tags":["External Credentials"],"parameters":[{"name":"tag","in":"query","required":true,"description":"Tags used to filter certificates","schema":{"type":"array","items":{"type":"string","minLength":1,"maxLength":100}},"style":"form","explode":true,"example":["epic","foo","bar"]}],"responses":{"200":{"description":"Certificates retrieved successfully.","content":{"application/json":{"schema":{"type":"object","description":"Response containing a list of public JWK certificates","required":["keys"],"properties":{"keys":{"type":"array","description":"The value of the \"keys\" parameter is an array of JWK values","items":{"type":"object","description":"JSON Web Key representation with metadata","required":["kty","use","kid","alg"],"properties":{"kty":{"type":"string","description":"The key type parameter identifies the cryptographic algorithm family used with the key, such as RSA or EC","example":"RSA","maxLength":1024,"minLength":1},"use":{"type":"string","description":"The use (public key use) parameter identifies the intended use of the public key","example":"sig","maxLength":1024,"minLength":1},"kid":{"type":"string","description":"Key identifier, is used to match a specific key.","example":"rsa-key-1","maxLength":255,"minLength":1},"alg":{"type":"string","description":"The algorithm parameter identifies the algorithm intended for use with the key","maxLength":10,"minLength":1},"n":{"type":"string","description":"RSA modulus value (Base64URL encoded)","example":"sXchd2FfY2xZb2FvQ0JrZk9kZ3l5Q1J0c1hYQk9xZzFqZk1h...","maxLength":1024,"minLength":1},"e":{"type":"string","description":"RSA public exponent value (Base64URL encoded)","example":"AQAB","maxLength":1024,"minLength":1},"tag":{"type":"string","description":"Tag associated with the certificate","example":"epic","maxLength":1024,"minLength":1}}}}}},"examples":{"public_rsa_jwk_response":{"summary":"Public RSA JWK Set response aligned with specification","value":{"keys":[{"tag":"epic","kid":"rsa-key-1","kty":"RSA","use":"sig","alg":"RS256","n":"sXch9Y8pJ7KJq9F7uVb8xY1X0qQ5bFjZ9N6Q2u8YJ3aYdQXo8l7dC1gVj5xS3o9T","e":"AQAB"},{"tag":"foo","kid":"rsa-key-2","kty":"RSA","use":"sig","alg":"RS256","n":"oahUIoWw0K9P5Q6nJ1d8R0S4vU2c7Q3wX4t1Z9a6B2f3G5h7J8K1L2M3N4O5P6Q7","e":"AQAB"}]}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1000","message":"Invalid input parameters"}}}}}},"options":{"summary":"Get options for the certificates endpoint","description":"Returns the allowed HTTP methods for this endpoint.","operationId":"external-credentials-options-certificates","tags":["External Credentials"],"responses":{"204":{"description":"OK","headers":{"Allow":{"schema":{"type":"string","example":"GET, OPTIONS"}}}}}}},"/fallback-experience":{"get":{"summary":"Get account information regarding continuity settings activation","description":"Retrieves fallback experience state, enabled or disabled.","x-namespace":"/fallback-experience","security":[{"GA":["continuity-settings-activation:read"]}],"tags":["Fallback Experience"],"responses":{"200":{"description":"The current settings","content":{"application/json":{"schema":{"type":"object","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"the state of the continuity settings"}}},"example":{"enabled":true}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0160004","message":"Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0160003","message":"Forbidden."}}}}}},"put":{"description":"Enables or disables fallback experience. If enabled new inbound calls are forwarded based on the fallback experience settings.","parameters":[],"x-namespace":"/fallback-experience","security":[{"GA":["continuity-settings-activation:write"]}],"tags":["Fallback Experience"],"responses":{"200":{"description":"State of the continuity settings","content":{"application/json":{"example":{"type":"object","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"the state of the continuity settings"}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0160002","message":"Invalid JSON in request body."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0160004","message":"Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0160003","message":"Forbidden."}}}}},"requestBody":{"description":"The body of the continuity settings activation request","content":{"application/json":{"schema":{"type":"object","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"the state of the continuity settings"}}}}}}}},"/fallback-experience/settings":{"get":{"tags":["Fallback Experience"],"summary":"Retrieves fallback experience settings.","description":"Retrieves fallback experience settings, forward configuration and message to play.","operationId":"getFallbackExperienceSettings","security":[{"GA":["continuity-settings:read"]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"example":{"forward":{"+123123456789":"+987987654321","default":"+456456123789"},"message":{"downtime_message":"Please try again later","language":"en-US"}},"type":"object","additionalProperties":false,"properties":{"forward":{"type":"object"},"message":{"type":"object"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0160003","message":"Forbidden."}}}},"500":{"description":"Internal Error","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0160001","message":"An error has occurred, please contact Talkdesk support."}}}}}},"put":{"tags":["Fallback Experience"],"summary":"Sets fallback experience configuration.","description":"Sets fallback experience configuration, forward configuration and message to play.","operationId":"putFallbackExperienceSettings","security":[{"GA":["continuity-settings:write"]}],"parameters":[],"responses":{"200":{"description":"Fallback Experience Settings","content":{"application/json":{"schema":{"example":{"forward":{"+123123456789":"+987987654321","default":"+456456123789"},"message":{"downtime_message":"Please try again later","language":"en-US"}},"type":"object","additionalProperties":false,"properties":{"forward":{"type":"object"},"message":{"type":"object"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0160002","message":"Invalid JSON in request body."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0160003","message":"Forbidden."}}}},"500":{"description":"Internal Error","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0160001","message":"An error has occurred, please contact Talkdesk support."}}}}},"requestBody":{"description":"Fallback Experience Settings","required":true,"content":{"application/json":{"schema":{"example":{"forward":{"+123123456789":"+987987654321","default":"+456456123789"},"message":{"downtime_message":"Please try again later","language":"en-US"}},"type":"object","additionalProperties":false,"properties":{"forward":{"type":"object"},"message":{"type":"object"}}}}}}}},"/flows/{flow_id}/interactions":{"post":{"description":"Starts an interaction that executes the published version of the flow","security":[{"GA":["flows-interactions:start"]}],"tags":["Flows"],"parameters":[{"name":"flow_id","in":"path","description":"The identifier of the flow","required":true,"schema":{"type":"string"}}],"responses":{"202":{"description":"Flow interaction started result","content":{"application/json":{"schema":{"type":"object","required":["interaction_id","flow_version_id","flow_execution_id"],"properties":{"interaction_id":{"type":"string","description":"The identifier of the interaction that started based the provided flow."},"flow_version_id":{"type":"string","description":"The identifier of the flow version of the interaction that started."},"flow_execution_id":{"type":"string","description":"The ID of the Flow Execution that was started."}}},"example":{"interaction_id":"4c47a224077e1ef73d320i3234b1c7dd","flow_execution_id":"322fd317a8434e1686578e22201213a1","flow_version_id":"40773234b1c7dde1ef73d320i4c47a22"}}}},"400":{"description":"Invalid json","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0090001","message":"Invalid json"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0011003","message":"Not authorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0090011","message":"Forbidden"}}}},"404":{"description":"Flow not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0091001","message":"Flow not found"}}}},"413":{"description":"Request too large","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0090047","message":"Request too large. The maximum allowed size is 64KB."}}}},"415":{"description":"Unsupported media type","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0090046","message":"Unsupported media type"}}}}},"requestBody":{"description":"Arguments that are passed as input to the first flow step","content":{"application/json":{"schema":{"type":"object","description":"Dynamic map that will be provided to start an interaction associated with a flow."},"example":{"order_id":"34e1686578e222048f4rhe06dcdf517a84"}}}}}},"/flows-platform/flows/{flow_id}/trigger":{"post":{"description":"Trigger an automation flow on-demand","security":[{"EarlyAccess":["flows-platform:submit"]}],"parameters":[{"name":"flow_id","in":"path","required":true,"description":"flow id","schema":{"type":"string","minLength":1}}],"tags":["Flows Platform"],"requestBody":{"description":"Request body containing the inputs object","required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"inputs":{"type":"object","description":"This is a combination of key-value pairs of any type variable that is provided by user to be used within the automation flow"}}},"example":{"inputs":{"variable1":"value1","variable2":true}}}}},"responses":{"202":{"description":"Executed Successfully","content":{"application/json":{"schema":{"type":"object","description":"Response from triggering an automation flow on-demand","required":["execution_id","workflow_execution_id"],"properties":{"execution_id":{"type":"string","description":"Execution Id"},"workflow_execution_id":{"type":"string","description":"Workflow execution Id"}}},"example":{"execution_id":"695168308bcc1f00868fbbee","workflow_execution_id":"044ab68a-f09e-4361-88f2-b8b1eb5b1579"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0090001","message":"A bad request was given"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0090002","message":"An invalid JWT token was received"}}}},"403":{"description":"Forbidden Error","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0090003","message":"Forbidden access."}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0090004","message":"Flow not found"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0090005","message":"Operation is not possible on a disabled flow"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0090006","message":"An unexpected error occurred."}}}}}}},"/guardian/logs/sessions":{"get":{"description":"Returns a list of session logs.","operationId":"LogsResource_getSessionsOdata","parameters":[{"name":"filter","in":"query","description":"Allows filtering by using comparison and logical operators.

\n
  • To search parts of a string within a field of type string then the contains operator should be used.
    \n The syntax is the following: contains(field, 'value')
    • \n
    \n Logical operators are and and or.
    \n When using multiple ANDs and ORs, you should use parentheses to explicitly define the logical operators evaluation order.
    \n (note: this is recommended because the usual precedence rules aren't supported due to an implementation detail).

    \n Examples:\n \n More information here","required":true,"schema":{"type":"string","x-operators":["eq","ne","gt","ge","lt","le","and","or","not","( )","contains"]},"example":"(login_timestamp ge '2020-12-18T13:09:09.417Z' and login_timestamp le '2020-12-18T13:09:09.417Z')"},{"name":"order_by","in":"query","description":"Sorts by the indicated field in the specified direction, ascending or descending.\n The expression format may contain the suffix asc or desc separated from the property name with a colon in between.
    \n Examples:\n More information here","schema":{"type":"string","default":"id:asc","x-sorting_default_order":"asc","x-sorting_fields":["login_timestamp","logout_timestamp","user_id","country","id"]},"example":"login_timestamp:desc"},{"name":"page","in":"query","schema":{"format":"int32","type":"integer","default":1,"minimum":1,"example":10,"maximum":2147483647}},{"name":"per_page","in":"query","schema":{"format":"int32","default":20,"minimum":1,"maximum":250,"type":"integer"},"example":40}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"_embedded":{"items":{"properties":{"browser_full":{"description":"The agent browser name and version","example":"Chrome 15.05","type":"string"},"country":{"description":"The country associated with the log.","example":"United States","type":"string"},"ip_address":{"description":"The user's IP.","example":"192.22.1.22","type":"string"},"latitude":{"description":"The latitude of the session.","example":1.1,"format":"float","type":"number"},"login_timestamp":{"description":"The timestamp of the session.","example":"2020-02-01T10:00:00.000Z","type":"string"},"logout_timestamp":{"description":"The timestamp of the session.","example":"2020-02-01T10:00:00.000Z","type":"string"},"longitude":{"description":"The longitude of the session.","example":1.1,"format":"float","type":"number"},"os_full":{"description":"The agent operative system name and version.","example":"Mac OS X 10.15","type":"string"},"id":{"description":"The ID of the session.","example":"669d1b6a-54dd-4e73-b219-e48a56109cc5","type":"string"},"sso":{"description":"The Single Sign-On used by the agent","example":"google","type":"string"},"user_id":{"description":"The user id.","example":"669d7b6a-54dd-4e73-b219-e48a56109cc5","type":"string"},"support_access":{"description":"Either the session was accessed with support access.","example":false,"type":"boolean"}},"type":"object","required":["user_id","country","logout_timestamp","login_timestamp","id"]},"type":"array"},"_links":{"properties":{"first":{"allOf":[{"description":"Hal link","properties":{"href":{"description":"The hypertext reference describing this link.","example":"schema://host:port/log/sessions?page=1&per_page=10","type":"string"}},"type":"object","required":["href"]},{"description":"The first page link."}]},"last":{"allOf":[{"description":"Hal link","properties":{"href":{"description":"The hypertext reference describing this link.","example":"schema://host:port/log/sessions?page=1&per_page=10","type":"string"}},"type":"object","required":["href"]},{"description":"The last page link."}]},"next":{"allOf":[{"description":"Hal link","properties":{"href":{"description":"The hypertext reference describing this link.","example":"schema://host:port/log/sessions?page=1&per_page=10","type":"string"}},"type":"object","required":["href"]},{"description":"The next page link."}]},"prev":{"allOf":[{"description":"Hal link","properties":{"href":{"description":"The hypertext reference describing this link.","example":"schema://host:port/log/sessions?page=1&per_page=10","type":"string"}},"type":"object","required":["href"]},{"description":"The previous page link."}]},"self":{"allOf":[{"description":"Hal link","properties":{"href":{"description":"The hypertext reference describing this link.","example":"schema://host:port/log/sessions?page=1&per_page=10","type":"string"}},"type":"object","required":["href"]},{"description":"The current page link."}]},"show":{"allOf":[{"description":"Hal link","properties":{"href":{"description":"The hypertext reference describing this link.","example":"schema://host:port/log/sessions?page=1&per_page=10","type":"string"}},"type":"object","required":["href"]},{"description":"Show sessions link."}]}},"type":"object","required":["self","next","prev","first","last"]},"count":{"description":"The number of results in the current page.","example":10,"format":"int32","type":"integer"},"page":{"description":"The current page.","example":1,"format":"int32","type":"integer"},"per_page":{"description":"The number of results per page.","example":10,"format":"int32","type":"integer"},"total":{"description":"The total number of results.","example":10,"format":"int64","type":"integer"},"total_pages":{"description":"The total number of pages.","example":5,"format":"int64","type":"integer"}},"type":"object","required":["total","count","page","per_page","total_pages","_embedded","_links"]},"example":{"count":10,"page":1,"per_page":10,"total":10,"total_pages":5,"_embedded":[{"id":"669d7b6a-541d-4e73-b219-e48a56109cc5","browser_full":"Chrome 15.05","country":"United States","ip_address":"192.22.1.22","latitude":1.1,"login_timestamp":"2020-02-01T10:00:00.000Z","logout_timestamp":"2020-02-01T10:00:00.000Z","longitude":1.1,"os_full":"Mac OS X 10.15","sso":"google","user_id":"669d7b6a-54dd-4e73-b219-e48a56109cc5","support_access":false}],"_links":{"first":{"href":"https://api-docs.talkdesk.org/log/sessions?page=1&per_page=10"},"last":{"href":"https://api-docs.talkdesk.org/log/sessions?page=1&per_page=10"},"next":{"href":"https://api-docs.talkdesk.org/log/sessions?page=1&per_page=10"},"prev":{"href":"https://api-docs.talkdesk.org//log/sessions?page=1&per_page=10"},"self":{"href":"https://api-docs.talkdesk.org/log/sessions?page=1&per_page=10"},"show":{"href":"https://api-docs.talkdesk.org/log/sessions?page=1&per_page=10"}}}}},"description":"List containing paginated cases"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1050004","message":"Constraint violation(s) occurred during input validation."}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1050008","message":"Unauthorized"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1050009","message":"Forbidden"}}},"description":"Forbidden"},"406":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1050002","message":"Page parameter must be greater that 0."}}},"description":"Not Acceptable"}},"security":[{"GA":["guardian-sessions:read"]}],"summary":"Get all session logs odata","tags":["Guardian"]}},"/guardian/agents":{"get":{"deprecated":true,"description":"Returns a paged list of agents.","operationId":"AgentsResource_getAllAgentsOdata","parameters":[{"name":"filter","in":"query","description":"Allows filtering by using comparison and logical operators.

    \n
  • To search parts of a string within a field of type string then the contains operator should be used.
    \n The syntax is the following: contains(field, 'value')
    • \n
    \n Logical operators are and and or.
    \n When using multiple ANDs and ORs, you should use parentheses to explicitly define the logical operators evaluation order.
    \n (note: this is recommended because the usual precedence rules aren't supported due to an implementation detail).

    \n Examples:\n \n More information here","required":true,"schema":{"type":"string","x-operators":["eq","ne","gt","ge","lt","le","and","or","not","( )","contains"]},"example":"filter=(creation_time ge '2020-12-18T13:09:09.417Z' and creation_time le '2020-12-18T13:09:09.417Z')"},{"name":"order_by","in":"query","description":"Sorts by the indicated field in the specified direction, ascending or descending.\n The expression format may contain the suffix asc or desc separated from the property name with a colon in between.
    \n Examples:\n More information here","schema":{"type":"string","x-sorting_default_order":"asc","x-sorting_fields":["name","role","creation_time","presence","status"]},"example":"order_by=role:desc"},{"name":"page","in":"query","schema":{"format":"int32","type":"integer","default":1,"minimum":1,"example":10,"maximum":2147483647}},{"name":"per_page","in":"query","schema":{"format":"int32","default":20,"minimum":1,"maximum":250,"type":"integer"},"example":40}],"responses":{"200":{"content":{"application/json":{"schema":{"description":"Agents list response","properties":{"_embedded":{"items":{"description":"The agent data","properties":{"creation_time":{"description":"The agent creation timestamp.","example":"2020-02-01T10:00:00.000Z","type":"string"},"email":{"description":"The agent e-mail.","example":"john.doe@somecompany.com","type":"string"},"id":{"description":"The agent id.","example":"669d7b6a54dd4e73b219e48a56109cc5","type":"string"},"name":{"description":"The agent name.","example":"John Doe","type":"string"},"presence":{"description":"The agent current connection presence.","example":"Offline","type":"string"},"presence_type":{"description":"The agent current connection presence type.","example":"offline","type":"string"},"ring_groups":{"description":"The agent ring groups.","example":["Agents"],"items":{"type":"string"},"type":"array"},"risk":{"description":"The agent risk.","example":91.5,"format":"double","type":"number"},"role":{"description":"The agent role.","example":"Administrator","type":"string"},"status":{"allOf":[{"enum":["ACTIVE","INACTIVE","PENDING"],"type":"string"},{"description":"The agent activation state.","example":"active"}]},"call_quality":{"description":"Call quality data","properties":{"avg_affected_calls":{"description":"The average affected call status","example":false,"type":"boolean"},"mos":{"description":"MOS data","properties":{"avg":{"description":"The average MOS","example":1.2,"type":"number"}}}}}},"type":"object"},"type":"array"},"_links":{"properties":{"first":{"allOf":[{"description":"Hal link","properties":{"href":{"description":"The hypertext reference describing this link.","example":"schema://host:port/log/sessions?page=1&per_page=10","type":"string"}},"type":"object","required":["href"]},{"description":"The first page link."}]},"last":{"allOf":[{"description":"Hal link","properties":{"href":{"description":"The hypertext reference describing this link.","example":"schema://host:port/log/sessions?page=1&per_page=10","type":"string"}},"type":"object","required":["href"]},{"description":"The last page link."}]},"next":{"allOf":[{"description":"Hal link","properties":{"href":{"description":"The hypertext reference describing this link.","example":"schema://host:port/log/sessions?page=1&per_page=10","type":"string"}},"type":"object","required":["href"]},{"description":"The next page link."}]},"prev":{"allOf":[{"description":"Hal link","properties":{"href":{"description":"The hypertext reference describing this link.","example":"schema://host:port/log/sessions?page=1&per_page=10","type":"string"}},"type":"object","required":["href"]},{"description":"The previous page link."}]},"self":{"allOf":[{"description":"Hal link","properties":{"href":{"description":"The hypertext reference describing this link.","example":"schema://host:port/log/sessions?page=1&per_page=10","type":"string"}},"type":"object","required":["href"]},{"description":"The current page link."}]},"show":{"allOf":[{"description":"Hal link","properties":{"href":{"description":"The hypertext reference describing this link.","example":"schema://host:port/log/sessions?page=1&per_page=10","type":"string"}},"type":"object","required":["href"]},{"description":"Show alarms link."}]}},"type":"object"},"count":{"description":"The number of results in the current page.","example":10,"format":"int32","type":"integer"},"page":{"description":"The current page.","example":1,"format":"int32","type":"integer"},"per_page":{"description":"The number of results per page.","example":10,"format":"int32","type":"integer"},"total":{"description":"The total number of results.","example":10,"format":"int64","type":"integer"},"total_pages":{"description":"The total number of pages.","example":5,"format":"int64","type":"integer"}},"type":"object"},"example":{"page":1,"count":2,"per_page":10,"total":2,"total_pages":1,"_embedded":[{"name":"John Doe","email":"john.doe@talkdesk.com","risk":91.5,"role":"Administrator","status":"ACTIVE","id":"ttaab8b0af2a510007fab077","ring_groups":["agents"],"creation_time":"2020-11-10T16:58:40.513Z","presence_type":"available","presence":"Available","call_quality":{"avg_affected_calls":false,"mos":{"avg":0.8}}}],"_links":{"first":{"href":"https://api-docs.talkdesk.org/agents?per_page=10&page=1"},"last":{"href":"https://api-docs.talkdesk.org/agents?per_page=10&page=1"},"next":{"href":"https://api-docs.talkdesk.org/agents?page=1&per_page=10"},"prev":{"href":"https://api-docs.talkdesk.org/agents?page=1&per_page=10"},"self":{"href":"https://api-docs.talkdesk.org/agents?per_page=10&page=1"},"show":{"href":"https://api-docs.talkdesk.org/agents?page=1&per_page=10"}}}},"text/csv":{"schema":{"type":"string","description":"The list of agents for export."},"example":"agent,role,ring_groups,created,activation,status,email\nJohn Doe,Administrator,[agents],2020-11-10T16:58:40.513Z,active,Available,john.doe@talkdesk.com\nJosh Doe,Administrator,[agents],2020-11-10T16:58:40.513Z,inactive,Available,josh.doe@talkdesk.com\n"}},"description":"Paginated list of agents"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1050005","message":"Agent not found."}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1050008","message":"Unauthorized"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1050009","message":"Forbidden"}}},"description":"Forbidden"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1050001","message":"Agent not Found."}}}},"406":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1050002","message":"Not Acceptable header"}}},"description":"Not Acceptable"}},"security":[{"GA":["guardian-users:read"]}],"summary":"Get all agents","tags":["Guardian"]}},"/guardian/agents/{id}":{"get":{"deprecated":true,"description":"Returns an agent.","operationId":"AgentsResource_getAgent","parameters":[{"name":"id","in":"path","description":"Id of the agent to fetch","required":true,"schema":{"maxLength":255,"minLength":1,"pattern":"\\S","type":"string"},"example":"483107a399214b9fb7ea78ac619450c0"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"_links":{"properties":{"self":{"allOf":[{"description":"Hal link","properties":{"href":{"description":"The hypertext reference describing this link.","example":"schema://host:port/log/sessions?page=1&per_page=10","type":"string"}},"type":"object","required":["href"]},{"description":"The current page link."}]}},"type":"object"},"creation_time":{"description":"The agent creation timestamp.","example":"2020-02-01T10:00:00.000Z","type":"string"},"email":{"description":"The agent e-mail.","example":"john.doe@somecompany.com","type":"string"},"id":{"description":"The agent id.","example":"669d7b6a54dd4e73b219e48a56109cc5","type":"string"},"name":{"description":"The agent name.","example":"John Doe","type":"string"},"presence":{"description":"The agent current connection presence.","example":"Offline","type":"string"},"presence_type":{"description":"The agent current connection presence type.","example":"offline","type":"string"},"ring_groups":{"description":"The agent ring groups.","example":["Agents"],"items":{"type":"string"},"type":"array"},"risk":{"description":"The agent risk.","example":91.5,"format":"double","type":"number"},"role":{"description":"The agent role.","example":"Administrator","type":"string"},"status":{"allOf":[{"enum":["ACTIVE","INACTIVE","PENDING"],"type":"string"},{"description":"The agent activation state.","example":"active"}]},"call_quality":{"description":"Call quality data","properties":{"avg_affected_calls":{"description":"The average affected call status","example":false,"type":"boolean"},"mos":{"description":"MOS data","properties":{"avg":{"description":"The average MOS","example":1.2,"type":"number"}}}}}},"type":"object"},"example":{"name":"John Doe","email":"john.doe@talkdesk.com","risk":91.5,"role":"Administrator","status":"INACTIVE","presence":"Available","id":"ataab8b0af2a510007fab0779","ring_groups":["agents"],"creation_time":"2020-11-10T16:58:40.513Z","presence_type":"available","call_quality":{"avg_affected_calls":false,"mos":{"avg":0.8}},"_links":{"self":{"href":"https://api-docs.talkdesk.org/agents/ataab8b0af2a510007fab0779"}}}}},"description":"Requested agent data"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1050005","message":"Agent not found."}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1050008","message":"Unauthorized"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1050009","message":"Forbidden"}}},"description":"Forbidden"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1050001","message":"Agent not Found."}}}},"406":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1050002","message":"Not Acceptable header"}}},"description":"Not Acceptable"}},"security":[{"GA":["guardian-users:read"]}],"summary":"Get agent by id.","tags":["Guardian"]}},"/guardian/agents/{id}/roles":{"get":{"deprecated":true,"description":"Returns a paged list of agent role changes.","operationId":"getAgentRoles","parameters":[{"name":"id","in":"path","description":"Id of the agent to fetch roles","required":true,"schema":{"maxLength":255,"minLength":1,"pattern":"\\S","type":"string"},"example":"483107a399214b9fb7ea78ac619450c0"},{"name":"filter","in":"query","description":"Allows filtering by using comparison and logical operators.

    \n
  • To search parts of a string within a field of type string then the contains operator should be used.
    \n The syntax is the following: contains(field, 'value')
    • \n
    \n Logical operators are and and or.
    \n When using multiple ANDs and ORs, you should use parentheses to explicitly define the logical operators evaluation order.
    \n (note: this is recommended because the usual precedence rules aren't supported due to an implementation detail).

    \n Examples:\n \n More information here","required":true,"schema":{"type":"string","x-operators":["eq","ne","gt","ge","lt","le","and","or","not","( )","contains"]},"example":"filter=(timestamp ge '2020-12-18T13:09:09.417Z' and timestamp le '2020-12-18T13:09:09.417Z')"},{"name":"order_by","in":"query","description":"Sorts by the indicated field in the specified direction, ascending or descending.\n The expression format may contain the suffix asc or desc separated from the property name with a colon in between.
    \n Examples:\n More information here","schema":{"type":"string","x-sorting_default_order":"asc","x-sorting_fields":["assigned_by","role","assigned_at"]},"example":"order_by=role:desc"},{"name":"page","in":"query","schema":{"format":"int32","type":"integer","default":1,"minimum":1,"example":10,"maximum":2147483647}},{"name":"per_page","in":"query","schema":{"format":"int32","default":20,"minimum":1,"maximum":250,"type":"integer"},"example":40}],"requestBody":{"content":{"application/json":{}},"description":"The report search request to fetch"},"responses":{"200":{"content":{"application/json":{"schema":{"description":"Agent roles list response","properties":{"_embedded":{"items":{"description":"The agent role data","properties":{"assigned_at":{"description":"The role attribution timestamp.","example":"2020-02-01T10:00:00.000Z","type":"string"},"assigned_by":{"description":"The agent name that did the role attribution.","example":"John Doe","type":"string"},"role":{"description":"The agent role.","example":"Administrator","type":"string"},"id":{"description":"The user id.","example":"669d7b6a54dd4e73b219e48a56109cc5","type":"string"}},"type":"object"},"type":"array"},"_links":{"properties":{"first":{"allOf":[{"description":"Hal link","properties":{"href":{"description":"The hypertext reference describing this link.","example":"https://guardian.talkdesk.org/atlas/guardian/dashboards?page=1&per_page=10","type":"string"}},"type":"object"},{"description":"The first page link."}]},"last":{"allOf":[{"description":"Hal link","properties":{"href":{"description":"The hypertext reference describing this link.","example":"https://guardian.talkdesk.org/atlas/guardian/dashboards?page=1&per_page=10","type":"string"}},"type":"object"},{"description":"The last page link."}]},"next":{"allOf":[{"description":"Hal link","properties":{"href":{"description":"The hypertext reference describing this link.","example":"https://guardian.talkdesk.org/atlas/guardian/dashboards?page=1&per_page=10","type":"string"}},"type":"object"},{"description":"The next page link."}]},"prev":{"allOf":[{"description":"Hal link","properties":{"href":{"description":"The hypertext reference describing this link.","example":"https://guardian.talkdesk.org/atlas/guardian/dashboards?page=1&per_page=10","type":"string"}},"type":"object"},{"description":"The previous page link."}]},"self":{"allOf":[{"description":"Hal link","properties":{"href":{"description":"The hypertext reference describing this link.","example":"https://guardian.talkdesk.org/atlas/guardian/dashboards?page=1&per_page=10","type":"string"}},"type":"object"},{"description":"The current page link."}]},"show":{"allOf":[{"description":"Hal link","properties":{"href":{"description":"The hypertext reference describing this link.","example":"https://guardian.talkdesk.org/atlas/guardian/dashboards?page=1&per_page=10","type":"string"}},"type":"object"},{"description":"Show roles link."}]}},"type":"object"},"count":{"description":"The number of results in the current page.","example":10,"format":"int32","type":"integer"},"page":{"description":"The current page.","example":1,"format":"int32","type":"integer"},"per_page":{"description":"The number of results per page.","example":10,"format":"int32","type":"integer"},"total":{"description":"The total number of results.","example":10,"format":"int64","type":"integer"},"total_pages":{"description":"The total number of pages.","example":5,"format":"int64","type":"integer"}},"type":"object"},"example":{"page":1,"count":8,"per_page":10,"total":8,"total_pages":1,"_embedded":[{"role":"Agent","assigned_at":"2020-11-10T16:58:40.513Z","assigned_by":"John Doe"},{"role":"Administrator","assigned_at":"2020-11-15T16:58:40.513Z","assigned_by":"Josh Doe"}],"_links":{"first":{"href":"https://api-docs.talkdesk.org/agents/agent1/roles?per_page=10&page=1"},"last":{"href":"https://api-docs.talkdesk.org/agents/agent1/roles?per_page=10&page=1"},"next":{"href":"https://api-docs.talkdesk.org/agents/agent1/roles?page=1&per_page=10"},"prev":{"href":"https://api-docs.talkdesk.org/agents/agent1/roles?page=1&per_page=10"},"self":{"href":"https://api-docs.talkdesk.org/agents/{id}/roles?per_page=10&page=1"},"show":{"href":"https://api-docs.talkdesk.org/agents/agent1/roles?page=1&per_page=10"}}}}},"description":"Paginated list of agent role changes"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1050005","message":"Agent not found."}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1050008","message":"Unauthorized"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1050009","message":"Forbidden"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1050001","message":"Agent not Found."}}},"description":"Not Found"},"406":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1050002","message":"Not Acceptable header"}}},"description":"Not Acceptable"}},"security":[{"GA":["guardian-users:read"]}],"summary":"Get agent role changes","tags":["Guardian"]}},"/guardian/cases":{"get":{"description":"Returns a list of cases.","operationId":"CasesResource_getCasesOdata","parameters":[{"name":"filter","in":"query","description":"Allows filtering by using comparison and logical operators.

    \n
  • To search parts of a string within a field of type string then the contains operator should be used.
    \n The syntax is the following: contains(field, 'value')
    • \n
    \n Logical operators are and and or.
    \n When using multiple ANDs and ORs, you should use parentheses to explicitly define the logical operators evaluation order.
    \n (note: this is recommended because the usual precedence rules aren't supported due to an implementation detail).

    \n Examples:\n \n More information here","schema":{"maxLength":1600,"type":"string","x-operators":["eq","ne","gt","ge","lt","le","and","or","not","( )","contains"]}},{"name":"order_by","in":"query","description":"Sorts by the indicated field in the specified direction, ascending or descending.\n The expression format may contain the suffix asc or desc separated from the property name with a colon in between.
    \n Examples:\n More information here","schema":{"maxLength":300,"type":"string","default":"ingest_timestamp:desc","x-sorting_default_order":"asc","x-sorting_fields":["event_id","user_id","ingest_timestamp","hits","hits_number","baseline","user_prob","user_conf","pop_prob","pop_conf","case","specification","user_baseline","pop_baseline","source"]}},{"name":"page","in":"query","description":"Number of the requested page","schema":{"format":"int32","default":1,"minimum":1,"type":"integer","maximum":2147483647}},{"name":"per_page","in":"query","description":"Max number of the items in a page","schema":{"format":"int32","default":10,"minimum":1,"type":"integer","maximum":250}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"_embedded":{"items":{"properties":{"baseline":{"description":"The baseline of the current case.","format":"int32","type":"integer"},"case":{"description":"The id of the case.","example":"country_code","type":"string"},"event_id":{"description":"The ID of the event that triggered the anomaly.","example":"669d7b6a-54dd-4e73-b219-e48a56109cc5","type":"string"},"hits":{"description":"The values that are anomalous.","items":{"type":"string"},"type":"array"},"hits_number":{"description":"The number of anomalous values.","format":"int32","type":"integer"},"id":{"description":"The id of the anomaly","example":"EpvqwnwBb05xkQ1O1Oj_","type":"string"},"ingest_timestamp":{"description":"Ingestion date of the anomaly.","example":"2020-02-01T10:00:00.000Z","format":"date-time","type":"string"},"pop_baseline":{"description":"The peer baseline.","items":{"type":"string"},"type":"array"},"pop_conf":{"description":"Confidence in the anomaly regarding the peer baseline.","format":"double","type":"number"},"pop_prob":{"description":"Probability of 'hits' for the peers.","format":"double","type":"number"},"source":{"allOf":[{"enum":["DATABRICKS","ELASTICSEARCH"],"type":"string"},{"description":"Source of the anomaly.","example":"elasticsearch"}]},"specification":{"description":"Specification of the case.","example":"inbound calls","type":"string"},"user_baseline":{"description":"The user baseline.","items":{"type":"string"},"type":"array"},"user_conf":{"description":"Confidence in the anomaly regarding the user baseline.","format":"double","type":"number"},"user_id":{"description":"The ID of the user that triggered the anomaly.","example":"669d7b6a-54dd-4e73-b219-e48a56109cc5","type":"string"},"user_prob":{"description":"Probability of 'hits' for the user.","format":"double","type":"number"}},"required":["baseline","case","event_id","hits","hits_number","id","ingest_timestamp","pop_baseline","pop_conf","pop_prob","source","specification","user_baseline","user_conf","user_id","user_prob"],"type":"object"},"type":"array"},"_links":{"properties":{"first":{"allOf":[{"description":"Hal link","properties":{"href":{"description":"The hypertext reference describing this link.","example":"https://guardian.talkdesk.org/atlas/guardian/dashboards?page=1&per_page=10","type":"string"}},"type":"object"},{"description":"The first page link."}],"required":["href"]},"last":{"allOf":[{"description":"Hal link","properties":{"href":{"description":"The hypertext reference describing this link.","example":"https://guardian.talkdesk.org/atlas/guardian/dashboards?page=1&per_page=10","type":"string"}},"type":"object"},{"description":"The last page link."}],"required":["href"]},"next":{"allOf":[{"description":"Hal link","properties":{"href":{"description":"The hypertext reference describing this link.","example":"https://guardian.talkdesk.org/atlas/guardian/dashboards?page=1&per_page=10","type":"string"}},"type":"object"},{"description":"The next page link."}],"required":["href"]},"prev":{"allOf":[{"description":"Hal link","properties":{"href":{"description":"The hypertext reference describing this link.","example":"https://guardian.talkdesk.org/atlas/guardian/dashboards?page=1&per_page=10","type":"string"}},"type":"object"},{"description":"The previous page link."}],"required":["href"]},"self":{"allOf":[{"description":"Hal link","properties":{"href":{"description":"The hypertext reference describing this link.","example":"https://guardian.talkdesk.org/atlas/guardian/dashboards?page=1&per_page=10","type":"string"}},"type":"object"},{"description":"The current page link."}],"required":["href"]},"show":{"allOf":[{"description":"Hal link","properties":{"href":{"description":"The hypertext reference describing this link.","example":"https://guardian.talkdesk.org/atlas/guardian/dashboards?page=1&per_page=10","type":"string"}},"type":"object"},{"description":"Show link."}],"required":["href"]}},"required":["first","last","self","show"],"type":"object"},"count":{"description":"The number of results in the current page.","example":10,"format":"int32","type":"integer"},"page":{"description":"The current page.","example":1,"format":"int32","type":"integer"},"per_page":{"description":"The number of results per page.","example":10,"format":"int32","type":"integer"},"total":{"description":"The total number of results.","example":10,"format":"int64","type":"integer"},"total_pages":{"description":"The total number of pages.","example":5,"format":"int64","type":"integer"}},"required":["count","page","per_page","total","total_pages","_embedded","_links"],"type":"object"},"example":{"count":10,"page":3,"per_page":10,"total":45,"total_pages":5,"_embedded":[{"id":"EpvqwnwBb05xkQ1O1Oj_","event_id":"669d7b6a-54dd-4e73-b219-e48a56109cc5","user_id":"669d7b6a-54dd-4e73-b219-e48a56109cc5","ingest_timestamp":"2020-02-01T10:00:00.000Z","hits":["string"],"hits_number":0,"baseline":0,"user_prob":0,"user_conf":0,"pop_prob":0,"pop_conf":0,"case":"country_code","specification":"inbound calls","user_baseline":["string"],"pop_baseline":["string"],"source":"ELASTICSEARCH"}],"_links":{"first":{"href":"https://api-docs.talkdesk.org/cases?page=1&per_page=10"},"last":{"href":"https://api-docs.talkdesk.org/cases?page=5&per_page=10"},"next":{"href":"https://api-docs.talkdesk.org/cases?page=4&per_page=10"},"prev":{"href":"https://api-docs.talkdesk.org/cases?page=2&per_page=10"},"self":{"href":"https://api-docs.talkdesk.org/cases?page=3&per_page=10"},"show":{"href":"https://api-docs.talkdesk.org/cases"}}}},"text/csv":{"example":"user_name,user_id,case_name,case,specification,hits,hits_number,baseline,event_id,user_prob,pop_prob,user_conf,pop_conf,user_baseline,pop_baseline,ingest_timestamp,source\r\n User1,45634563456345634563456345633423,Population sessions,population_user_session_created,,,5,1,,,,,,,,2021-09-08T11:14:11.511Z,ELASTICSEARCH\r\n User2,23452346456766786789789684345667,User accessing recording files,user_read_recording_media_file,,,8,1,,,,,,,,2021-09-07T11:14:11.511Z,DATABRICKS\r\n","schema":{"description":"The csv exported data.","type":"string"}}},"description":"List containing paginated cases"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1050004","message":"Constraint violation(s) occurred during input validation."}},"text/csv":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1050004","message":"Constraint violation(s) occurred during input validation."}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1050008","message":"Unauthorized"}},"text/csv":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1050008","message":"Unauthorized"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1050009","message":"Forbidden"}},"text/csv":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1050009","message":"Forbidden"}}},"description":"Forbidden"}},"security":[{"GA":["guardian-cases:read"]}],"summary":"Get all cases","tags":["Guardian"]}},"/guardian/users":{"get":{"description":"Returns a paged list of users.","operationId":"UsersResource_getAllUsersOdata","parameters":[{"name":"filter","in":"query","description":"Allows filtering by using comparison and logical operators.

    \n
  • To search parts of a string within a field of type string then the contains operator should be used.
    \n The syntax is the following: contains(field, 'value')
    • \n
    \n Logical operators are and and or.
    \n When using multiple ANDs and ORs, you should use parentheses to explicitly define the logical operators evaluation order.
    \n (note: this is recommended because the usual precedence rules aren't supported due to an implementation detail).

    \n Examples:\n \n More information here","required":true,"schema":{"type":"string","x-operators":["eq","ne","gt","ge","lt","le","and","or","not","( )","contains"]},"example":"filter=(creation_time ge '2020-12-18T13:09:09.417Z' and creation_time le '2020-12-18T13:09:09.417Z')"},{"name":"order_by","in":"query","description":"Sorts by the indicated field in the specified direction, ascending or descending.\n The expression format may contain the suffix asc or desc separated from the property name with a colon in between.
    \n Examples:\n More information here","schema":{"type":"string","default":"id:asc","x-sorting_default_order":"asc","x-sorting_fields":["name","role","creation_time","presence","status","id"]},"example":"order_by=role:desc"},{"name":"page","in":"query","schema":{"format":"int32","type":"integer","default":1,"minimum":1,"example":10,"maximum":2147483647}},{"name":"per_page","in":"query","schema":{"format":"int32","default":20,"minimum":1,"maximum":250,"type":"integer"},"example":40}],"responses":{"200":{"content":{"application/json":{"schema":{"description":"Agents list response","properties":{"_embedded":{"items":{"description":"The agent data","properties":{"creation_time":{"description":"The agent creation timestamp.","example":"2020-02-01T10:00:00.000Z","type":"string"},"email":{"description":"The agent e-mail.","example":"john.doe@somecompany.com","type":"string"},"id":{"description":"The agent id.","example":"669d7b6a54dd4e73b219e48a56109cc5","type":"string"},"name":{"description":"The agent name.","example":"John Doe","type":"string"},"presence":{"description":"The agent current connection presence.","example":"Offline","type":"string"},"presence_type":{"description":"The agent current connection presence type.","example":"offline","type":"string"},"ring_groups":{"description":"The agent ring groups.","example":["Agents"],"items":{"type":"string"},"type":"array"},"risk":{"description":"The agent risk.","example":91.5,"format":"double","type":"number"},"role":{"description":"The agent role.","example":"Administrator","type":"string"},"status":{"allOf":[{"enum":["ACTIVE","INACTIVE","PENDING"],"type":"string"},{"description":"The agent activation state.","example":"active"}]},"call_quality":{"description":"Call quality data","properties":{"avg_affected_calls":{"description":"The average affected call status","example":false,"type":"boolean"},"mos":{"description":"MOS data","properties":{"avg":{"description":"The average MOS","example":1.2,"type":"number"}}}}}},"type":"object"},"type":"array"},"_links":{"properties":{"first":{"allOf":[{"description":"Hal link","properties":{"href":{"description":"The hypertext reference describing this link.","example":"schema://host:port/log/sessions?page=1&per_page=10","type":"string"}},"type":"object","required":["href"]},{"description":"The first page link."}]},"last":{"allOf":[{"description":"Hal link","properties":{"href":{"description":"The hypertext reference describing this link.","example":"schema://host:port/log/sessions?page=1&per_page=10","type":"string"}},"type":"object","required":["href"]},{"description":"The last page link."}]},"next":{"allOf":[{"description":"Hal link","properties":{"href":{"description":"The hypertext reference describing this link.","example":"schema://host:port/log/sessions?page=1&per_page=10","type":"string"}},"type":"object","required":["href"]},{"description":"The next page link."}]},"prev":{"allOf":[{"description":"Hal link","properties":{"href":{"description":"The hypertext reference describing this link.","example":"schema://host:port/log/sessions?page=1&per_page=10","type":"string"}},"type":"object","required":["href"]},{"description":"The previous page link."}]},"self":{"allOf":[{"description":"Hal link","properties":{"href":{"description":"The hypertext reference describing this link.","example":"schema://host:port/log/sessions?page=1&per_page=10","type":"string"}},"type":"object","required":["href"]},{"description":"The current page link."}]},"show":{"allOf":[{"description":"Hal link","properties":{"href":{"description":"The hypertext reference describing this link.","example":"schema://host:port/log/sessions?page=1&per_page=10","type":"string"}},"type":"object","required":["href"]},{"description":"Show alarms link."}]}},"type":"object"},"count":{"description":"The number of results in the current page.","example":10,"format":"int32","type":"integer"},"page":{"description":"The current page.","example":1,"format":"int32","type":"integer"},"per_page":{"description":"The number of results per page.","example":10,"format":"int32","type":"integer"},"total":{"description":"The total number of results.","example":10,"format":"int64","type":"integer"},"total_pages":{"description":"The total number of pages.","example":5,"format":"int64","type":"integer"}},"type":"object"},"example":{"page":1,"count":2,"per_page":10,"total":2,"total_pages":1,"_embedded":[{"name":"John Doe","email":"john.doe@talkdesk.com","risk":91.5,"role":"Administrator","status":"ACTIVE","id":"ttaab8b0af2a510007fab077","ring_groups":["agents"],"creation_time":"2020-11-10T16:58:40.513Z","presence_type":"available","presence":"Available","call_quality":{"avg_affected_calls":false,"mos":{"avg":0.8}}}],"_links":{"first":{"href":"https://api-docs.talkdesk.org/agents?per_page=10&page=1"},"last":{"href":"https://api-docs.talkdesk.org/agents?per_page=10&page=1"},"next":{"href":"https://api-docs.talkdesk.org/agents?page=1&per_page=10"},"prev":{"href":"https://api-docs.talkdesk.org/agents?page=1&per_page=10"},"self":{"href":"https://api-docs.talkdesk.org/agents?per_page=10&page=1"},"show":{"href":"https://api-docs.talkdesk.org/agents?page=1&per_page=10"}}}},"text/csv":{"schema":{"type":"string","description":"The list of agents for export."},"example":"agent,role,ring_groups,created,activation,status,email\nJohn Doe,Administrator,[agents],2020-11-10T16:58:40.513Z,active,Available,john.doe@talkdesk.com\nJosh Doe,Administrator,[agents],2020-11-10T16:58:40.513Z,inactive,Available,josh.doe@talkdesk.com\n"}},"description":"Paginated list of users"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1050005","message":"Agent not found."}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1050008","message":"Unauthorized"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1050009","message":"Forbidden"}}},"description":"Forbidden"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1050001","message":"Agent not Found."}}}},"406":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1050002","message":"Not Acceptable header"}}},"description":"Not Acceptable"}},"security":[{"GA":["guardian-users:read"]}],"summary":"Get all users","tags":["Guardian"]}},"/guardian/users/{id}":{"get":{"description":"Returns an agent.","operationId":"UsersResource_getUsers","parameters":[{"name":"id","in":"path","description":"Id of the user to fetch","required":true,"schema":{"maxLength":255,"minLength":1,"pattern":"\\S","type":"string"},"example":"483107a399214b9fb7ea78ac619450c0"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"_links":{"properties":{"self":{"allOf":[{"description":"Hal link","properties":{"href":{"description":"The hypertext reference describing this link.","example":"schema://host:port/log/sessions?page=1&per_page=10","type":"string"}},"type":"object","required":["href"]},{"description":"The current page link."}]}},"type":"object"},"creation_time":{"description":"The agent creation timestamp.","example":"2020-02-01T10:00:00.000Z","type":"string"},"email":{"description":"The agent e-mail.","example":"john.doe@somecompany.com","type":"string"},"id":{"description":"The agent id.","example":"669d7b6a54dd4e73b219e48a56109cc5","type":"string"},"name":{"description":"The agent name.","example":"John Doe","type":"string"},"presence":{"description":"The agent current connection presence.","example":"Offline","type":"string"},"presence_type":{"description":"The agent current connection presence type.","example":"offline","type":"string"},"ring_groups":{"description":"The agent ring groups.","example":["Agents"],"items":{"type":"string"},"type":"array"},"risk":{"description":"The agent risk.","example":91.5,"format":"double","type":"number"},"role":{"description":"The agent role.","example":"Administrator","type":"string"},"status":{"allOf":[{"enum":["ACTIVE","INACTIVE","PENDING"],"type":"string"},{"description":"The agent activation state.","example":"active"}]},"call_quality":{"description":"Call quality data","properties":{"avg_affected_calls":{"description":"The average affected call status","example":false,"type":"boolean"},"mos":{"description":"MOS data","properties":{"avg":{"description":"The average MOS","example":1.2,"type":"number"}}}}}},"type":"object"},"example":{"name":"John Doe","email":"john.doe@talkdesk.com","risk":91.5,"role":"Administrator","status":"INACTIVE","presence":"Available","id":"ataab8b0af2a510007fab0779","ring_groups":["agents"],"creation_time":"2020-11-10T16:58:40.513Z","presence_type":"available","call_quality":{"avg_affected_calls":false,"mos":{"avg":0.8}},"_links":{"self":{"href":"https://api-docs.talkdesk.org/agents/ataab8b0af2a510007fab0779"}}}}},"description":"Requested user data"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1050005","message":"Agent not found."}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1050008","message":"Unauthorized"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1050009","message":"Forbidden"}}},"description":"Forbidden"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1050001","message":"Agent not Found."}}}},"406":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1050002","message":"Not Acceptable header"}}},"description":"Not Acceptable"}},"security":[{"GA":["guardian-users:read"]}],"summary":"Get user by id.","tags":["Guardian"]}},"/guardian/users/{id}/roles":{"get":{"description":"Returns a paged list of agent role changes.","operationId":"UsersResource_getUserRoles","parameters":[{"name":"id","in":"path","description":"Id of the user to fetch roles","required":true,"schema":{"maxLength":255,"minLength":1,"pattern":"\\S","type":"string"},"example":"483107a399214b9fb7ea78ac619450c0"},{"name":"filter","in":"query","description":"Allows filtering by using comparison and logical operators.

    \n
  • To search parts of a string within a field of type string then the contains operator should be used.
    \n The syntax is the following: contains(field, 'value')
    • \n
    \n Logical operators are and and or.
    \n When using multiple ANDs and ORs, you should use parentheses to explicitly define the logical operators evaluation order.
    \n (note: this is recommended because the usual precedence rules aren't supported due to an implementation detail).

    \n Examples:\n \n More information here","required":true,"schema":{"type":"string","x-operators":["eq","ne","gt","ge","lt","le","and","or","not","( )","contains"]},"example":"filter=(timestamp ge '2020-12-18T13:09:09.417Z' and timestamp le '2020-12-18T13:09:09.417Z')"},{"name":"order_by","in":"query","description":"Sorts by the indicated field in the specified direction, ascending or descending.\n The expression format may contain the suffix asc or desc separated from the property name with a colon in between.
    \n Examples:\n More information here","schema":{"type":"string","default":"assigned_at:asc","x-sorting_default_order":"asc","x-sorting_fields":["assigned_by","role","assigned_at"]},"example":"order_by=role:desc"},{"name":"page","in":"query","schema":{"format":"int32","type":"integer","default":1,"minimum":1,"example":10,"maximum":2147483647}},{"name":"per_page","in":"query","schema":{"format":"int32","default":20,"minimum":1,"maximum":250,"type":"integer"},"example":40}],"requestBody":{"content":{"application/json":{}},"description":"The report search request to fetch"},"responses":{"200":{"content":{"application/json":{"schema":{"description":"Agent roles list response","properties":{"_embedded":{"items":{"description":"The agent role data","properties":{"assigned_at":{"description":"The role attribution timestamp.","example":"2020-02-01T10:00:00.000Z","type":"string"},"assigned_by":{"description":"The agent name that did the role attribution.","example":"John Doe","type":"string"},"role":{"description":"The agent role.","example":"Administrator","type":"string"},"id":{"description":"The user id.","example":"669d7b6a54dd4e73b219e48a56109cc5","type":"string"}},"type":"object"},"type":"array"},"_links":{"properties":{"first":{"allOf":[{"description":"Hal link","properties":{"href":{"description":"The hypertext reference describing this link.","example":"https://guardian.talkdesk.org/atlas/guardian/dashboards?page=1&per_page=10","type":"string"}},"type":"object"},{"description":"The first page link."}]},"last":{"allOf":[{"description":"Hal link","properties":{"href":{"description":"The hypertext reference describing this link.","example":"https://guardian.talkdesk.org/atlas/guardian/dashboards?page=1&per_page=10","type":"string"}},"type":"object"},{"description":"The last page link."}]},"next":{"allOf":[{"description":"Hal link","properties":{"href":{"description":"The hypertext reference describing this link.","example":"https://guardian.talkdesk.org/atlas/guardian/dashboards?page=1&per_page=10","type":"string"}},"type":"object"},{"description":"The next page link."}]},"prev":{"allOf":[{"description":"Hal link","properties":{"href":{"description":"The hypertext reference describing this link.","example":"https://guardian.talkdesk.org/atlas/guardian/dashboards?page=1&per_page=10","type":"string"}},"type":"object"},{"description":"The previous page link."}]},"self":{"allOf":[{"description":"Hal link","properties":{"href":{"description":"The hypertext reference describing this link.","example":"https://guardian.talkdesk.org/atlas/guardian/dashboards?page=1&per_page=10","type":"string"}},"type":"object"},{"description":"The current page link."}]},"show":{"allOf":[{"description":"Hal link","properties":{"href":{"description":"The hypertext reference describing this link.","example":"https://guardian.talkdesk.org/atlas/guardian/dashboards?page=1&per_page=10","type":"string"}},"type":"object"},{"description":"Show roles link."}]}},"type":"object"},"count":{"description":"The number of results in the current page.","example":10,"format":"int32","type":"integer"},"page":{"description":"The current page.","example":1,"format":"int32","type":"integer"},"per_page":{"description":"The number of results per page.","example":10,"format":"int32","type":"integer"},"total":{"description":"The total number of results.","example":10,"format":"int64","type":"integer"},"total_pages":{"description":"The total number of pages.","example":5,"format":"int64","type":"integer"}},"type":"object"},"example":{"page":1,"count":8,"per_page":10,"total":8,"total_pages":1,"_embedded":[{"role":"Agent","assigned_at":"2020-11-10T16:58:40.513Z","assigned_by":"John Doe"},{"role":"Administrator","assigned_at":"2020-11-15T16:58:40.513Z","assigned_by":"Josh Doe"}],"_links":{"first":{"href":"https://api-docs.talkdesk.org/agents/agent1/roles?per_page=10&page=1"},"last":{"href":"https://api-docs.talkdesk.org/agents/agent1/roles?per_page=10&page=1"},"next":{"href":"https://api-docs.talkdesk.org/agents/agent1/roles?page=1&per_page=10"},"prev":{"href":"https://api-docs.talkdesk.org/agents/agent1/roles?page=1&per_page=10"},"self":{"href":"https://api-docs.talkdesk.org/agents/{id}/roles?per_page=10&page=1"},"show":{"href":"https://api-docs.talkdesk.org/agents/agent1/roles?page=1&per_page=10"}}}}},"description":"Paginated list of user role changes"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1050005","message":"Agent not found."}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1050008","message":"Unauthorized"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1050009","message":"Forbidden"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1050001","message":"Agent not Found."}}},"description":"Not Found"},"406":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1050002","message":"Not Acceptable header"}}},"description":"Not Acceptable"}},"security":[{"GA":["guardian-users:read"]}],"summary":"Get user role changes","tags":["Guardian"]}},"/guardian/calls/call-quality":{"get":{"description":"Returns a list of call quality.","operationId":"CallsResource_getCallQualityOdata","parameters":[{"name":"filter","in":"query","description":"Allows filtering by using comparison and logical operators.

    \n
  • To search parts of a string within a field of type string then the contains operator should be used.
    \n The syntax is the following: contains(field, 'value')
    • \n
    \n Logical operators are and and or.
    \n When using multiple ANDs and ORs, you should use parentheses to explicitly define the logical operators evaluation order.
    \n (note: this is recommended because the usual precedence rules aren't supported due to an implementation detail).

    \n Examples:\n \n More information here","schema":{"maxLength":1600,"type":"string","x-operators":["eq","ne","gt","ge","lt","le","and","or","not","( )","contains"]},"example":"(user_id eq '88bedb3cf9d640c03f41' and timestamp ge '2020-12-18T13:09:09.417Z' and timestamp le '2020-12-18T13:09:09.417Z')"},{"name":"order_by","in":"query","description":"Sorts by the indicated field in the specified direction, ascending or descending.\n The expression format may contain the suffix asc or desc separated from the property name with a colon in between.
    \n Examples:\n More information here","required":false,"schema":{"maxLength":300,"type":"string","default":"call_id:asc","x-sorting_default_order":"asc","x-sorting_fields":["timestamp","call_id"]},"example":"timestamp:desc"},{"name":"page","in":"query","description":"Number of the requested page","schema":{"format":"int32","type":"integer","default":1,"minimum":1,"example":10,"maximum":2147483647}},{"name":"per_page","in":"query","description":"Max number of the items in a page","schema":{"format":"int32","default":10,"minimum":1,"maximum":250,"type":"integer"},"example":40}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"count":{"format":"int32","description":"The number of results in the current page.","type":"integer","example":10},"page":{"format":"int32","description":"The current page.","type":"integer","example":1},"per_page":{"format":"int32","description":"The number of results per page.","type":"integer","example":10},"total":{"format":"int64","description":"The total number of results.","type":"integer","example":10},"total_pages":{"format":"int64","description":"The total number of pages.","type":"integer","example":5},"_embedded":{"type":"array","items":{"type":"object","properties":{"call_id":{"type":"string"},"interaction_id":{"type":"string"},"affected_call":{"type":"boolean"},"jitter":{"type":"object","properties":{"avg":{"format":"float","type":"number"},"max":{"format":"float","type":"number"}}},"mos":{"type":"object","properties":{"avg":{"format":"float","type":"number"},"max":{"format":"float","type":"number"},"min":{"format":"float","type":"number"}}},"rtt":{"type":"object","properties":{"avg":{"format":"float","type":"number"},"max":{"format":"float","type":"number"},"min":{"format":"float","type":"number"}}},"packets_loss_percentage":{"format":"float","type":"number"},"timestamp":{"description":"The timestamp of the call.","type":"string","example":"2020-02-01T10:00:00.000Z"},"user_id":{"description":"The user id.","example":"669d7b6a54dd4e73b219e48a56109cc5","type":"string"}}}},"_links":{"type":"object","properties":{"first":{"allOf":[{"description":"Hal link","properties":{"href":{"description":"The hypertext reference describing this link.","example":"schema://host:port/log/sessions?page=1&per_page=10","type":"string"}},"type":"object","required":["href"]},{"description":"The first page link."}]},"last":{"allOf":[{"description":"Hal link","properties":{"href":{"description":"The hypertext reference describing this link.","example":"schema://host:port/log/sessions?page=1&per_page=10","type":"string"}},"type":"object","required":["href"]},{"description":"The last page link."}]},"next":{"allOf":[{"description":"Hal link","properties":{"href":{"description":"The hypertext reference describing this link.","example":"schema://host:port/log/sessions?page=1&per_page=10","type":"string"}},"type":"object","required":["href"]},{"description":"The next page link."}]},"prev":{"allOf":[{"description":"Hal link","properties":{"href":{"description":"The hypertext reference describing this link.","example":"schema://host:port/log/sessions?page=1&per_page=10","type":"string"}},"type":"object","required":["href"]},{"description":"The previous page link."}]},"self":{"allOf":[{"description":"Hal link","properties":{"href":{"description":"The hypertext reference describing this link.","example":"schema://host:port/log/sessions?page=1&per_page=10","type":"string"}},"type":"object","required":["href"]},{"description":"The current page link."}]},"show":{"allOf":[{"description":"Hal link","properties":{"href":{"description":"The hypertext reference describing this link.","example":"schema://host:port/log/sessions?page=1&per_page=10","type":"string"}},"type":"object","required":["href"]},{"description":"Show Call Quality link."}]}}}}},"example":{"count":10,"page":1,"per_page":10,"total":10,"total_pages":5,"_embedded":[{"call_id":"CA669d7b6a-541d-4e73-b219-e48a56109cc5","interaction_id":"7ed53517-9b19-4b73-961d-0d8fe4feb12a","user_id":"669d7b6a54dd4e73b219e48a56109cc5","affected_call":true,"jitter":{"avg":20,"max":78},"mos":{"avg":20,"max":34,"min":19},"rtt":{"avg":74,"max":93.6,"min":54.2},"packets_loss_percentage":10.8,"timestamp":"2020-02-01T10:00:00.000Z"}],"_links":{"first":{"href":"https://api-docs.talkdesk.org/calls/call-quality?page=1&per_page=10"},"last":{"href":"https://api-docs.talkdesk.org/calls/call-quality?page=1&per_page=10"},"next":{"href":"https://api-docs.talkdesk.org/calls/call-quality?page=1&per_page=10"},"prev":{"href":"https://api-docs.talkdesk.org/calls/call-quality?page=1&per_page=10"},"self":{"href":"https://api-docs.talkdesk.org/calls/call-quality?page=1&per_page=10"},"show":{"href":"https://api-docs.talkdesk.org/calls/call-quality?page=1&per_page=10"}}}},"text/csv":{"example":"user,call_id,interaction_id,affected_call,timestamp,jitter_max,jitter_avg,rtt_max,rtt_min,rtt_avg,mos_max,mos_min,mos_avg,packets_loss_percentage\r\n 5e9d7b9c1f740c000112f05d,90u1kcsvoprkq708ht1s,5ed686e719a5ab0039aaea05,false,2020-10-08 15:27:40,5.0,1.69,1.1,1.01,1.1,4.41,4.37,4.4,0.034423407\r\n 5e9d7b9c1f740c000112f05d,90u1kcsvoprkq708ht1s,5ed68ae719e5ab0039aaea05,false,2020-10-08 15:27:40,5.0,1.69,,,,4,.41,4.37,4.4,0.034423407\r\n","schema":{"description":"The csv exported data.","type":"string"}}},"description":"List containing paginated calls quality"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1050004","message":"Constraint violation(s) occurred during input validation."}},"text/csv":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1050004","message":"Constraint violation(s) occurred during input validation."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1050008","message":"Unauthorized"}},"text/csv":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1050008","message":"Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1050009","message":"Forbidden"}},"text/csv":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1050009","message":"Forbidden"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1050002","message":"Page parameter must be greater that 0."}},"text/csv":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1050002","message":"Page parameter must be greater that 0."}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1050004","message":"Constraint violation(s) occurred during input validation."}},"text/csv":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1050004","message":"Constraint violation(s) occurred during input validation."}}}}},"security":[{"GA":["guardian-call-quality:read"]}],"summary":"Get calls quality","tags":["Guardian"]}},"/identity/activities":{"get":{"operationId":"getActivities","summary":"Get activities","description":"Returns the activities list","parameters":[{"name":"contact","in":"query","description":"Populate contact name and id, from contacts API, based on the phone number.","required":false,"schema":{"default":true,"type":"boolean"}},{"name":"filter","in":"query","description":"Allows filtering by using comparison and logical operators.

    \n
  • To search parts of a string within a field of type string then the contains operator should be used.
    \n The syntax is the following: contains(field, 'value')
    • \n
    \n Logical operators are and and or.
    \n When using multiple ANDs and ORs, you should use parentheses to explicitly define the logical operators evaluation order.
    \n (note: this is recommended because the usual precedence rules aren't supported due to an implementation detail).

    \n Examples:\n \n More information here","required":false,"schema":{"maxLength":1600,"type":"string","x-operators":["eq","ne","gt","ge","lt","le","and","or","not","( )","contains"]},"example":"interaction_id eq 'c5572384a4c340c2b326965fdb13ca0e'"},{"name":"order_by","in":"query","description":"The list of fields to sort by.","schema":{"default":"timestamp:desc","type":"string","maxLength":40,"x-sorting_default_order":"desc","x-sorting_fields":["timestamp"]},"example":"score:desc"},{"name":"page","in":"query","description":"Number of the requested page","schema":{"default":1,"minimum":1,"type":"integer"},"example":1},{"name":"per_page","in":"query","description":"Max number of the items in a page","schema":{"default":5,"minimum":1,"maximum":250,"type":"integer"},"example":50}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["count","page","per_page","total","total_pages","_embedded","_links"],"properties":{"count":{"description":"The number of results in the current page.","type":"integer","example":10},"page":{"description":"The current page.","type":"integer","example":1},"per_page":{"description":"The number of results per page.","type":"integer","example":10},"total":{"description":"The total number of results.","type":"integer","example":10},"total_pages":{"description":"The total number of pages.","type":"integer","example":5},"_embedded":{"type":"array","items":{"description":"Contact History view data","type":"object","required":["id","timestamp","contact_id"],"properties":{"id":{"description":"Activity id","type":"integer","example":"2345kj4h234524"},"name":{"description":"Contacts API caller name","type":"string","example":"John Doe"},"contacts_api_id":{"description":"Contacts API caller id","type":"string","example":"John Doe"},"contact_id":{"description":"User contact ID, which can be a phone number, VAT number or any other identifier number","type":"string","example":"753"},"interaction_id":{"description":"Interaction ID","type":"string","example":"c5572384a4c340c2b326965fdb13ca0e"},"timestamp":{"description":"Contact call timestamp.","type":"string","example":"2020-02-12T10:00:00.000Z"},"phone_status":{"description":"Is the contact's number considered safe, suspicious, or high risk?","enum":["HIGH_RISK","SAFE","SUSPICIOUS","ERROR"],"type":"string"},"phone_message":{"description":"Phone validation message","type":"string","example":"valid"},"phone_success":{"description":"Was the validation request successful?","type":"boolean"},"phone_formatted":{"description":"Formatted phone number","type":"string","example":"969-999-999"},"phone_local_format":{"description":"Local formatted phone number","type":"string","example":"969-999-999"},"phone_valid":{"description":"Is the phone number properly formatted and considered valid based on assigned phone numbers available to carriers in that country?","type":"boolean"},"phone_risk_score":{"description":"The phone risk score which estimating how likely the phone number is to be fraudulent. Scores 85+ are high risk.","type":"integer","example":10},"phone_recent_abuse":{"description":"Was there a recent abuse from this number?","type":"boolean"},"phone_voip":{"description":"Is this a VoIP number?","type":"boolean"},"phone_prepaid":{"description":"Is this a prepaid phone?","type":"boolean"},"phone_risky":{"description":"Is this phone marked as risky?","type":"boolean"},"phone_active":{"description":"Is this phone active?","type":"boolean"},"phone_carrier":{"description":"Phone carrier","type":"string","example":"VODAFONE"},"phone_line_type":{"description":"Phone line type","type":"string","example":"VOIP"},"phone_country":{"description":"Phone country","type":"string","example":"PT"},"phone_region":{"description":"Phone region","type":"string","example":"PT"},"phone_dialing_code":{"description":"Phone country dialing code","type":"integer","example":351},"phone_request_id":{"description":"Phone validation request ID","type":"string","example":"requestId1"},"phone_call_attestation_type":{"description":"Phone call attestation type","type":"string","example":"TN-Validation-Passed-C"},"phone_call_attestation_valid":{"description":"Phone call attestation result","type":"boolean"},"voice_operation":{"description":"Is the voice operation a consent, enroll, verify or delete","enum":["VERIFY","DELETE","ENROLL","CONSENT"],"type":"string"},"voice_risk_score":{"description":"Voice authentication risk score","type":"number","example":40},"voice_result":{"description":"Is the voice result a success, failure, error, allowed, not_allowed, refused, no_speech, utterance_failure, deep_fake, replay_attack or second_speaker","type":"object","properties":{"result":{"description":"The result of the activity.","enum":["SUCCESS","FAILURE","ALLOWED","NOT_ALLOWED","REFUSED"],"example":"SUCCESS","type":"string","nullable":false},"error_details":{"description":"Error details if Result has the value \"FAILURE\"","properties":{"error_code":{"type":"string","example":"02001","nullable":false},"error_message":{"type":"string","example":"Operation failed","nullable":false}},"type":"object","required":["error_code","error_message"]}},"required":["result"]},"overall_risk_score":{"description":"Risk score combined between phone and voice scores","type":"number","example":50},"is_deleted":{"description":"Is this contact deleted?","type":"boolean"},"phone_number":{"description":"Phone number","type":"string","example":"969999999"},"voice_type":{"description":"Whether the voice authentication is active or passive","enum":["ACTIVE","PASSIVE"],"type":"string"}}}},"_links":{"type":"object","description":"The paginated links.","required":["first","last","next","prev","self","show"],"properties":{"first":{"description":"The first page link.","required":["href"],"properties":{"href":{"description":"The hypertext reference describing this link.","example":"https://api.talkdeskstg.com/identity?page=1&per_page=10","type":"string"}},"type":"object"},"last":{"description":"The last page link.","required":["href"],"properties":{"href":{"description":"The hypertext reference describing this link.","example":"https://api.talkdeskstg.com/identity?page=1&per_page=10","type":"string"}},"type":"object"},"next":{"description":"The next page link.","required":["href"],"properties":{"href":{"description":"The hypertext reference describing this link.","example":"https://api.talkdeskstg.com/identity?page=1&per_page=10","type":"string"}},"type":"object"},"prev":{"description":"The previous page link.","required":["href"],"properties":{"href":{"description":"The hypertext reference describing this link.","example":"https://api.talkdeskstg.com/identity?page=1&per_page=10","type":"string"}},"type":"object"},"self":{"description":"The current page link.","required":["href"],"properties":{"href":{"description":"The hypertext reference describing this link.","example":"https://api.talkdeskstg.com/identity?page=1&per_page=10","type":"string"}},"type":"object"},"show":{"description":"Show current link.","required":["href"],"properties":{"href":{"description":"The hypertext reference describing this link.","example":"https://api.talkdeskstg.com/identity?page=1&per_page=10","type":"string"}},"type":"object"}}}}},"example":{"count":10,"page":1,"per_page":10,"total":10,"total_pages":5,"_embedded":[{"id":1889,"contact_id":"753","interaction_id":"c5572384a4c340c2b326965fdb13ca0e","timestamp":"2022-08-23T10:36:17.803596Z","phone_status":"SAFE","phone_message":"valid","phone_success":true,"phone_formatted":"969-999-999","phone_local_format":"969-999-999","phone_valid":true,"phone_risk_score":10,"phone_recent_abuse":false,"phone_voip":true,"phone_prepaid":false,"phone_risky":false,"phone_active":true,"phone_carrier":"VODAFONE","phone_line_type":"VoIP","phone_country":"PT","phone_region":"PT","phone_dialing_code":351,"phone_request_id":"requestId1","phone_call_attestation_type":"TN-Validation-Passed-C","phone_call_attestation_valid\"":true,"voice_operation":"VERIFY","voice_risk_score":27.99999713897705,"voice_result":{"result":"SUCCESS"},"overall_risk_score":27.99999713897705,"is_deleted":false,"phone_number":"+351912345678","voice_type":"PASSIVE"}],"_links":{"first":{"href":"https://api-docs.talkdesk.org/identity/activities?filter=voice_type%20eq%20%27PASSIVE%27%20and%20contact_id%20eq%20%27753%27%20and%20%20interaction_id%20eq%20%27c5572384a4c340c2b326965fdb13ca0e%27&page=2"},"last":{"href":"https://api-docs.talkdesk.org/identity/activities?filter=voice_type%20eq%20%27PASSIVE%27%20and%20contact_id%20eq%20%27753%27%20and%20%20interaction_id%20eq%20%27c5572384a4c340c2b326965fdb13ca0e%27&page=10"},"next":{"href":"https://api-docs.talkdesk.org/identity/activities?filter=voice_type%20eq%20%27PASSIVE%27%20and%20contact_id%20eq%20%27753%27%20and%20%20interaction_id%20eq%20%27c5572384a4c340c2b326965fdb13ca0e%27&page=3"},"prev":{"href":"https://api-docs.talkdesk.org/identity/activities?filter=voice_type%20eq%20%27PASSIVE%27%20and%20contact_id%20eq%20%27753%27%20and%20%20interaction_id%20eq%20%27c5572384a4c340c2b326965fdb13ca0e%27&page=1"},"self":{"href":"https://api-docs.talkdesk.org/identity/activities?filter=voice_type%20eq%20%27PASSIVE%27%20and%20contact_id%20eq%20%27753%27%20and%20%20interaction_id%20eq%20%27c5572384a4c340c2b326965fdb13ca0e%27"},"show":{"href":"https://api-docs.talkdesk.org/identity/activities?page=1&per_page=10"}}}}},"description":"Contact voice authentication history response"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1910003","message":"A constraint violation error has occurred."}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1910010","message":"Unauthorized"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1910009","message":"Forbidden"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1910001","message":"Phone quality service not available."}}},"description":"Not Found"}},"security":[{"GA":["identity-activity:read"]}],"tags":["Identity"]}},"/identity/phonevalidations/{phone_number}":{"get":{"description":"Get a phone number validation data","operationId":"getPhoneValidation","parameters":[{"name":"phone_number","in":"path","description":"Phone number","required":true,"schema":{"type":"string","minimum":1,"maximum":24},"example":"+351999999999"}],"responses":{"200":{"content":{"application/json":{"schema":{"description":"Phone validation parameters page","properties":{"_embedded":{"description":"Phone validation parameters.","properties":{"active":{"description":"Is this phone number a live usable phone number that is currently active?","type":"string"},"carrier":{"description":"The carrier (service provider) this phone number has been assigned to or \"N/A\" if unknown.","type":"string"},"country":{"description":"The two character country code for this phone number.","type":"string"},"do_not_call":{"description":"Is this phone number listed on any Do Not Call (DNC) lists? (only supported in US and CA) This data may not be 100% up to date with the latest DNC blacklists","type":"string"},"fraud_score":{"description":"The phone risk score which estimating how likely the phone number is to be fraudulent. Scores 85+ are high risk.","format":"int32","type":"integer"},"id":{"description":"Phone number","type":"string"},"leaked":{"description":"Has this phone number recently been exposed in an online database breach or act of compromise, if available, or \"N/A\" if unknown.","type":"string"},"line_type":{"description":"The type of line this phone number is associated with (Toll Free, Mobile, Landline, Satellite, VOIP, Premium Rate, Pager, etc...) or \"N/A\" if unknown.","type":"string"},"prepaid":{"description":"Is this phone number associated with a prepaid service plan?","type":"string"},"recent_abuse":{"description":"Has this phone number been associated with recent or ongoing fraud?","type":"string"},"region":{"description":"Region (state) of the phone number if available or \"N/A\" if unknown.","type":"string"},"risky":{"description":"Is this phone number associated with fraudulent activity, scams, robo calls, fake accounts, or other unfriendly behavior?","type":"string"},"spammer":{"description":"Indicates if the phone number has recently been reported for spam or harassing calls/texts, if available, or \"N/A\" if unknown.","type":"string"},"status":{"description":"Is the number considered safe, suspicious, or high risk?","enum":["HIGH_RISK","SAFE","SUSPICIOUS","ERROR"],"type":"string"},"valid":{"description":"Is the phone number properly formatted and considered valid based on assigned phone numbers available to carriers in that country?","type":"boolean"},"voip":{"description":"Is this phone number a Voice Over Internet Protocol (VOIP) or digital phone number?","type":"string"}},"type":"object"},"_links":{"properties":{"self":{"description":"Show self link.","required":["href"],"properties":{"href":{"description":"The hypertext reference describing this link.","example":"https://api.talkdeskstg.com/identity?page=1&per_page=10","type":"string"}},"type":"object"}},"type":"object","description":"This page reference links"}},"type":"object"},"example":{"_embedded":{"id":"+1999999999","status":"SAFE","valid":true,"active":"true","fraud_score":10,"recent_abuse":"true","voip":"true","prepaid":"true","risky":"true","carrier":"Vodafone","line_type":"Wireless","country":"PT","do_not_call":"true","success":true},"_links":{"self":{"href":"https://api-docs.talkdesk.org/identity/phonevalidations/%2B1999999999"}}}}},"description":"Phone validation data"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1910003","message":"A constraint violation error has occurred."}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1910010","message":"Unauthorized"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1910009","message":"Forbidden"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1910001","message":"Phone quality service not available."}}},"description":"Not Found"}},"security":[{"GA":["identity-phone-validation:read"]}],"summary":"Get a phone number validation data","tags":["Identity"]}},"/identity/phonevalidations/{phone_number}/stats":{"get":{"description":"Get a phone number validation stats","operationId":"getPhoneValidationStats","parameters":[{"name":"phone_number","in":"path","description":"Phone number","required":true,"schema":{"type":"string","minimum":1,"maximum":24},"example":"+351999999999"}],"responses":{"200":{"content":{"application/json":{"schema":{"description":"Phone validation stats parameters page","properties":{"_embedded":{"description":"Phone validation stats.","properties":{"phone_number":{"description":"Phone number","type":"string"},"number_validations_last_24h":{"description":"The number of validations that have been performed on this number in the last 24h","type":"integer"}}},"_links":{"properties":{"self":{"description":"Show self link.","required":["href"],"properties":{"href":{"description":"The hypertext reference describing this link.","example":"https://api.talkdeskstg.com/identity?page=1&per_page=10","type":"string"}},"type":"object"}},"type":"object","description":"This page reference links"}},"type":"object"},"example":{"_embedded":{"phone_number":"+1999999999","number_validations_last_24h":3},"_links":{"self":{"href":"https://api-docs.talkdesk.org/identity/phonevalidations/%2B1999999999/stats"}}}}},"description":"Phone validation data"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1910003","message":"A constraint violation error has occurred."}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1910010","message":"Unauthorized"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1910009","message":"Forbidden"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1910001","message":"Phone quality service not available."}}},"description":"Not Found"}},"security":[{"GA":["identity-phone-validation:read"]}],"summary":"Get a phone number validation data","tags":["Identity"]}},"/interactions/{interaction_id}/actions/start_recording":{"post":{"description":"Starts a recording for an ongoing interaction where an agent is in conversation with a contact person","security":[{"GA":["interactions:control-recordings"]}],"parameters":[{"name":"interaction_id","in":"path","description":"The id of the interaction","required":true,"schema":{"type":"string"}}],"tags":["Interactions"],"requestBody":{"description":"The specification of the recording","content":{"application/json":{"schema":{"type":"object","properties":{"recording_target":{"type":"string","maxLength":35,"enum":["consultation","conversation"]}}}}}},"responses":{"204":{"description":"Recording started"},"400":{"description":"Invalid request parameters","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"code":{"type":"string"},"message":{"type":"string"}}},"examples":{"Example 0":{"value":{"code":"0020007","message":"Invalid JSON in request body"}},"Example 1":{"value":{"code":"0020009","message":"Missing parameter call SID or interaction ID"}},"Example 2":{"value":{"code":"0000021","message":"Invalid Recording Parameters."}}}}}},"404":{"description":"Interaction not found","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"code":{"type":"string"},"message":{"type":"string"}}},"example":{"code":"0020008","message":"Call entry with interaction_id={interaction_id} not found"}}}},"409":{"description":"Interaction state does not allow action","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"code":{"type":"string"},"message":{"type":"string"}}},"example":{"code":"0020010","message":"Cannot start recording when recording_call was already true"}}}}}}},"/interactions/{interaction_id}/actions/pause_recording":{"post":{"description":"Pauses a recording for an ongoing interaction where an agent is in conversation with a contact person","security":[{"GA":["interactions:control-recordings"]}],"parameters":[{"name":"interaction_id","in":"path","description":"The id of the interaction","required":true,"schema":{"type":"string"}}],"tags":["Interactions"],"requestBody":{"description":"The specification of the recording","content":{"application/json":{"schema":{"type":"object","properties":{"recording_target":{"type":"string","maxLength":35,"enum":["consultation","conversation"]}}}}}},"responses":{"204":{"description":"Recording paused"},"400":{"description":"Invalid request parameters","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"code":{"type":"string"},"message":{"type":"string"}}},"examples":{"Example 0":{"value":{"code":"0020007","message":"Invalid JSON in request body"}},"Example 1":{"value":{"code":"0020009","message":"Missing parameter call SID or interaction ID"}},"Example 2":{"value":{"code":"0000021","message":"Invalid Recording Parameters."}}}}}},"404":{"description":"Interaction not found","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"code":{"type":"string"},"message":{"type":"string"}}},"example":{"code":"0020008","message":"Call entry with interaction_id={interaction_id} not found"}}}},"409":{"description":"Interaction state does not allow action","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"code":{"type":"string"},"message":{"type":"string"}}},"example":{"code":"0020010","message":"Cannot pause recording when recording_call was already false"}}}}}}},"/interactions/{interaction_id}/announcement":{"post":{"description":"Play an announcement in an interaction. Example -> Play a beep to announce that the call is being recorded.","security":[{"EarlyAccess":["interactions-announcement:write"]}],"parameters":[{"name":"interaction_id","in":"path","description":"The id of the interaction","required":true,"schema":{"type":"string"}}],"tags":["Interactions"],"requestBody":{"description":"The url to the mp3 file","required":true,"content":{"application/json":{"schema":{"description":"URL to a valid mp3 to be announced in the interaction","properties":{"mp3_file_url":{"description":"The url to the mp3 file","example":"https://www.examplesound.com/examples/mp3/example.mp3","type":"string"}},"required":["mp3_file_url"],"type":"object"}}}},"responses":{"200":{"description":"Announcement Successful"},"400":{"description":"The request parameters are invalid.","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"code":{"type":"string"},"message":{"type":"string"}}},"examples":{"Example 0":{"value":{"code":"0020006","message":"Missing parameter(s)"}},"Example 1":{"value":{"code":"0020007","message":"Invalid JSON in request body"}},"Example 2":{"value":{"code":"0020014","message":"Url for the audio is not valid"}}}}}},"401":{"description":"Account not authorized","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"code":{"type":"string"},"message":{"type":"string"}}},"example":{"code":"0020002","message":"Invalid authentication"}}}},"403":{"description":"Forbidden access, can't find the required scope in the JWT.","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"code":{"type":"string"},"message":{"type":"string"}}},"example":{"code":"0020003","message":"Invalid account_id"}}}},"404":{"description":"Interaction not found","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"code":{"type":"string"},"message":{"type":"string"}}},"examples":{"Example 0":{"value":{"code":"0020008","message":"Invalid fields"}},"Example 1":{"value":{"code":"0020004","message":"Account not found"}},"Example 2":{"value":{"code":"0020013","message":"Provider resource not found"}},"Example 3":{"value":{"code":"0020016","message":"Invalid call state"}}}}}},"406":{"description":"Provider unsupported action","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"code":{"type":"string"},"message":{"type":"string"}}},"example":{"code":"0020012","message":"Unsupported action from provider"}}}}}}},"/messages":{"post":{"description":"Use the channel to send an SMS","security":[{"EarlyAccess":["messages:write"]}],"tags":["Messages"],"parameters":[],"responses":{"202":{"description":"The message was accepted to be delivered","content":{"application/json":{"schema":{"example":{"id":"8b62e0c6001548d7b59f8240d79cb0d7","contact_phone_number":"+123456789000","talkdesk_phone_number":"+351999999999","body":"Lorem Ipsum","_links":{"self":{"href":"http://api-docs.talkdesk.org/messages/8b62e0c6001548d7b59f8240d79cb0d7"}}},"type":"object","additionalProperties":false,"required":["id"],"allOf":[{"type":"object","required":["body"],"properties":{"talkdesk_phone_number":{"type":"string","description":"The E.164 compliant phone number sending the message"},"contact_phone_number":{"type":"string","description":"The E.164 compliant phone number receiving the message"},"body":{"type":"string","description":"The content of the message to be delivered"}}},{"properties":{"id":{"type":"string"},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","default":"http://api-docs.talkdesk.org/messages/:id"}}}}}}}]}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0440004","message":"Invalid request to send a message"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0440005","message":"The request is not authorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0440006","message":"The request is forbidden"}}}}},"requestBody":{"description":"The body of the request","content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"talkdesk_phone_number":{"type":"string","description":"The E.164 compliant phone number sending the message"},"contact_phone_number":{"type":"string","description":"The E.164 compliant phone number receiving the message"},"body":{"type":"string","description":"The content of the message to be delivered"}}}}}}}},"/numbers":{"get":{"deprecated":true,"description":"[DEPRECATED: use Phone Details API instead] Get numbers belonging to the account","security":[{"EarlyAccess":["numbers:read"]}],"parameters":[{"in":"query","name":"page","description":"Number of the desired page (minimum value of 1).","required":true,"schema":{"type":"integer","default":1}},{"in":"query","name":"per_page","description":"Amount of phone numbers per page (minimum value of 1 and maximum of 1000).","required":true,"schema":{"type":"integer","default":50}},{"in":"query","name":"sip","description":"Identifies if phone number is SIP.","required":false,"schema":{"type":"boolean"}},{"in":"query","name":"phone_number","description":"Filter numbers by phone number","required":false,"schema":{"type":"string"}}],"tags":["Numbers"],"responses":{"200":{"description":"List of numbers for the account","content":{"application/json":{"schema":{"example":{"total":2,"page":2,"count":2,"per_page":2,"_embedded":{"phone_numbers":[{"id":"59df62c81507b35a7cf2bbd3","phone_number":"+351233391919","friendly_name":"Phone Number Example 1","dedicated_line":false,"sip":false,"capabilities":["mms","sms"],"_links":{"self":{"href":"https://api-docs.talkdesk.org/numbers/59df62cf1507b35a7cf2bbd4"},"interaction_triggers":{"href":"https://api-docs.talkdesk.org/numbers/59df62cf1507b35a7cf2bbd4/interaction_triggers"}}},{"id":"59df62cf1507b35a7cf2bbd4","phone_number":"+351213967870","friendly_name":"Phone Number Example 2","dedicated_line":true,"sip":false,"capabilities":["fax","voice"],"_links":{"self":{"href":"https://api-docs.talkdesk.org/numbers/59df62cf1507b35a7cf2bbd4"},"interaction_triggers":{"href":"https://api-docs.talkdesk.org/numbers/59df62cf1507b35a7cf2bbd4/interaction_triggers"}}}]},"_links":{"self":{"href":"https://api-docs.talkdesk.org/numbers?page=2&per_page=2"},"next":{"href":"https://api-docs.talkdesk.org/numbers?page=3&per_page=2"},"previous":{"href":"https://api-docs.talkdesk.org/numbers?page=1&per_page=2"}}},"type":"object","required":["id","phone_number","friendly_name","dedicated_line"],"properties":{"id":{"type":"string","description":"the ID for the phone number"},"phone_number":{"type":"string","description":"the phone number in E.164 format"},"friendly_name":{"type":"string","description":"the friendly name for the phone number"},"dedicated_line":{"type":"boolean","description":"if the phone number is a dedicated line or not"},"sip":{"type":"boolean","description":"if the phone number is SIP"},"capabilities":{"type":"array","description":"The phone number's supported capabilities (e.g. SMS, Voice, MMS, etc.)"},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string"}}},"interaction_triggers":{"type":"object","properties":{"href":{"type":"string"}}}}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Example 0":{"value":{"code":"0060001","message":"Access denied."}},"Example 1":{"value":{"code":"0140001","message":"Missing Authorization Header"}}}}}},"403":{"description":"Forbidden access","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Example 0":{"value":{"code":"0140002","message":"Forbidden"}},"Example 1":{"value":{"code":"0140002","message":"Forbidden"}}}}}},"404":{"description":"Number not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0140006","message":"Number not found"}}}}}}},"/numbers/{number_id}":{"get":{"deprecated":true,"description":"[DEPRECATED: use Phone Details API instead] Get number details given a unique identification","security":[{"EarlyAccess":["numbers:read"]}],"parameters":[{"in":"path","name":"number_id","description":"Number id","required":true,"schema":{"type":"string"}}],"tags":["Numbers"],"responses":{"200":{"description":"Number details","content":{"application/json":{"schema":{"example":{"id":"59df62c81507b35a7cf2bbd3","phone_number":"+351233391919","friendly_name":"Phone Number Example 1","dedicated_line":false,"sip":false,"_links":{"self":{"href":"https://api-docs.talkdesk.org/numbers/59df62c81507b35a7cf2bbd3"},"interaction_triggers":{"href":"https://api-docs.talkdesk.org/numbers/59df62c81507b35a7cf2bbd3/interaction_triggers"}}},"type":"object","required":["id","phone_number","friendly_name","dedicated_line"],"properties":{"id":{"type":"string","description":"the ID for the phone number"},"phone_number":{"type":"string","description":"the phone number in E.164 format"},"friendly_name":{"type":"string","description":"the friendly name for the phone number"},"dedicated_line":{"type":"boolean","description":"if the phone number is a dedicated line or not"},"sip":{"type":"boolean","description":"if the phone number is SIP"},"capabilities":{"type":"array","description":"The phone number's supported capabilities (e.g. SMS, Voice, MMS, etc.)"},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string"}}},"interaction_triggers":{"type":"object","properties":{"href":{"type":"string"}}}}}}}}}},"400":{"description":"Invalid parameter","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Example 0":{"value":{"code":"0060001","message":"Access denied."}},"Example 1":{"value":{"code":"0140001","message":"Missing Authorization Header"}}}}}},"403":{"description":"Forbidden access","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Example 0":{"value":{"code":"0140002","message":"Forbidden"}},"Example 1":{"value":{"code":"0140002","message":"Forbidden"}}}}}},"404":{"description":"Number not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0140006","message":"Number not found"}}}}}}},"/oauth/token":{"post":{"description":"Obtain a new access token","tags":["Authentication"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization header containing the client authentication, supported via HTTP Basic Auth with the client’s client_id and client_secret. Required if not using a signed JWT assertion (as per the \"private_key_jwt\" mechanism of OpenID Connect)","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The access token (and optional refresh token) generated, along with some additional properties about the authorization","content":{"application/json":{"schema":{"type":"object","required":["access_token","token_type","expires_in","scope"],"properties":{"access_token":{"type":"string","description":"The access token"},"token_type":{"type":"string","description":"The type of token to be specified in the Authorization header","default":"Bearer"},"expires_in":{"type":"integer","description":"Duration of time (seconds) the access token is granted for"},"scope":{"type":"string","description":"A space-separated list of scopes (URL encoded) the client requested access to. If \"scope\" parameter was not provided in the request body parameter, the returned value will be the list of scopes the client granted"},"refresh_token":{"type":"string","description":"The refresh token used to obtain another access token. Required only when using \"authorization_code\" and \"refresh_token\" grant types"},"sid":{"type":"string","description":"The session ID of the user authenticated during the authorization code flow. Required only when using \"authorization_code\" and \"refresh_token\" grant types"},"id_token":{"type":"string","description":"The ID token (OpenID Connect functionality to return information about the authentication performed during the authorization code flow). Required only when using \"authorization_code\" grant type and if \"openid\" scope was included in the \"scope\" parameter provided in the \"/oauth/authorize\" request query parameter\n"}}},"examples":{"Client Credentials response":{"value":{"access_token":"IsImF1ZCI6Imh0dHBXBp","token_type":"Bearer","expires_in":599,"scope":"openid account:read apps:write contacts:read"}},"Authorization Code response":{"value":{"access_token":"IsImF1ZCI6Imh0dHBXBp","token_type":"Bearer","refresh_token":"NDYyNGUyYTVlNWM3TWEz","expires_in":599,"scope":"openid account:read apps:write contacts:read","sid":"02048a5163b7464867bb0618fd1f03yy","id_token":"eyJraWQiOiJkYWhwaHVz"}},"Refresh Token response":{"value":{"access_token":"IsImF1ZCI6Imh0dHBXBp","token_type":"Bearer","refresh_token":"NDYyNGUyYTVlNWM3TWEz","expires_in":599,"scope":"account:read apps:write contacts:read","sid":"02048a5163b7464867bb0618fd1f03yy"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["error","error_description"],"properties":{"error":{"type":"string"},"error_description":{"type":"string"}}},"example":{"error":"invalid_request","error_description":"Missing grant type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["error","error_description"],"properties":{"error":{"type":"string"},"error_description":{"type":"string"}}},"example":{"error":"unauthorized","error_description":"No refresh token specified"}}}}},"requestBody":{"description":"The Authentication parameters","content":{"application/x-www-form-urlencoded":{"schema":{"additionalProperties":true,"discriminator":{"propertyName":"grant_type"},"type":"object","required":["grant_type"],"properties":{"grant_type":{"type":"string","description":"The grant type used for authentication","enum":["client_credentials","authorization_code","refresh_token"]},"code":{"type":"string","description":"Authorization code received from the \"/oauth/authorize\" request in the redirect URI. Required only when using \"authorization_code\" grant type"},"redirect_uri":{"type":"string","description":"Redirect URI included in the \"/oauth/authorize\" request. Optional, used when grant type is \"authorization_code\""},"refresh_token":{"type":"string","description":"Refresh token previously issued in the authorization code flow. Required only when using \"refresh_token\" grant type"},"token_type":{"type":"string","description":"Defaults to jwt. Required only for Service Tokens emission.","enum":["opaque"]},"expires_in":{"type":"string","description":"Lifetime of the requested token. Optional, and only applicable when requesting service tokens. Min: 1 day (86400 seconds). Max: 1 year (31556952 seconds)"},"scope":{"type":"string","description":"A space-separated list of scopes (URL encoded) the client is requesting access to. Optional, used only when requesting with \"client_credentials\" and \"refresh_token\" grant types. Whenever a new access token is being issued using \"refresh_token\" grant type, the requested scope must not include additional scopes that were not issued in the original access token and, if omitted, the new access token will be issued with the same scope as was previously issued\n"},"client_assertion_type":{"type":"string","description":"The type of signed JWT assertion (it must be \"urn:ietf:params:oauth:client-assertion-type:jwt-bearer\"). Required if not using HTTP Basic Auth in the Authorization header","enum":["urn:ietf:params:oauth:client-assertion-type:jwt-bearer"]},"client_assertion":{"type":"string","description":"Signed JWT assertion (as per the \"private_key_jwt\" mechanism of OpenID Connect). Required if not using HTTP Basic Auth in the Authorization header"}}},"examples":{"Client Credentials request":{"value":{"grant_type":"client_credentials","scope":"account:read apps:write contacts:read","client_assertion_type":"urn:ietf:params:oauth:client-assertion-type:jwt-bearer","client_assertion":"eyJraWQiOiJjZTdhNjYy"}},"Authorization Code request":{"value":{"grant_type":"authorization_code","code":"TmVlY2IyZlhhYzVmNDAx","redirect_uri":"https://talkdeskaccountname.talkdeskid.com","client_assertion_type":"urn:ietf:params:oauth:client-assertion-type:jwt-bearer","client_assertion":"eyJraWQiOiJjZTdhNjYy"}},"Refresh Token request":{"value":{"grant_type":"refresh_token","scope":"account:read apps:write contacts:read","refresh_token":"NDYyNGUyYTVlNWM3TWEz","client_assertion_type":"urn:ietf:params:oauth:client-assertion-type:jwt-bearer","client_assertion":"eyJraWQiOiJjZTdhNjYy"}},"Service Token request":{"value":{"grant_type":"client_crendentials","scope":"account:read apps:write contacts:read","token_type":"opaque"}}}}}}}},"/oauth/authorize":{"get":{"description":"Obtain a new authorization code","parameters":[{"name":"client_id","in":"query","description":"The client ID provided in your client information set","required":true,"schema":{"type":"string"}},{"name":"redirect_uri","in":"query","description":"A registered redirect URI where the user is going to be redirected to with the authorization code","required":true,"schema":{"type":"string"}},{"name":"response_type","in":"query","description":"The value \"code\" tells the authorization server that the authorization code flow is initiating","required":true,"schema":{"type":"string"}},{"name":"scope","in":"query","description":"A space-separated list of scopes (URL encoded) the client is requesting access to","schema":{"type":"string"}},{"name":"state","in":"query","description":"A random string, used to prevent CSRF attacks, that will be passed through untouched to the callback with the code","schema":{"type":"string"}},{"name":"nonce","in":"query","description":"A random string, used to prevent replay attacks, that will be passed through untouched to the ID token","schema":{"type":"string"}}],"tags":["Authentication"],"responses":{"302":{"description":"The redirect URI with a \"code\" and the \"state\" parameter provided in the request query parameter","headers":{"Location":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["header","error","error_description"],"properties":{"header":{"type":"string"},"error":{"type":"string"},"error_description":{"type":"string"}}},"example":{"header":"OAuth Error","error":"invalid_grant","error_description":"Invalid redirect: null does not match one of the registered values: [https://oauth.pstmn.io/v1/callback]"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["header","error","error_description"],"properties":{"header":{"type":"string"},"error":{"type":"string"},"error_description":{"type":"string"}}},"example":{"header":"OAuth Error","error":"invalid_client","error_description":"Bad client credentials"}}}}}}},"/oauth/introspect":{"post":{"description":"Obtain a service token status","tags":["Authentication"],"requestBody":{"description":"Token identification credential to retrieve status information","content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","required":["token"],"properties":{"token":{"type":"string","description":"Token credential information"}}},"examples":{"Introspect Token request":{"value":{"token":"tdst_ZTIyZjNhZTgxODM3NGQwNWJkMjQxY2U2NjNlMzM1NDN8SEh4Yll"}}}}}},"responses":{"200":{"description":"Document containing comprehensive metadata about the token, including whether the token is currently active.","content":{"application/json":{"schema":{"type":"object","required":["kid","sig","token_introspection"],"properties":{"kid":{"type":"string","description":"The identification number for the key pair used to sign the API response"},"sig":{"type":"string","description":"The signature value obtained from the base64 URL encoded JSON metadata of the \"token_introspection\" response parameter. It is calculated using the signature algorithm specified in the OAuth certificate endpoint. The calculation involves applying the designated signature algorithm on the base64 URL encoded \"token_introspection\" payload and then base64 URL encoding the result. E.g - \"base64UrlEncode(HMACSHA256(base64UrlEncode(tokenIntrospectionPayload)))\"\n"},"token_introspection":{"type":"object","required":["active"],"properties":{"active":{"type":"boolean","description":"Indicator of whether or not the presented token is currently active"},"iss":{"type":"string","description":"The issuer of this token. This will correspond to the Talkdesk ID subdomain for the token's account"},"aud":{"type":"string","description":"The intended audience for this token. This will correspond, for example, to the API Gateway's URL for the corresponding environment"},"exp":{"type":"integer","description":"Timestamp, measured in the number of seconds since January 1 1970 UTC, indicating when this token will expire"},"nbf":{"type":"integer","description":"Timestamp, measured in the number of seconds since January 1 1970 UTC, indicating when this token is not to be used before"},"iat":{"type":"integer","description":"Timestamp, measured in the number of seconds since January 1 1970 UTC, indicating when this token was originally issued"},"cid":{"type":"string","description":"Client identifier for the client that requested this token"},"aid":{"type":"string","description":"The Account ID of the Talkdesk Account this token belongs to"},"scp":{"type":"string","description":"A space-separated list of scopes (URL encoded) the client requested access to"},"reg":{"type":"string","description":"Cloud provider region where the token was generated"},"psn":{"description":"The persona of the client","type":"string","enum":["INTERNAL","CUSTOMER","PARTNER","INTERNAL_RESTRICTED"],"example":"CUSTOMER"}}}}},"examples":{"Active Token":{"value":{"kid":"AABC0B99C6C1563F9978CB9BF1C7CC66","sig":"MEUCIQCVOvsGEU8gqqEu9Mg-EmzZR5R7DNb0EXZiwHYaedpsLQIgFWNrDD6Dkm4EmpaAHoMHxS_oBr5vYt8sop8v3bfx16s=","token_introspection":{"active":true,"iss":"https://server.example.com/","aud":"https://rs.example.com/resource","exp":1514797942,"nbf":1514797942,"iat":1514797822,"cid":"36f01a8a9fa64afea09b74ed0a2c1a2a","aid":"614cc2eb161fb0e416eb7288","scp":"openid account:read apps:write contacts:read","reg":"us-west-1","psn":"INTERNAL"}}},"Inactive Token":{"value":{"kid":"AABC0B99C6C1563F9978CB9BF1C7CC66","sig":"MEUCIAIMum7JYNgOrlXse8BW7_vUkBGdRd37Fa8gc1EgVdt7AiEAxoWRb4xPBEMNNmWQYZXWzuHkfiJ3YGRQ0a2EX_I89VI=","token_introspection":{"active":false}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Missing Request Parameter":{"value":{"code":"0070201","message":"Missing request parameter token"}}}}}}}}},"/oauth/certs":{"get":{"description":"Obtains the public server JWK set URL.","deprecated":true,"tags":["Authentication"],"responses":{"200":{"description":"The public server JWK set URL.","content":{"application/json":{"schema":{"type":"object","required":["keys"],"properties":{"keys":{"type":"array","description":"The value of the \"keys\" parameter is an array of JWK values","items":{"type":"object","required":["kty"],"properties":{"kty":{"type":"string","description":"The key type parameter identifies the cryptographic algorithm family used with the key, such as RSA or EC"},"use":{"type":"string","description":"public key use parameter identifies the intended use of the public key."},"kid":{"type":"string","description":"The key ID parameter is used to match a specific key."},"alg":{"type":"string","description":"The algorithm parameter identifies the algorithm intended for use with the key"},"crv":{"type":"string","description":"JWA public key algorithm name"},"x":{"type":"string","description":"the public key x-coordinate"},"y":{"type":"string","description":"the public key y-coordinate"},"n":{"type":"string","description":"the RSA key modulus"},"e":{"type":"string","description":"the RSA public key exponent"},"x5c":{"type":"array","description":"The public key","items":{"type":"string","description":"The public key"}},"x5t":{"type":"string","description":"The X.509 certificate SHA-1 thumbprint parameter is a base64url-encoded SHA-1 thumbprint (a.k.a. digest) of the DER encoding of an X.509 certificate [RFC5280]"}}}}}},"examples":{"EC JWK set URLs response":{"value":{"keys":[{"kty":"EC","use":"sig","kid":"8ff0687ae8054517b092d4aa12189428","alg":"ES256","crv":"P-256","x":"VmjJnDjDkvVHLc3XXL_1QmyXEJXAz4u3JYqUcUffP6g","y":"ebaAu1giwcYG7-IkKA5JTrExBNhn9TmqX52hSVhV2WU","x5c":["MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEVmjJnDjDkvVHLc3XXL/1QmyXEJXAz4u3JYqUcUffP6h5toC7WCLBxgbv4iQoDklOsTEE2Gf1OapfnaFJWFXZZQ=="],"x5t":"NmIyZTdmMWRkNzgzNjY2YWU2NjRjYjIwMTMzZWYzN2MwMGE0YTZjNg"}]}},"RSA JWK set URLs response":{"value":{"keys":[{"kty":"RSA","use":"sig","kid":"3dadc7d9d14d428ab8ba23823651a5c1","alg":"RS256","n":"AK_q6qrSrLGamawEXHUiRokfomJLpXVY1eYSD27kww-oH8-_8nDCzAQVW0KQD0aH8PwWaIgVPKHZL4BLCC8r_2E","e":"AQAB","x5c":["MFwwDQYJKoZIhvcNAQEBBQADSwAwSAJBAK/q6qrSrLGamawEXHUiRokfomJLpXVY1eYSD27kww+oH8+/8nDCzAQVW0KQD0aH8PwWaIgVPKHZL4BLCC8r/2ECAwEAAQ=="],"x5t":"OWRjMjUyMTMyMzBiOWU4YTU0YWExNDA4ODBmYzczN2U5OGU2MWYyMg"}]}}}}}}}}},"/oauth/2023-10/certs":{"get":{"description":"Obtains the public server JWK set URL.","tags":["Authentication"],"responses":{"200":{"description":"The public server JWK set URL.","content":{"application/json":{"schema":{"type":"object","required":["keys"],"properties":{"keys":{"type":"array","description":"The value of the \"keys\" parameter is an array of JWK values","items":{"type":"object","required":["kty"],"properties":{"kty":{"type":"string","description":"The key type parameter identifies the cryptographic algorithm family used with the key, such as RSA or EC"},"use":{"type":"string","description":"public key use parameter identifies the intended use of the public key."},"kid":{"type":"string","description":"The key ID parameter is used to match a specific key."},"alg":{"type":"string","description":"The algorithm parameter identifies the algorithm intended for use with the key"},"crv":{"type":"string","description":"JWA EC certificate algorithm name"},"x":{"type":"string","description":"the EC certificate x-coordinate"},"y":{"type":"string","description":"the EC certificate y-coordinate"},"n":{"type":"string","description":"the RSA key modulus"},"e":{"type":"string","description":"the RSA public key public exponent"},"x5c":{"type":"array","description":"The X.509 certificate chain parameter contains a chain of one or more PKIX certificates [RFC5280]","items":{"type":"string","description":"PKIX certificate [RFC5280]"}},"x5t":{"type":"string","description":"The X.509 certificate SHA-1 thumbprint parameter is a base64url-encoded SHA-1 thumbprint (a.k.a. digest) of the DER encoding of an X.509 certificate [RFC5280]"}}}}}},"examples":{"EC JWK set URLs response":{"value":{"keys":[{"kty":"EC","use":"sig","kid":"8ff0687ae8054517b092d4aa12189428","alg":"ES256","crv":"P-256","x":"APxSC-rmA_YOBanRNVj4gI6NOnulVNjrMpgpeX4dwmbI","y":"Rpq80PKjRW5dpANKjwB2rQJNl-k17UEiUv2yJC-NnZw","x5c":["MIIBJDCByqADAgECAghKtabutUn1ijAKBggqhkjOPQQDAjAYMRYwFAYDVQQDDA0qLmJhc2UuZG9tYWluMB4XDTIzMTEyMjEwMDExNVoXDTM4MTEyMjEwMDExNVowGDEWMBQGA1UEAwwNKi5iYXNlLmRvbWFpbjBZMBMGByqGSM49AgEGCCqGSM49AwEHA0IABPxSC+rmA/YOBanRNVj4gI6NOnulVNjrMpgpeX4dwmbIRpq80PKjRW5dpANKjwB2rQJNl+k17UEiUv2yJC+NnZwwCgYIKoZIzj0EAwIDSQAwRgIhALT4h3zbVdrHf0MOk5mXYK9c5t7qaMo+XIDAAoaIbUf2AiEA4Kwl6NU1jtIJvP8UVMQzBPBMv+c2miaBnuhbVYxysQE="],"x5t":"MTc4YTFkZWU1OTQ4ZWQxZTBmMDE4MTQ4YzZkMWNjM2IwMDFmMjg4YQ"}]}},"RSA JWK set URLs response":{"value":{"keys":[{"kty":"RSA","use":"sig","kid":"3dadc7d9d14d428ab8ba23823651a5c1","alg":"RS256","n":"AJTXxEEsnN2L3asTL57VNs86A3uL7IMbZrWGfStjkqCWXzBqkKcxJlEJ_E2fNl_dfL0lhOaEzWOshiN5tZfvWuE","e":"AQAB","x5c":["MIIBJTCB0KADAgECAgg7v37bQ7WzPzANBgkqhkiG9w0BAQsFADAYMRYwFAYDVQQDDA0qLmJhc2UuZG9tYWluMB4XDTIzMTEyMjA5NTgxNVoXDTM4MTEyMjA5NTgxNVowGDEWMBQGA1UEAwwNKi5iYXNlLmRvbWFpbjBcMA0GCSqGSIb3DQEBAQUAA0sAMEgCQQCFFo6dFRe45a3lDdol3G+sSzQr6SFhAWOUnL/CgR345js9lIIyVUqWZHg3xyiKBALb/HcBYkuVQA7KETIFpdV3AgMBAAEwDQYJKoZIhvcNAQELBQADQQB6Hj3Y1U4nQ+prq3FJLGjX0p0cBCP9p9ItWqyEAOxhavGYsnm3lRJvH7KYHklhTe2ykhO5XPTbpdMQ70UjMM2i"],"x5t":"MTA4MDFkM2Y0MmE5NmQ4ZWFmZTljYzFlOTZhZjI3MmJkNWQ4NWVmNg"}]}}}}}}}}},"/oauth/end_user_session":{"post":{"description":"Terminates the user session","security":[{"GA":["user-session-public:end"]}],"parameters":[],"tags":["Authentication"],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0070010","message":"Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0070011","message":"Invalid scopes"}}}},"404":{"description":"User not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0070090","message":"User Not Found"}}}}},"requestBody":{"description":"The body of the request","content":{"application/json":{"schema":{"type":"object","required":["user_id"],"properties":{"user_id":{"description":"The user ID for the session termination","type":"string","minLength":24,"maxLength":24},"reason":{"description":"The reason for the session termination","type":"string","enum":["force_logout"]}}},"examples":{"Revoke User Session request":{"value":{"userId":"614cc2eb161fb0e416eb7288","reason":"force_logout"}}}}}}}},"/record-lists":{"get":{"summary":"Get all record lists","x-namespace":"/record-lists","tags":["Record Lists"],"security":[{"EarlyAccess":["record-lists:manage"]}],"parameters":[{"name":"name","in":"query","description":"Filter by record lists names,fuzzy query","schema":{"type":"string","minLength":1,"maxLength":35}},{"name":"status","in":"query","description":"Filter Record Lists by status","schema":{"type":"string","minLength":1}},{"name":"team_id","in":"query","description":"Filter Record Lists by team id. team_id and team_ids are mutually exclusive.","required":false,"schema":{"type":"string"}},{"name":"team_ids","in":"query","description":"Filter Record Lists by team ids. team_id and team_ids are mutually exclusive.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"campaign_ids","in":"query","description":"Filter Record Lists by campaign ids.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"fields","in":"query","description":"Allows to request the sub entities of the record list.

    ","required":false,"schema":{"type":"string","enum":["TEAMS"]}},{"name":"include_none_team","in":"query","description":"If include_none_team equals true, this parameter will also return records lists with no team.","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Number of the page listed","required":false,"schema":{"type":"integer","default":1,"minimum":1,"maximum":2147483647}},{"name":"per_page","in":"query","description":"Number of max items per page","required":false,"schema":{"type":"integer","default":50,"minimum":1,"maximum":500}},{"name":"created_at_from","in":"query","description":"Filter by Record Lists created_at, must filter with field created_at_to","schema":{"type":"string"}},{"name":"created_at_to","in":"query","description":"Filter by Record Lists created_at, must filter with field created_at_from","schema":{"type":"string"}},{"name":"updated_at_from","in":"query","description":"Filter by Record Lists updated_at, must filter with field updated_at_to","schema":{"type":"string"}},{"name":"updated_at_to","in":"query","description":"Filter by Record Lists updated_at, must filter with field updated_at_from","schema":{"type":"string"}},{"name":"order_by","in":"query","description":"Order by Record Lists for names, number of records, created_at, updated_at","schema":{"example":"name,records_count:desc,created_at:desc,updated_at:asc","default":"created_at:desc","x-sorting_default_order":"asc","x-sorting_fields":["name","records_count","created_at","updated_at"],"type":"string"}}],"responses":{"200":{"description":"Get the list of record lists","content":{"application/hal+json":{"schema":{"example":{"total":3,"page":1,"total_pages":3,"per_page":1,"count":3,"_links":{"self":{"href":"https://api.talkdeskapp.com/record-lists/?page=2&per_page=1"},"next":{"href":"https://api.talkdeskapp.com/record-lists/?page=3&per_page=1"},"prev":{"href":"https://api.talkdeskapp.com/record-lists/?page=1&per_page=1"},"first":{"href":"https://api.talkdeskapp.com/record-lists/?page=1&per_page=1"},"last":{"href":"https://api.talkdeskapp.com/record-lists/?page=3&per_page=1"}},"_embedded":{"record_lists":[{"id":"8858c834-481d-4a02-8176-cffc02c50350","name":"list 1","unique_identifier_type":"PHONE_NUMBER","created_at":"2020-03-24T11:48:40.503Z","updated_at":"2020-03-24T11:48:40.503Z","records_count":10,"status":"accepted","account_id":"5cec1886cd9489002de37c18","teams":[{"id":"367ac248e7c6415980bad277d2de91a5","name":"Team A","_links":{"self":{"href":"https://api-docs.talkdesk.org/teams/367ac248e7c6415980bad277d2de91a5"}}}],"campaign_page":[{"total":3,"total_pages":3,"page":1,"per_page":1,"count":3,"_embedded":{"campaigns":[{"id":"367ac248e7c6415980bad277d2de9112","campaign_name":"Campaign A","_links":{"self":{"href":"https://api-docs.talkdesk.org/campaigns/367ac248e7c6415980bad277d2de9112"}}}]},"_links":{"self":{"href":"https://api.talkdeskapp.com/record-lists/8858c834-481d-4a02-8176-cffc02c50350/campaigns?page=2&per_page=1"},"next":{"href":"https://api.talkdeskapp.com/record-lists/8858c834-481d-4a02-8176-cffc02c50350/campaigns?page=3&per_page=1"},"prev":{"href":"https://api.talkdeskapp.com/record-lists/8858c834-481d-4a02-8176-cffc02c50350/campaigns?page=1&per_page=1"},"first":{"href":"https://api.talkdeskapp.com/record-lists/8858c834-481d-4a02-8176-cffc02c50350/campaigns?page=1&per_page=1"},"last":{"href":"https://api.talkdeskapp.com/record-lists/8858c834-481d-4a02-8176-cffc02c50350/campaigns?page=3&per_page=1"}}}],"_links":{"self":{"href":"https://api.talkdeskapp.com/record-lists/8858c834-481d-4a02-8176-cffc02c50350"}}}]}},"description":"List with the paginated samples.","properties":{"total":{"description":"The number of items.","type":"integer"},"per_page":{"description":"The number of items per page.","type":"integer"},"count":{"description":"The total number of items in this page.","type":"integer"},"page":{"description":"The number of the current page.","type":"integer"},"total_pages":{"description":"The total number of pages.","type":"integer"},"_links":{"description":"HAL API related links.","type":"object","properties":{"next":{"description":"Link of the next page.","type":"object","properties":{"href":{"description":"Address of the resource.","type":"string"}},"required":["href"]},"last":{"description":"Link of the last page.","type":"object","properties":{"href":{"description":"Address of the resource.","type":"string"}},"required":["href"]},"prev":{"description":"Link of the previous page.","type":"object","properties":{"href":{"description":"Address of the resource.","type":"string"}},"required":["href"]},"self":{"description":"Link of the current page.","type":"object","properties":{"href":{"description":"Address of the resource.","type":"string"}},"required":["href"]},"first":{"description":"Link of the first page.","type":"object","properties":{"href":{"description":"Address of the resource.","type":"string"}},"required":["href"]}},"required":["self","next","prev","first","last"]},"_embedded":{"properties":{"record_lists":{"description":"List of record lists paginated.","items":{"description":"Record list HAL object.","readOnly":true,"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID of the record list created."},"name":{"type":"string","description":"Record list name."},"unique_identifier_type":{"type":"string","description":"Duplicate checking logic configured for the record list:\n * `PHONE_NUMBER` - Duplicate checking based on the record's phone_number\n * `EXTERNAL` - Duplicate checking based on the record's external_id and external_provider\n * `NOTHING` - No duplicate checking\n"},"created_at":{"type":"string","description":"Record list creation date."},"updated_at":{"type":"string","description":"Record list updated date."},"status":{"type":"string","description":"Status of validation process done on the record list csv file.","enum":["REJECTED","VALIDATION_STARTED","UPLOADED","ACCEPTED","INCOMPLETE","CORRUPTED"]},"records_count":{"type":"integer","description":"How many records are present in the record list."},"teams":{"type":"array","description":"Teams that this record belongs to.","items":{"type":"object","description":"Teams assigned to the record list, if any.","properties":{"id":{"type":"string","description":"The team ID of the record list."},"name":{"type":"string","description":"The team name of the record list."},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string"}}}}}}}},"campaign_page":{"description":"Campaigns associated with the record list.","type":"object","properties":{"total":{"description":"The number of items.","type":"integer"},"per_page":{"description":"The number of items per page.","type":"integer"},"count":{"description":"The total number of items in this page.","type":"integer"},"page":{"description":"The number of the current page.","type":"integer"},"total_pages":{"description":"The total number of pages.","type":"integer"},"_embedded":{"properties":{"campaigns":{"description":"List of campaigns paginated.","items":{"description":"Campaign HAL object.","readOnly":true,"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"External ID of the campaign created."},"campaign_name":{"type":"string","description":"Campaign name."},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string"}}}}}}},"type":"array"}},"type":"object","required":["campaigns"]},"_links":{"description":"HAL API related links.","type":"object","properties":{"next":{"description":"Link of the next page.","type":"object","properties":{"href":{"description":"Address of the resource.","type":"string"}},"required":["href"]},"last":{"description":"Link of the last page.","type":"object","properties":{"href":{"description":"Address of the resource.","type":"string"}},"required":["href"]},"prev":{"description":"Link of the previous page.","type":"object","properties":{"href":{"description":"Address of the resource.","type":"string"}},"required":["href"]},"self":{"description":"Link of the current page.","type":"object","properties":{"href":{"description":"Address of the resource.","type":"string"}},"required":["href"]},"first":{"description":"Link of the first page.","type":"object","properties":{"href":{"description":"Address of the resource.","type":"string"}},"required":["href"]}},"required":["self","next","prev","first","last"]}},"required":["per_page","page","total","_links"]},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string"}}}}}}},"type":"array"}},"type":"object","required":["record_lists"]}},"required":["per_page","page","total","_links"],"type":"object"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530900","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530901","message":"Missing or invalid authentication token."}}}},"403":{"description":"Forbidden","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530902","message":"Insufficient scopes for the requested operation."}}}}}},"post":{"summary":"Create a signed URL to upload a csv file","x-namespace":"/record-lists","tags":["Record Lists"],"description":"Creates a Record List and returns a signed URL which allows to temporarily upload the record list as a csv_file","security":[{"EarlyAccess":["record-lists:manage"]}],"requestBody":{"description":"Record list configuration parameters","required":true,"content":{"application/hal+json":{"schema":{"example":{"name":"RecordList 20","unique_identifier_type":"PHONE_NUMBER","csv_metadata":{"filename":"recordList.csv","byte_size":413,"checksum":"d2c07dcf1589304317056dd7e28e32b8","content_type":"text/csv"}},"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Name of the Record List","minLength":1,"maxLength":120},"unique_identifier_type":{"type":"string","description":"Duplicate checking logic configured for the record list:\n * `PHONE_NUMBER` - Duplicate checking based on the record's phone_number\n * `EXTERNAL` - Duplicate checking based on the record's external_id and external_provider\n * `NOTHING` - No duplicate checking\n","enum":["PHONE_NUMBER","EXTERNAL","NOTHING"],"minLength":7,"maxLength":12},"csv_metadata":{"type":"object","description":"Object containing relevant information about the csv file","properties":{"filename":{"type":"string","description":"Name of the csv file to be uploaded","minLength":1,"maxLength":35},"byte_size":{"type":"integer","description":"Size of the file in bytes","minimum":1,"maximum":100000000},"checksum":{"type":"string","description":"Hash of the file done using the algorithm MD5","minLength":1,"maxLength":32},"content_type":{"type":"string","description":"text/csv","minLength":1,"maxLength":35}}}}}}}},"responses":{"201":{"description":"Created record list and signed URL for the csv file","content":{"application/hal+json":{"schema":{"example":{"id":"d2960556-065f-4c48-b097-355a427ca805","name":"RecordList 20","unique_identifier_type":"PHONE_NUMBER","status":"INCOMPLETE","signed_url":"https://s3.amazonaws.com/app_bucket_name/xkbe7qb3hkgm87pni31ip88n5zr5?X-Amz-Algorithm=AWS4-HMAC-SHA","_links":{"self":{"href":"https://api.talkdeskapp.com/record-lists/d2960556-065f-4c48-b097-355a427ca805"},"upload":{"href":"https://s3.amazonaws.com/app_bucket_name/xkbe7qb3hkgm87pni31ip88n5zr5?X-Amz-Algorithm=AWS4-HMAC-SHA"}}},"type":"object","properties":{"id":{"type":"string","description":"ID of the csv file"},"name":{"type":"string","description":"Name of the csv file to be uploaded"},"unique_identifier_type":{"type":"string","description":"Duplicate checking logic configured for the record list:\n * `PHONE_NUMBER` - Duplicate checking based on the record's phone_number\n * `EXTERNAL` - Duplicate checking based on the record's external_id and external_provider\n * `NOTHING` - No duplicate checking\n"},"status":{"type":"string","description":"status of the csv file"},"signed_url":{"type":"string","description":"url to save the csv file in S3"},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string"}}}}}}}}}},"400":{"description":"Errors were found in the submitted data","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"General bad request":{"value":{"code":"0530900","message":"Bad request."}},"Unique identifier type is invalid":{"value":{"code":"0530941","message":"Invalid unique identifier type."}}}}}},"401":{"description":"Unauthorized","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530901","message":"Missing or invalid authentication token."}}}},"403":{"description":"Forbidden","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530902","message":"Insufficient scopes for the requested operation."}}}},"413":{"description":"Payload too large","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530906","message":"Maximum file size allowed (100Mb) was reached."}}}}}}},"/record-lists/{id}":{"get":{"summary":"Get a record list","x-namespace":"/record-lists","tags":["Record Lists"],"description":"Get the details of a record list","security":[{"EarlyAccess":["record-lists:manage"]}],"parameters":[{"name":"id","in":"path","description":"The identifier of the record list.","required":true,"schema":{"type":"string","minLength":1,"maxLength":36}},{"name":"fields","in":"query","description":"Allows to request the sub entities of the record list

    ","required":false,"schema":{"type":"string","enum":["TEAMS"]}}],"responses":{"200":{"description":"The record list details.","content":{"application/hal+json":{"schema":{"example":{"id":"8858c834-481d-4a02-8176-cffc02c50350","name":"list 1","unique_identifier_type":"PHONE_NUMBER","created_at":"2020-03-24T11:48:40.503Z","updated_at":"2020-03-24T11:48:40.503Z","records_count":10,"status":"accepted","account_id":"5cec1886cd9489002de37c18","teams":[{"id":"367ac248e7c6415980bad277d2de91a5","name":"Team A","_links":{"self":{"href":"https://api-docs.talkdesk.org/teams/367ac248e7c6415980bad277d2de91a5"}}}],"campaign_page":[{"total":3,"total_pages":3,"page":1,"per_page":1,"count":3,"_embedded":{"campaigns":[{"id":"367ac248e7c6415980bad277d2de9112","campaign_name":"Campaign A","_links":{"self":{"href":"https://api-docs.talkdesk.org/campaigns/367ac248e7c6415980bad277d2de9112"}}}]},"_links":{"self":{"href":"https://api.talkdeskapp.com/record-lists/8858c834-481d-4a02-8176-cffc02c50350/campaigns?page=2&per_page=1"},"next":{"href":"https://api.talkdeskapp.com/record-lists/8858c834-481d-4a02-8176-cffc02c50350/campaigns?page=3&per_page=1"},"prev":{"href":"https://api.talkdeskapp.com/record-lists/8858c834-481d-4a02-8176-cffc02c50350/campaigns?page=1&per_page=1"},"first":{"href":"https://api.talkdeskapp.com/record-lists/8858c834-481d-4a02-8176-cffc02c50350/campaigns?page=1&per_page=1"},"last":{"href":"https://api.talkdeskapp.com/record-lists/8858c834-481d-4a02-8176-cffc02c50350/campaigns?page=3&per_page=1"}}}],"_links":{"self":{"href":"https://api.talkdeskapp.com/record-lists/8858c834-481d-4a02-8176-cffc02c50350"}}},"type":"object","description":"Record list object.","properties":{"id":{"type":"string","format":"uuid","description":"ID of the record list created."},"name":{"type":"string","description":"Record list name."},"unique_identifier_type":{"type":"string","description":"Duplicate checking logic configured for the record list:\n * `PHONE_NUMBER` - Duplicate checking based on the record's phone_number\n * `EXTERNAL` - Duplicate checking based on the record's external_id and external_provider\n * `NOTHING` - No duplicate checking\n"},"created_at":{"type":"string","description":"Record list creation date."},"updated_at":{"type":"string","description":"Record list updated date."},"status":{"type":"string","description":"Status of validation process done on the record list csv file.","enum":["REJECTED","VALIDATION_STARTED","UPLOADED","ACCEPTED","INCOMPLETE","CORRUPTED"]},"records_count":{"type":"integer","description":"How many records are present in the record list."},"teams":{"type":"array","description":"Teams that this record belongs to.","items":{"type":"object","description":"Teams assigned to the record list, if any.","properties":{"id":{"type":"string","description":"The team ID of the record list."},"name":{"type":"string","description":"The team name of the record list."},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string"}}}}}}}},"campaign_page":{"description":"Campaigns associated with the record list.","type":"object","properties":{"total":{"description":"The number of items.","type":"integer"},"per_page":{"description":"The number of items per page.","type":"integer"},"count":{"description":"The total number of items in this page.","type":"integer"},"page":{"description":"The number of the current page.","type":"integer"},"total_pages":{"description":"The total number of pages.","type":"integer"},"_embedded":{"properties":{"campaigns":{"description":"List of campaigns paginated.","items":{"description":"Campaign HAL object.","readOnly":true,"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"External ID of the campaign created."},"campaign_name":{"type":"string","description":"Campaign name."},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string"}}}}}}},"type":"array"}},"type":"object","required":["campaigns"]},"_links":{"description":"HAL API related links.","type":"object","properties":{"next":{"description":"Link of the next page.","type":"object","properties":{"href":{"description":"Address of the resource.","type":"string"}},"required":["href"]},"last":{"description":"Link of the last page.","type":"object","properties":{"href":{"description":"Address of the resource.","type":"string"}},"required":["href"]},"prev":{"description":"Link of the previous page.","type":"object","properties":{"href":{"description":"Address of the resource.","type":"string"}},"required":["href"]},"self":{"description":"Link of the current page.","type":"object","properties":{"href":{"description":"Address of the resource.","type":"string"}},"required":["href"]},"first":{"description":"Link of the first page.","type":"object","properties":{"href":{"description":"Address of the resource.","type":"string"}},"required":["href"]}},"required":["self","next","prev","first","last"]}},"required":["per_page","page","total","_links"]},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string"}}}}}}}}}},"401":{"description":"Unauthorized","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530901","message":"Missing or invalid authentication token."}}}},"403":{"description":"Forbidden","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530902","message":"Insufficient scopes for the requested operation."}}}},"404":{"description":"Record list not found.","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530910","message":"Record List not found."}}}}}},"patch":{"summary":"Change csv status to uploaded","x-namespace":"/record-lists","tags":["Record Lists"],"description":"Returns a record list object and starts file validation","security":[{"EarlyAccess":["record-lists:write"]}],"parameters":[{"name":"id","in":"path","description":"Record list id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Update status of record list file","required":true,"content":{"application/json-patch+json":{"schema":{"example":[{"op":"replace","path":"/status","value":"UPLOADED"}],"type":"object","required":["op","path","value"],"properties":{"op":{"type":"string","description":"type of operation"},"path":{"type":"string","description":"specifies the property to which the operation should be applied to"},"value":{"type":"object","description":"value to replace"}}}}}},"responses":{"200":{"description":"updates record list","content":{"application/hal+json":{"schema":{"example":{"id":"8b58b043-0c9b-46eb-ae7e-5436f2ea1649","name":"record list 20","unique_identifier_type":"PHONE_NUMBER","created_at":"2020-04-29T16:16:03.626Z","records_count":0,"account_id":"5d0c9a22f8cf30001de12300","status":"UPLOADED","_links":{"self":{"href":"https://api.talkdeskapp.com/record-lists/8b58b043-0c9b-46eb-ae7e-5436f2ea1649"}}},"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID of the record list"},"name":{"type":"string"},"unique_identifier_type":{"type":"string","description":"Duplicate checking logic configured for the record list:\n * `PHONE_NUMBER` - Duplicate checking based on the record's phone_number\n * `EXTERNAL` - Duplicate checking based on the record's external_id and external_provider\n * `NOTHING` - No duplicate checking\n"},"created_at":{"type":"string","description":"Date of record list creation"},"records_count":{"type":"integer","description":"Number of records in the record list"},"account_id":{"type":"string","description":"Account id of record list"},"status":{"type":"string","description":"Status of the csv file associated with the record list"},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string"}}}}}}}}}},"400":{"description":"Errors were found in the submitted request","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"General bad request":{"value":{"code":"0530900","message":"Bad request."}},"File was not found":{"value":{"code":"0530963","message":"File was not found."}}}}}},"401":{"description":"Unauthorized","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530901","message":"Missing or invalid authentication token."}}}},"403":{"description":"Forbidden","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530902","message":"Insufficient scopes for the requested operation."}}}},"404":{"description":"Record list not found.","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530910","message":"Record List not found."}}}},"409":{"description":"Request conflict with current state of Record List","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530907","message":"Record List is in a state where the operation is not possible."}}}}}}},"/record-lists/{id}/records/{id_record}":{"get":{"summary":"Get one record from a record list","x-namespace":"/record-lists/{id}/records/{id-record}","tags":["Record Lists"],"security":[{"EarlyAccess":["record-lists:manage"]}],"parameters":[{"name":"id","in":"path","description":"The identifier of the record list.","required":true,"schema":{"type":"string","minLength":1,"maxLength":36}},{"name":"id_record","in":"path","description":"Record id","required":true,"schema":{"type":"string","minLength":1,"maxLength":36}}],"responses":{"200":{"description":"Get a record","content":{"application/hal+json":{"schema":{"example":{"id":"c45f361f-2944-4844-8a21-dbfe7b000b1c","record_list_id":"b3eb858c-e880-4938-bba3-bd5b733dd9b5","phone_number":"+351929312312","phone_numbers":[{"phone_number":"+351929312312","phone_type":"MOBILE"},{"phone_number":"+351929312300","phone_type":"OFFICE"},{"phone_number":"+351929312301","phone_type":"HOME"}],"first_name":"Joey","last_name":"Tribbiani","timezone":"Europe/Lisbon","priority":7,"extra_data":{"country":"USA","state":"California","job":"Actor"},"external_provider":"salesforce","external_id":"0030O000024ukNtQAD","external_url":"https://xxx.salesforce.com/0030O000024ukNtQAD","sync_external_id":true,"created_at":"2020-03-24T11:48:40.503Z","updated_at":"2020-03-24T11:48:40.503Z","_links":{"self":{"href":"https://api.talkdeskapp.com/record-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5/records/c45f361f-2944-4844-8a21-dbfe7b000b1c"},"record_list":{"href":"https://api.talkdeskapp.com/record-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5"}}},"type":"object","description":"Record object","properties":{"id":{"type":"string","description":"Record id"},"record_list_id":{"type":"string","description":"Record list id"},"phone_number":{"type":"string","description":"Phone number of the record (required if phone_numbers field is not present)","deprecated":true},"phone_numbers":{"type":"array","description":"List of phone numbers of the record (required if phone_number field is not present)","items":{"type":"object","description":"Record phone number","properties":{"phone_number":{"type":"string","description":"Record phone number","minLength":1,"maxLength":20},"phone_type":{"type":"string","description":"The type of the phone number","minLength":4,"maxLength":7,"enum":["HOME","OFFICE","MOBILE","EXTRA_1","EXTRA_2","EXTRA_3"]}},"required":["phone_number","phone_type"]},"minItems":1},"first_name":{"type":"string","description":"First name of the record","minLength":1,"maxLength":80},"last_name":{"type":"string","description":"Last name of the record","minLength":1,"maxLength":80},"timezone":{"type":"string","description":"Timezone of the record","minLength":1,"maxLength":35},"priority":{"type":"integer","description":"Priority of the record within the record list","minimum":1,"maximum":10},"extra_data":{"type":"object","description":"Extra data of the record"},"external_provider":{"type":"string","description":"Reference for external provider source"},"external_id":{"type":"string","description":"Unique identifier for resource in external source"},"external_url":{"type":"string","description":"Resource location in external source"},"sync_external_id":{"type":"boolean","description":"Sync external id with contacts"},"created_at":{"type":"string","description":"Record creation date"},"updated_at":{"type":"string","description":"Record udpate date"},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string"}}}}}}}}}},"401":{"description":"Unauthorized","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530901","message":"Missing or invalid authentication token."}}}},"403":{"description":"Forbidden","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530902","message":"Insufficient scopes for the requested operation."}}}},"404":{"description":"Resource not found","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530920","message":"Record not found."}}}}}},"delete":{"summary":"Delete one record from a record list","x-namespace":"/record-lists/{id}/records/{id-record}","tags":["Record Lists"],"security":[{"EarlyAccess":["record-lists:manage"]}],"parameters":[{"name":"id","in":"path","description":"The identifier of the record list.","required":true,"schema":{"type":"string","minLength":1,"maxLength":36}},{"name":"id_record","in":"path","description":"Record id","required":true,"schema":{"type":"string","minLength":1,"maxLength":36}}],"responses":{"202":{"description":"Accepted record delete request, will delete the record in 5 seconds."},"204":{"description":"Record has been deleted."},"401":{"description":"Unauthorized","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530901","message":"Missing or invalid authentication token."}}}},"403":{"description":"Forbidden","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530902","message":"Insufficient scopes for the requested operation."}}}},"404":{"description":"Resource not found","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530920","message":"Record not found."}}}}}},"patch":{"summary":"Update one record inside a record list","x-namespace":"/record-lists","tags":["Record Lists"],"security":[{"EarlyAccess":["record-lists:manage"]}],"parameters":[{"name":"id","in":"path","description":"The identifier of the record list.","required":true,"schema":{"type":"string","minLength":1,"maxLength":36}},{"name":"id_record","in":"path","description":"Record id","required":true,"schema":{"type":"string","minLength":1,"maxLength":36}}],"requestBody":{"description":"Properties of record to update","required":true,"content":{"application/json-patch+json":{"schema":{"type":"array","items":{"type":"object","properties":{"op":{"type":"string","enum":["replace","add"],"description":"The operation to be performed

    ","minLength":3,"maxLength":7},"path":{"type":"string","minLength":1,"enum":["extra_data","priority"],"description":"A JSON-Pointer.

    "},"value":{"description":"The value to be used within the operations."}},"required":["op","path","value"]}},"example":[{"op":"replace","path":"/priority","value":6},{"op":"add","path":"/extra_data/home","value":"USA"},{"op":"replace","path":"/extra_data/name","value":"Jerry"}]}}},"responses":{"200":{"description":"Record updated","content":{"application/hal+json":{"schema":{"type":"object","description":"Record object","properties":{"id":{"type":"string","description":"Record id"},"record_list_id":{"type":"string","description":"Record list id"},"phone_number":{"type":"string","description":"Phone number of the record (required if phone_numbers field is not present)","deprecated":true},"phone_numbers":{"type":"array","description":"List of phone numbers of the record (required if phone_number field is not present)","items":{"type":"object","description":"Record phone number","properties":{"phone_number":{"type":"string","description":"Record phone number","minLength":1,"maxLength":20},"phone_type":{"type":"string","description":"The type of the phone number","minLength":4,"maxLength":7,"enum":["HOME","OFFICE","MOBILE","EXTRA_1","EXTRA_2","EXTRA_3"]}},"required":["phone_number","phone_type"]},"minItems":1},"first_name":{"type":"string","description":"First name of the record","minLength":1,"maxLength":80},"last_name":{"type":"string","description":"Last name of the record","minLength":1,"maxLength":80},"timezone":{"type":"string","description":"Timezone of the record","minLength":1,"maxLength":35},"priority":{"type":"integer","description":"Priority of the record within the record list","minimum":1,"maximum":10},"extra_data":{"type":"object","description":"Extra data of the record"},"external_provider":{"type":"string","description":"Reference for external provider source"},"external_id":{"type":"string","description":"Unique identifier for resource in external source"},"external_url":{"type":"string","description":"Resource location in external source"},"sync_external_id":{"type":"boolean","description":"Sync external id with contacts"},"created_at":{"type":"string","description":"Record creation date"},"updated_at":{"type":"string","description":"Record udpate date"},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string"}}}}}}},"example":{"id":"c45f361f-2944-4844-8a21-dbfe7b000b1c","record_list_id":"b3eb858c-e880-4938-bba3-bd5b733dd9b5","phone_number":"+351929312312","phone_numbers":[{"phone_number":"+351929312312","phone_type":"MOBILE"},{"phone_number":"+351929312300","phone_type":"OFFICE"},{"phone_number":"+351929312301","phone_type":"HOME"}],"first_name":"Joey","last_name":"Tribbiani","timezone":"Europe/Lisbon","priority":7,"extra_data":{"country":"USA","state":"California","job":"Actor"},"external_provider":"salesforce","external_id":"0030O000024ukNtQAD","external_url":"https://xxx.salesforce.com/0030O000024ukNtQAD","sync_external_id":true,"created_at":"2020-03-24T11:48:40.503Z","updated_at":"2020-03-24T11:48:40.503Z","_links":{"self":{"href":"https://api.talkdeskapp.com/record-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5/records/c45f361f-2944-4844-8a21-dbfe7b000b1c"},"record_list":{"href":"https://api.talkdeskapp.com/record-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5"}}}}}},"400":{"description":"Errors were found in the submitted data","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530900","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530901","message":"Missing or invalid authentication token."}}}},"403":{"description":"Forbidden","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530902","message":"Insufficient scopes for the requested operation."}}}},"404":{"description":"Resource not found","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530920","message":"Record not found."}}}},"422":{"description":"Unprocessable record","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530905","message":"Resource is not available for this operation."}}}}}}},"/record-lists/{id}/records":{"get":{"summary":"Get all records from a record list","x-namespace":"/record-lists","tags":["Record Lists"],"security":[{"EarlyAccess":["record-lists:manage"]}],"parameters":[{"name":"id","in":"path","description":"The identifier of the record list.","required":true,"schema":{"type":"string","minLength":1,"maxLength":36}},{"name":"phone_number","in":"query","description":"Filter Records by phone number","schema":{"type":"string","minLength":1,"maxLength":20}},{"name":"page","in":"query","description":"number of the page listed","schema":{"type":"integer","minimum":1,"maximum":2147483647}},{"name":"per_page","in":"query","description":"Number of max items per page","schema":{"type":"integer","default":50,"minimum":1,"maximum":500}},{"name":"upload_request_id","in":"query","description":"Filter Records by upload request id","schema":{"type":"string","minLength":1,"maxLength":36}},{"name":"search","in":"query","description":"Fuzzy search records by first name, last name or phone number","required":false,"example":"*1234*","schema":{"type":"string","minLength":3,"maxLength":80,"x-search_operators":["*"]}},{"name":"search_fields","in":"query","description":"Supported search fields, include first_name, last_name, phone_number, which joint by ','","required":false,"schema":{"type":"string","minLength":1,"maxLength":35,"default":"first_name,last_name,phone_number"}},{"name":"order_by","in":"query","description":"Sort the records by updated time and priority","required":false,"schema":{"default":"updated_at:desc","x-sorting_default_order":"asc","x-sorting_fields":["updated_at","priority"],"enum":["updated_at","updated_at:asc","updated_at:desc","priority","priority:asc","priority:desc"],"type":"string","minLength":1,"maxLength":35}},{"name":"priorities","in":"query","description":"Filter records by priorities, multiple priority which joint by ','","required":false,"example":"1,2,3,4,5","schema":{"type":"string","minLength":1,"maxLength":500}},{"name":"timezones","in":"query","description":"Filter records by timezones, multiple timezone which joint by ','","required":false,"example":"America/Los_Angeles,America/New_York","schema":{"type":"string","minLength":1,"maxLength":500}},{"name":"updated_at_from","in":"query","description":"Interval starting point of updated time, must filter with field created_at_to","schema":{"type":"string","format":"date-time","maxLength":35}},{"name":"updated_at_to","in":"query","description":"Interval ending point of updated time, must filter with field updated_at_from","schema":{"type":"string","format":"date-time","maxLength":35}},{"name":"extra_data_filter","in":"query","description":"Filter records by extra_data fields. Multiple filters can be provided to narrow results.\nFormat: 'key:value' for exact match, or 'key:' to check if key exists.\nSame key with different values are OR'd together, different keys are AND'd.\nMaximum 20 filters allowed.\n","required":false,"schema":{"type":"array","items":{"type":"string","pattern":"^[^:]+:.*$"},"minItems":1,"maxItems":20},"example":["Status:Completed","Priority:High","CustomField:"]}],"responses":{"200":{"description":"Get a list of records","content":{"application/hal+json":{"schema":{"example":{"page":2,"total_pages":3,"per_page":1,"count":3,"_links":{"self":{"href":"https://api.talkdeskapp.com/record-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5/records?page=2&per_page=1"},"next":{"href":"https://api.talkdeskapp.com/record-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5/records?page=3&per_page=1"},"prev":{"href":"https://api.talkdeskapp.com/record-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5/records?page=1&per_page=1"},"first":{"href":"https://api.talkdeskapp.com/record-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5/records?page=1&per_page=1"},"last":{"href":"https://api.talkdeskapp.com/record-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5/records?page=3&per_page=1"}},"_embedded":{"records":[{"id":"c45f361f-2944-4844-8a21-dbfe7b000b1c","record_list_id":"b3eb858c-e880-4938-bba3-bd5b733dd9b5","phone_number":"+351929312312","phone_numbers":[{"phone_number":"+351929312312","phone_type":"MOBILE"},{"phone_number":"+351929312300","phone_type":"OFFICE"},{"phone_number":"+351929312301","phone_type":"HOME"}],"first_name":"Joey","last_name":"Tribbiani","timezone":"Europe/Lisbon","priority":7,"extra_data":{"country":"USA","state":"California","job":"Actor"},"external_provider":"salesforce","external_id":"0030O000024ukNtQAD","external_url":"https://xxx.salesforce.com/0030O000024ukNtQAD","sync_external_id":true,"created_at":"2020-03-24T11:48:40.503Z","updated_at":"2020-03-24T11:48:40.503Z","_links":{"self":{"href":"https://api.talkdeskapp.com/record-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5/records/c45f361f-2944-4844-8a21-dbfe7b000b1c"},"record_list":{"href":"https://api.talkdeskapp.com/record-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5"}}}]}},"description":"List with the paginated samples.","properties":{"per_page":{"description":"The number of items per page.","type":"integer"},"count":{"description":"The total number of items.","type":"integer"},"page":{"description":"The number of the current page.","type":"integer"},"total_pages":{"description":"The total number of pages.","type":"integer"},"_links":{"description":"HAL API related links.","type":"object","properties":{"next":{"description":"Link of the next page","type":"object","properties":{"href":{"description":"Address of the resource","type":"string"}},"required":["href"]},"last":{"description":"Link of the last page","type":"object","properties":{"href":{"description":"Address of the resource","type":"string"}},"required":["href"]},"prev":{"description":"Link of the previous page","type":"object","properties":{"href":{"description":"Address of the resource","type":"string"}},"required":["href"]},"self":{"description":"Link of the current page","type":"object","properties":{"href":{"description":"Address of the resource","type":"string"}},"required":["href"]},"first":{"description":"Link of the first page","type":"object","properties":{"href":{"description":"Address of the resource","type":"string"}},"required":["href"]}},"required":["self","first","last"]},"_embedded":{"properties":{"records":{"description":"List of records paginated.","items":{"description":"Record HAL object.","readOnly":true,"type":"object","properties":{"id":{"type":"string","description":"Record id"},"record_list_id":{"type":"string","description":"Record list id"},"phone_number":{"type":"string","description":"Phone number of the record (required if phone_numbers field is not present)","deprecated":true},"phone_numbers":{"type":"array","description":"List of phone numbers of the record (required if phone_number field is not present)","items":{"type":"object","description":"Record phone number","properties":{"phone_number":{"type":"string","description":"Record phone number","minLength":1,"maxLength":20},"phone_type":{"type":"string","description":"The type of the phone number","minLength":4,"maxLength":7,"enum":["HOME","OFFICE","MOBILE","EXTRA_1","EXTRA_2","EXTRA_3"]}},"required":["phone_number","phone_type"]},"minItems":1},"first_name":{"type":"string","description":"First name of the record","minLength":1,"maxLength":80},"last_name":{"type":"string","description":"Last name of the record","minLength":1,"maxLength":80},"timezone":{"type":"string","description":"Timezone of the record","minLength":1,"maxLength":35},"priority":{"type":"integer","description":"Priority of the record within the record list","minimum":1,"maximum":10},"extra_data":{"type":"object","description":"Extra data of the record"},"external_provider":{"type":"string","description":"Reference for external provider source"},"external_id":{"type":"string","description":"Unique identifier for resource in external source"},"external_url":{"type":"string","description":"Resource location in external source"},"sync_external_id":{"type":"boolean","description":"Sync external id with contacts"},"created_at":{"type":"string","description":"Record creation date"},"updated_at":{"type":"string","description":"Record udpate date"},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string"}}}}}}},"type":"array"}},"type":"object"}},"required":["per_page","page","total","_links"],"type":"object"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530900","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530901","message":"Missing or invalid authentication token."}}}},"403":{"description":"Forbidden","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530902","message":"Insufficient scopes for the requested operation."}}}},"404":{"description":"Record List not found.","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530910","message":"Record List not found."}}}}}},"post":{"summary":"Creates a record","x-namespace":"/record-lists","tags":["Record Lists"],"description":"Creates a Record in the record_list","security":[{"EarlyAccess":["record-lists:manage"]}],"parameters":[{"name":"id","in":"path","description":"The identifier of the record list.","required":true,"schema":{"type":"string","minLength":1,"maxLength":36}}],"requestBody":{"description":"parameters needed to create a Record","required":true,"content":{"application/hal+json":{"schema":{"example":{"phone_numbers":[{"phone_number":"+351929312312","phone_type":"MOBILE"},{"phone_number":"+351929312300","phone_type":"OFFICE"},{"phone_number":"+351929312301","phone_type":"HOME"}],"first_name":"Joey","last_name":"Tribbiani","timezone":"Europe/Lisbon","priority":6,"external_provider":"salesforce","external_id":"0030O000024ukNtQAD","external_url":"https://xxx.salesforce.com/0030O000024ukNtQAD","sync_external_id":true,"extra_data":{"country":"USA","state":"California","job":"Actor"}},"type":"object","description":"Record object","required":["phone_number","phone_numbers","first_name","last_name"],"properties":{"phone_number":{"type":"string","description":"Phone number of the record (required if phone_numbers field is not present)","deprecated":true,"minLength":1,"maxLength":20},"phone_numbers":{"type":"array","description":"List of phone numbers of the record (required if phone_number field is not present)","items":{"type":"object","description":"Record phone number","properties":{"phone_number":{"type":"string","description":"Record phone number","minLength":1,"maxLength":20},"phone_type":{"type":"string","description":"The type of the phone number","minLength":4,"maxLength":7,"enum":["HOME","OFFICE","MOBILE","EXTRA_1","EXTRA_2","EXTRA_3"]}},"required":["phone_number","phone_type"]},"minItems":1},"first_name":{"type":"string","description":"First name of the record","minLength":1,"maxLength":80},"last_name":{"type":"string","description":"Last name of the record","minLength":1,"maxLength":80},"timezone":{"type":"string","description":"Timezone of the record","minLength":1,"maxLength":35},"external_provider":{"type":"string","description":"External_provider of the record"},"external_id":{"type":"string","description":"external id of the record"},"external_url":{"type":"string","description":"external_url of the record"},"sync_external_id":{"type":"boolean","description":"sync_external_id of the record"},"priority":{"type":"integer","description":"Priority of the record within the record list","minimum":1,"maximum":10},"extra_data":{"type":"object","description":"Extra data of the record"}}}}}},"responses":{"201":{"description":"Record created","content":{"application/hal+json":{"schema":{"example":{"id":"c45f361f-2944-4844-8a21-dbfe7b000b1c","record_list_id":"b3eb858c-e880-4938-bba3-bd5b733dd9b5","phone_number":"+351929312312","phone_numbers":[{"phone_number":"+351929312312","phone_type":"MOBILE"},{"phone_number":"+351929312300","phone_type":"OFFICE"},{"phone_number":"+351929312301","phone_type":"HOME"}],"first_name":"Joey","last_name":"Tribbiani","timezone":"Europe/Lisbon","priority":7,"extra_data":{"country":"USA","state":"California","job":"Actor"},"external_provider":"salesforce","external_id":"0030O000024ukNtQAD","external_url":"https://xxx.salesforce.com/0030O000024ukNtQAD","sync_external_id":true,"created_at":"2020-03-24T11:48:40.503Z","updated_at":"2020-03-24T11:48:40.503Z","_links":{"self":{"href":"https://api.talkdeskapp.com/record-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5/records/c45f361f-2944-4844-8a21-dbfe7b000b1c"},"record_list":{"href":"https://api.talkdeskapp.com/record-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5"}}},"type":"object","description":"Record object","properties":{"id":{"type":"string","description":"Record id"},"record_list_id":{"type":"string","description":"Record list id"},"phone_number":{"type":"string","description":"Phone number of the record (required if phone_numbers field is not present)","deprecated":true},"phone_numbers":{"type":"array","description":"List of phone numbers of the record (required if phone_number field is not present)","items":{"type":"object","description":"Record phone number","properties":{"phone_number":{"type":"string","description":"Record phone number","minLength":1,"maxLength":20},"phone_type":{"type":"string","description":"The type of the phone number","minLength":4,"maxLength":7,"enum":["HOME","OFFICE","MOBILE","EXTRA_1","EXTRA_2","EXTRA_3"]}},"required":["phone_number","phone_type"]},"minItems":1},"first_name":{"type":"string","description":"First name of the record","minLength":1,"maxLength":80},"last_name":{"type":"string","description":"Last name of the record","minLength":1,"maxLength":80},"timezone":{"type":"string","description":"Timezone of the record","minLength":1,"maxLength":35},"priority":{"type":"integer","description":"Priority of the record within the record list","minimum":1,"maximum":10},"extra_data":{"type":"object","description":"Extra data of the record"},"external_provider":{"type":"string","description":"Reference for external provider source"},"external_id":{"type":"string","description":"Unique identifier for resource in external source"},"external_url":{"type":"string","description":"Resource location in external source"},"sync_external_id":{"type":"boolean","description":"Sync external id with contacts"},"created_at":{"type":"string","description":"Record creation date"},"updated_at":{"type":"string","description":"Record udpate date"},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string"}}}}}}}}}},"400":{"description":"Errors were found in the submitted data","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Phone number required":{"value":{"code":"0530921","message":"Missing required Phone Number."}},"Unable to find suitable timezone":{"value":{"code":"0530940","message":"Unable to find suitable timezone."}}}}}},"401":{"description":"Unauthorized","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530901","message":"Missing or invalid authentication token."}}}},"403":{"description":"Forbidden","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530902","message":"Insufficient scopes for the requested operation."}}}},"404":{"description":"Record List not found","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530910","message":"Record List not found."}}}}}},"delete":{"summary":"Delete records by phone number","x-namespace":"/record-lists","tags":["Record Lists"],"description":"Delete Records by phone number in the record_list","security":[{"EarlyAccess":["record-lists:manage"]}],"parameters":[{"name":"id","in":"path","description":"The identifier of the record list.","required":true,"schema":{"type":"string","minLength":1,"maxLength":36}},{"name":"phone_number","in":"query","description":"Filter Records by phone number","required":true,"schema":{"type":"string","minLength":1,"maxLength":20}}],"responses":{"202":{"description":"Accepted record(s) delete request, will delete the record(s) in 5 seconds."},"204":{"description":"Record(s) have been deleted."},"400":{"description":"Errors were found in the submitted data","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530900","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530901","message":"Missing or invalid authentication token."}}}},"403":{"description":"Forbidden","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530902","message":"Insufficient scopes for the requested operation."}}}},"404":{"description":"Resource not found","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530920","message":"Record not found."}}}}}}},"/record-lists/{id}/records/timezones":{"get":{"summary":"Get all timezones from a record list","x-namespace":"/record-lists","tags":["Record Lists"],"security":[{"EarlyAccess":["record-lists:manage"]}],"parameters":[{"name":"id","in":"path","description":"The identifier of the record list.","required":true,"schema":{"type":"string","minLength":1,"maxLength":36}},{"name":"page","in":"query","description":"number of the page listed","schema":{"type":"integer","minimum":1,"maximum":2147483647}},{"name":"per_page","in":"query","description":"Number of max items per page","schema":{"type":"integer","default":50,"minimum":1,"maximum":500}},{"name":"search","in":"query","description":"Fuzzy search timezones","required":false,"example":"*America*","schema":{"type":"string","minLength":3,"maxLength":35,"x-search_operators":["*"],"x-search_fields":["timezone"]}}],"responses":{"200":{"description":"Get a list of timezones","content":{"application/hal+json":{"schema":{"example":{"page":2,"total_pages":3,"per_page":1,"count":3,"_links":{"self":{"href":"https://api.talkdeskapp.com/record-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5/timezones?page=2&per_page=1"},"next":{"href":"https://api.talkdeskapp.com/record-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5/timezones?page=3&per_page=1"},"prev":{"href":"https://api.talkdeskapp.com/record-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5/timezones?page=1&per_page=1"},"first":{"href":"https://api.talkdeskapp.com/record-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5/timezones?page=1&per_page=1"},"last":{"href":"https://api.talkdeskapp.com/record-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5/timezones?page=3&per_page=1"}},"_embedded":{"timezones":["America/New_York"]}},"description":"List with the paginated samples.","properties":{"per_page":{"description":"The number of items per page.","type":"integer"},"count":{"description":"The total number of items.","type":"integer"},"page":{"description":"The number of the current page.","type":"integer"},"total_pages":{"description":"The total number of pages.","type":"integer"},"_links":{"description":"HAL API related links.","type":"object","properties":{"next":{"description":"Link of the next page","type":"object","properties":{"href":{"description":"Address of the resource","type":"string"}},"required":["href"]},"last":{"description":"Link of the last page","type":"object","properties":{"href":{"description":"Address of the resource","type":"string"}},"required":["href"]},"prev":{"description":"Link of the previous page","type":"object","properties":{"href":{"description":"Address of the resource","type":"string"}},"required":["href"]},"self":{"description":"Link of the current page","type":"object","properties":{"href":{"description":"Address of the resource","type":"string"}},"required":["href"]},"first":{"description":"Link of the first page","type":"object","properties":{"href":{"description":"Address of the resource","type":"string"}},"required":["href"]}},"required":["self","first","last"]},"_embedded":{"properties":{"timezones":{"description":"List of timezones paginated.","items":{"description":"Timezone HAL object.","readOnly":true,"type":"string"},"type":"array"}},"type":"object"}},"required":["per_page","page","total","_links"],"type":"object"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530900","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530901","message":"Missing or invalid authentication token."}}}},"403":{"description":"Forbidden","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530902","message":"Insufficient scopes for the requested operation."}}}},"404":{"description":"Record List not found.","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530910","message":"Record List not found."}}}}}}},"/record-lists/{id}/external-records":{"delete":{"x-namespace":"/record-lists","summary":"Delete records by external provider and external ID in the record_list","tags":["Record Lists"],"description":"Delete records by external provider and external ID in the record_list","security":[{"EarlyAccess":["record-lists:manage"]}],"parameters":[{"name":"id","in":"path","description":"The identifier of the record list.","required":true,"schema":{"type":"string","minLength":1,"maxLength":36}},{"name":"external_provider","in":"query","description":"Reference for external provider source","required":true,"schema":{"type":"string"}},{"name":"external_id","in":"query","description":"Unique identifier for resource in external source","required":true,"schema":{"type":"string"}}],"responses":{"202":{"description":"Accepted record(s) delete request, will delete the record(s) in 5 seconds."},"204":{"description":"Record(s) have been deleted."},"400":{"description":"Errors were found in the submitted data","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530900","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530901","message":"Missing or invalid authentication token."}}}},"403":{"description":"Forbidden","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530902","message":"Insufficient scopes for the requested operation."}}}},"404":{"description":"Record List not found.","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530910","message":"Record List not found."}}}}}}},"/record-lists/{id}/teams":{"get":{"x-namespace":"/record-lists","summary":"Get teams assigned to a record list","tags":["Record Lists"],"description":"Get teams assigned to a record list.","security":[{"EarlyAccess":["record-lists:manage"]}],"parameters":[{"name":"id","in":"path","description":"The identifier of the record list.","required":true,"schema":{"type":"string","minLength":1,"maxLength":36}},{"name":"page","in":"query","description":"number of the page listed.","schema":{"format":"int32","type":"integer","default":1,"minimum":1,"maximum":2147483647}},{"name":"per_page","in":"query","description":"Number of max items per page.","schema":{"type":"integer","format":"int32","default":50,"minimum":1,"maximum":500}}],"responses":{"200":{"description":"Get a list of record teams.","content":{"application/hal+json":{"schema":{"description":"Teams of a record list with the paginated samples.","type":"object","properties":{"per_page":{"description":"The number of items per page.","type":"integer"},"count":{"description":"The total number of items.","type":"integer"},"page":{"description":"The number of the current page.","type":"integer"},"total_pages":{"description":"The total number of pages.","type":"integer"},"_links":{"description":"HAL API related links.","type":"object","properties":{"self":{"type":"object","allOf":[{"required":["href"],"type":"object","properties":{"href":{"type":"string","description":"The hypertext reference.","example":"http:///record-lists//teams?page=3"}},"description":"Contains information about the HAL link."}],"description":"The current page link."},"prev":{"type":"object","allOf":[{"required":["href"],"type":"object","properties":{"href":{"type":"string","description":"The hypertext reference.","example":"http:///record-lists//teams?page=3"}},"description":"Contains information about the HAL link."}],"description":"The previous page link."},"next":{"type":"object","allOf":[{"required":["href"],"type":"object","properties":{"href":{"type":"string","description":"The hypertext reference.","example":"http:///record-lists//teams?page=3"}},"description":"Contains information about the HAL link."}],"description":"The next page link."},"first":{"type":"object","allOf":[{"required":["href"],"type":"object","properties":{"href":{"type":"string","description":"The hypertext reference.","example":"http:///record-lists//teams?page=3"}},"description":"Contains information about the HAL link."}],"description":"The first page link."},"last":{"type":"object","allOf":[{"required":["href"],"type":"object","properties":{"href":{"type":"string","description":"The hypertext reference.","example":"http:///record-lists//teams?page=3"}},"description":"Contains information about the HAL link."}],"description":"The last page link."}}},"_embedded":{"type":"object","required":["teams"],"properties":{"teams":{"description":"List of paginated record list teams.","type":"array","items":{"description":"Record HAL object.","readOnly":true,"type":"object","properties":{"id":{"type":"string","description":"The team ID of the record list."},"name":{"type":"string","description":"The team name of the record list."},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string"}}},"teams":{"type":"object","properties":{"href":{"type":"string"}}}}}}}}}}}},"example":{"page":1,"total_pages":3,"per_page":1,"count":3,"_links":{"self":{"href":"https://api.talkdeskapp.com/record-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5/teams?page=1&per_page=1"},"next":{"href":"https://api.talkdeskapp.com/record-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5/teams?page=2&per_page=1"},"prev":{"href":"https://api.talkdeskapp.com/record-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5/teams?page=1&per_page=1"},"first":{"href":"https://api.talkdeskapp.com/record-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5/teams?page=1&per_page=1"},"last":{"href":"https://api.talkdeskapp.com/record-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5/teams?page=3&per_page=1"}},"_embedded":{"teams":[{"id":"c45f361f-2944-4844-8a21-dbfe7b000b1c","name":"Team A","_links":{"self":{"href":"https://api.talkdeskapp.com/teams/c45f361f-2944-4844-8a21-dbfe7b000b1c"},"teams":{"href":"https://api.talkdeskapp.com/teams"}}}]}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530900","message":"Bad request."}}}},"401":{"description":"Unauthorized.","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530901","message":"Missing or invalid authentication token."}}}},"403":{"description":"Forbidden.","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530902","message":"Insufficient scopes for the requested operation."}}}},"404":{"description":"Record List not found.","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530910","message":"Record List not found."}}}},"405":{"description":"Method Not Allowed."}}},"post":{"x-namespace":"/record-lists","summary":"Assign teams to a record list.","tags":["Record Lists"],"description":"Assign teams to a record list.","security":[{"EarlyAccess":["record-lists:manage"]}],"parameters":[{"name":"id","in":"path","description":"The identifier of the record list.","required":true,"schema":{"type":"string","minLength":1,"maxLength":36}}],"requestBody":{"description":"parameters needed to assign teams to a record list.","required":true,"content":{"application/hal+json":{"schema":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"object","properties":{"id":{"type":"string","maxLength":36}},"required":["id"]}},"example":[{"id":"8858c834-481d-4a02-8176-cffc02c50350"},{"id":"f03004be-2853-4660-b6e8-060cc383ddbe"}]}}},"responses":{"201":{"description":"Assign teams success.","content":{"application/hal+json":{"schema":{"description":"Teams of a record list with the paginated samples.","type":"object","properties":{"per_page":{"description":"The number of items per page.","type":"integer"},"count":{"description":"The total number of items.","type":"integer"},"page":{"description":"The number of the current page.","type":"integer"},"total_pages":{"description":"The total number of pages.","type":"integer"},"_links":{"description":"HAL API related links.","type":"object","properties":{"self":{"type":"object","allOf":[{"required":["href"],"type":"object","properties":{"href":{"type":"string","description":"The hypertext reference.","example":"http:///record-lists//teams?page=3"}},"description":"Contains information about the HAL link."}],"description":"The current page link."},"prev":{"type":"object","allOf":[{"required":["href"],"type":"object","properties":{"href":{"type":"string","description":"The hypertext reference.","example":"http:///record-lists//teams?page=3"}},"description":"Contains information about the HAL link."}],"description":"The previous page link."},"next":{"type":"object","allOf":[{"required":["href"],"type":"object","properties":{"href":{"type":"string","description":"The hypertext reference.","example":"http:///record-lists//teams?page=3"}},"description":"Contains information about the HAL link."}],"description":"The next page link."},"first":{"type":"object","allOf":[{"required":["href"],"type":"object","properties":{"href":{"type":"string","description":"The hypertext reference.","example":"http:///record-lists//teams?page=3"}},"description":"Contains information about the HAL link."}],"description":"The first page link."},"last":{"type":"object","allOf":[{"required":["href"],"type":"object","properties":{"href":{"type":"string","description":"The hypertext reference.","example":"http:///record-lists//teams?page=3"}},"description":"Contains information about the HAL link."}],"description":"The last page link."}}},"_embedded":{"type":"object","required":["teams"],"properties":{"teams":{"description":"List of paginated record list teams.","type":"array","items":{"description":"Record HAL object.","readOnly":true,"type":"object","properties":{"id":{"type":"string","description":"The team ID of the record list."},"name":{"type":"string","description":"The team name of the record list."},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string"}}},"teams":{"type":"object","properties":{"href":{"type":"string"}}}}}}}}}}}},"example":{"page":1,"total_pages":3,"per_page":1,"count":3,"_links":{"self":{"href":"https://api.talkdeskapp.com/record-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5/teams?page=1&per_page=1"},"next":{"href":"https://api.talkdeskapp.com/record-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5/teams?page=2&per_page=1"},"prev":{"href":"https://api.talkdeskapp.com/record-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5/teams?page=1&per_page=1"},"first":{"href":"https://api.talkdeskapp.com/record-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5/teams?page=1&per_page=1"},"last":{"href":"https://api.talkdeskapp.com/record-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5/teams?page=3&per_page=1"}},"_embedded":{"teams":[{"id":"c45f361f-2944-4844-8a21-dbfe7b000b1c","name":"Team A","_links":{"self":{"href":"https://api.talkdeskapp.com/teams/c45f361f-2944-4844-8a21-dbfe7b000b1c"},"teams":{"href":"https://api.talkdeskapp.com/teams"}}}]}}}}},"401":{"description":"Unauthorized.","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530901","message":"Missing or invalid authentication token."}}}},"403":{"description":"Forbidden.","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"General Forbidden":{"value":{"code":"0530902","message":"Insufficient scopes for the requested operation."}},"Insufficient Permissions":{"value":{"code":"0530909","message":"Insufficient permissions for the requested operation."}}}}}},"404":{"description":"Record List not found.","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530910","message":"Record List not found."}}}},"405":{"description":"Method Not Allowed."}}},"put":{"x-namespace":"/record-lists","summary":"Update teams for a record list.","tags":["Record Lists"],"description":"Update teams for a record list.","security":[{"EarlyAccess":["record-lists:manage"]}],"parameters":[{"name":"id","in":"path","description":"The identifier of the record list.","required":true,"schema":{"type":"string","minLength":1,"maxLength":36}}],"requestBody":{"description":"parameters needed to update teams for a record list.","required":true,"content":{"application/hal+json":{"schema":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"object","properties":{"id":{"type":"string","maxLength":36}},"required":["id"]}},"example":[{"id":"8858c834-481d-4a02-8176-cffc02c50350"},{"id":"f03004be-2853-4660-b6e8-060cc383ddbe"}]}}},"responses":{"201":{"description":"Update teams success.","content":{"application/hal+json":{"schema":{"description":"Teams of a record list with the paginated samples.","type":"object","properties":{"per_page":{"description":"The number of items per page.","type":"integer"},"count":{"description":"The total number of items.","type":"integer"},"page":{"description":"The number of the current page.","type":"integer"},"total_pages":{"description":"The total number of pages.","type":"integer"},"_links":{"description":"HAL API related links.","type":"object","properties":{"self":{"type":"object","allOf":[{"required":["href"],"type":"object","properties":{"href":{"type":"string","description":"The hypertext reference.","example":"http:///record-lists//teams?page=3"}},"description":"Contains information about the HAL link."}],"description":"The current page link."},"prev":{"type":"object","allOf":[{"required":["href"],"type":"object","properties":{"href":{"type":"string","description":"The hypertext reference.","example":"http:///record-lists//teams?page=3"}},"description":"Contains information about the HAL link."}],"description":"The previous page link."},"next":{"type":"object","allOf":[{"required":["href"],"type":"object","properties":{"href":{"type":"string","description":"The hypertext reference.","example":"http:///record-lists//teams?page=3"}},"description":"Contains information about the HAL link."}],"description":"The next page link."},"first":{"type":"object","allOf":[{"required":["href"],"type":"object","properties":{"href":{"type":"string","description":"The hypertext reference.","example":"http:///record-lists//teams?page=3"}},"description":"Contains information about the HAL link."}],"description":"The first page link."},"last":{"type":"object","allOf":[{"required":["href"],"type":"object","properties":{"href":{"type":"string","description":"The hypertext reference.","example":"http:///record-lists//teams?page=3"}},"description":"Contains information about the HAL link."}],"description":"The last page link."}}},"_embedded":{"type":"object","required":["teams"],"properties":{"teams":{"description":"List of paginated record list teams.","type":"array","items":{"description":"Record HAL object.","readOnly":true,"type":"object","properties":{"id":{"type":"string","description":"The team ID of the record list."},"name":{"type":"string","description":"The team name of the record list."},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string"}}},"teams":{"type":"object","properties":{"href":{"type":"string"}}}}}}}}}}}},"example":{"page":1,"total_pages":3,"per_page":1,"count":3,"_links":{"self":{"href":"https://api.talkdeskapp.com/record-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5/teams?page=1&per_page=1"},"next":{"href":"https://api.talkdeskapp.com/record-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5/teams?page=2&per_page=1"},"prev":{"href":"https://api.talkdeskapp.com/record-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5/teams?page=1&per_page=1"},"first":{"href":"https://api.talkdeskapp.com/record-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5/teams?page=1&per_page=1"},"last":{"href":"https://api.talkdeskapp.com/record-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5/teams?page=3&per_page=1"}},"_embedded":{"teams":[{"id":"c45f361f-2944-4844-8a21-dbfe7b000b1c","name":"Team A","_links":{"self":{"href":"https://api.talkdeskapp.com/teams/c45f361f-2944-4844-8a21-dbfe7b000b1c"},"teams":{"href":"https://api.talkdeskapp.com/teams"}}}]}}}}},"401":{"description":"Unauthorized.","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530901","message":"Missing or invalid authentication token."}}}},"403":{"description":"Forbidden.","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"General Forbidden":{"value":{"code":"0530902","message":"Insufficient scopes for the requested operation."}},"Insufficient Permissions":{"value":{"code":"0530909","message":"Insufficient permissions for the requested operation."}}}}}},"404":{"description":"Record List not found.","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530910","message":"Record List not found."}}}},"405":{"description":"Method Not Allowed."},"417":{"description":"Update teams contradictory check failed.","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530965","message":"Please unlink the record list with the following campaign(s), then change the team. CampaignNameA, CampaignNameB.","fields":[{"name":"CampaignNameA","description":"Contradictory campaign."},{"name":"CampaignNameB","description":"Contradictory campaign."}]}}}}}},"delete":{"x-namespace":"/record-lists","summary":"Unassign teams from a record list","tags":["Record Lists"],"description":"Unassign teams from a record list.","security":[{"EarlyAccess":["record-lists:manage"]}],"parameters":[{"name":"id","in":"path","description":"The identifier of the record list.","required":true,"schema":{"type":"string","minLength":1,"maxLength":36}}],"requestBody":{"description":"parameters needed to unassign teams to a record list.","required":true,"content":{"application/hal+json":{"schema":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"object","properties":{"id":{"type":"string","maxLength":36}},"required":["id"]}},"example":[{"id":"8858c834-481d-4a02-8176-cffc02c50350"},{"id":"f03004be-2853-4660-b6e8-060cc383ddbe"}]}}},"responses":{"204":{"description":"Unassign teams success."},"400":{"description":"Errors were found in the submitted data.","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530964","message":"Team is invalid."}}}},"401":{"description":"Unauthorized.","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530901","message":"Missing or invalid authentication token."}}}},"403":{"description":"Forbidden.","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530902","message":"Insufficient scopes for the requested operation."}}}},"404":{"description":"Record List not found.","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530910","message":"Record List not found."}}}},"405":{"description":"Method Not Allowed."},"417":{"description":"Delete teams contradictory check failed.","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530966","message":"Please unlink the record list with the following campaign(s), then delete the team. CampaignNameA, CampaignNameB.","fields":[{"name":"CampaignNameA","description":"Contradictory campaign."},{"name":"CampaignNameB","description":"Contradictory campaign."}]}}}}}}},"/record-lists/{id}/records/bulks":{"post":{"x-namespace":"/record-lists","summary":"Creates multiple records","tags":["Record Lists"],"description":"Creates multiple records in the record list","security":[{"EarlyAccess":["record-lists:manage","role-permissions:skip"]}],"parameters":[{"name":"id","in":"path","description":"The identifier of the record list.","required":true,"schema":{"type":"string","minLength":1,"maxLength":36},"example":"b3eb858c-e880-4938-bba3-bd5b733dd9b5"}],"requestBody":{"description":"An array of parameters needed to create multiple Records","required":true,"content":{"application/hal+json":{"schema":{"type":"object","properties":{"upload_request_id":{"type":"string","description":"ID of upload requests containing the records","minLength":1,"maxLength":36},"records":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","description":"Phone number of the record","deprecated":true,"minLength":1,"maxLength":20},"phone_numbers":{"type":"array","description":"List of phone numbers of the record","items":{"type":"object","description":"Record phone number","properties":{"phone_number":{"type":"string","description":"Record phone number","minLength":1,"maxLength":20},"phone_type":{"type":"string","description":"The type of the phone number","minLength":4,"maxLength":7,"enum":["HOME","OFFICE","MOBILE","EXTRA_1","EXTRA_2","EXTRA_3"]}},"required":["phone_number","phone_type"]},"minItems":1},"first_name":{"type":"string","description":"First name of the record","minLength":1,"maxLength":80},"last_name":{"type":"string","description":"Last name of the record","minLength":1,"maxLength":80},"timezone":{"type":"string","description":"Timezone of the record","minLength":1,"maxLength":35},"external_provider":{"type":"string","description":"External_provider of the record"},"external_id":{"type":"string","description":"external id of the record"},"external_url":{"type":"string","description":"external_url of the record"},"sync_external_id":{"type":"boolean","description":"sync_external_id of the record"},"priority":{"type":"integer","description":"Priority of the record within the record list","minimum":1,"maximum":10},"extra_data":{"type":"object","description":"Extra data of the record"}},"required":["phone_numbers","first_name","last_name"]}}},"required":["records"]},"example":{"records":[{"phone_numbers":[{"phone_number":"+351929312312","phone_type":"MOBILE"}],"first_name":"Joey","last_name":"Tribbiani","timezone":"Europe/Lisbon","priority":7,"extra_data":{"country":"USA","state":"California","job":"Actor"}},{"phone_numbers":[{"phone_number":"+351929312313","phone_type":"MOBILE"}],"first_name":"Jane","last_name":"Doe","timezone":"GMT","priority":5,"external_provider":"salesforce","external_id":"0030O000024ukNtQAD","external_url":"https://xxx.salesforce.com/0030O000024ukNtQAD","sync_external_id":true,"extra_data":{"country":"USA","state":"California","job":"Actress"}}]}}}},"responses":{"201":{"description":"Records created","content":{"application/hal+json":{"schema":{"type":"object","description":"Response for multiple records creation","properties":{"record_list_id":{"type":"string","description":"Record list id","minLength":1,"maxLength":36},"has_errors":{"type":"boolean","description":"True if records upload has errors"},"total_errors":{"type":"integer","description":"Total number of errors found in the multiple records upload","minimum":0,"maximum":100},"total_created":{"type":"integer","description":"Total number of records created in multiple records upload request","minimum":0,"maximum":100},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string"}},"required":["href"]},"record_list":{"type":"object","properties":{"href":{"type":"string"}},"required":["href"]}},"required":["self","record_list"]},"_embedded":{"type":"object","description":"List of records resulted from insertion.","properties":{"records":{"type":"array","description":"Array of records","items":{"type":"object","description":"Record is completed with details if it was inserted or is annotated with errors otherwise.","properties":{"id":{"type":"string","description":"Record id"},"record_list_id":{"type":"string","description":"Record list id"},"phone_number":{"type":"string","description":"Phone number of the record","deprecated":true},"phone_numbers":{"type":"array","description":"List of phone numbers of the record","items":{"type":"object","description":"Record phone number","properties":{"phone_number":{"type":"string","description":"Record phone number","minLength":1,"maxLength":20},"phone_type":{"type":"string","description":"The type of the phone number","minLength":4,"maxLength":7,"enum":["HOME","OFFICE","MOBILE","EXTRA_1","EXTRA_2","EXTRA_3"]}},"required":["phone_number","phone_type"]},"minItems":1},"first_name":{"type":"string","description":"First name of the record"},"last_name":{"type":"string","description":"Last name of the record"},"timezone":{"type":"string","description":"Timezone of the record"},"priority":{"type":"integer","description":"Priority of the record within the record list","minimum":1,"maximum":10},"extra_data":{"type":"object","description":"Extra data of the record"},"external_provider":{"type":"string","description":"Reference for external provider source"},"external_id":{"type":"string","description":"Unique identifier for resource in external source"},"external_url":{"type":"string","description":"Resource location in external source"},"sync_external_id":{"type":"boolean","description":"Sync external id with contacts"},"errors":{"type":"array","items":{"type":"string","description":"Record errors","enum":["PHONE_NUMBER_INVALID","PHONE_NUMBER_MISSING","PHONE_NUMBER_NOT_UNIQUE","FIRST_NAME_INVALID","FIRST_NAME_MISSING","LAST_NAME_INVALID","LAST_NAME_MISSING","TIMEZONE_INVALID","TIMEZONE_MISSING","TIMEZONE_UNMATCHED","PRIORITY_INVALID","EXTERNAL_REF_MISSING","REQUIRED_FIELDS","OTHER"]}},"created_at":{"type":"string","description":"Record creation date"},"updated_at":{"type":"string","description":"Record udpate date"},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string"}}},"record_list":{"type":"object","properties":{"href":{"type":"string"}}}}}}}}}}}},"examples":{"Records without errors":{"value":{"record_list_id":"b3eb858c-e880-4938-bba3-bd5b733dd9b5","has_errors":false,"total_errors":0,"total_created":2,"_links":{"self":{"href":"https://api.talkdeskapp.com/record-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5/records?upload_request=h872f371f-3544-4324-8a21-dbfe7b999b1c"},"record_list":{"href":"https://api.talkdeskapp.com/record-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5"}},"_embedded":{"records":[{"id":"c45f361f-2944-4844-8a21-dbfe7b000b1c","record_list_id":"b3eb858c-e880-4938-bba3-bd5b733dd9b5","phone_number":"+351929312312","phone_numbers":[{"phone_number":"+351929312312","phone_type":"MOBILE"}],"first_name":"Joey","last_name":"Tribbiani","timezone":"Europe/Lisbon","priority":7,"extra_data":{"country":"USA","state":"California","job":"Actor"},"external_provider":"salesforce","external_id":"0030O000024ukNtQAD","external_url":"https://xxx.salesforce.com/0030O000024ukNtQAD","sync_external_id":true,"created_at":"2020-03-24T11:48:40.503Z","updated_at":"2020-03-24T11:48:40.503Z","_links":{"self":{"href":"https://api.talkdeskapp.com/record-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5/records/c45f361f-2944-4844-8a21-dbfe7b000b1c"},"record_list":{"href":"https://api.talkdeskapp.com/record-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5"}}},{"id":"c45f361f-2944-4844-8a21-dbfe7b000b1c","record_list_id":"b3eb858c-e880-4938-bba3-bd5b733dd9b5","phone_number":"+351929312313","phone_numbers":[{"phone_number":"+351929312313","phone_type":"MOBILE"}],"first_name":"Jane","last_name":"Doe","timezone":"Europe/Lisbon","priority":7,"extra_data":{"country":"USA","state":"California","job":"Actor"},"external_provider":"salesforce","external_id":"0030O000024ukNtQAD","external_url":"https://xxx.salesforce.com/0030O000024ukNtQAD","sync_external_id":true,"created_at":"2020-03-24T11:48:40.503Z","updated_at":"2020-03-24T11:48:40.503Z","_links":{"self":{"href":"https://api.talkdeskapp.com/record-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5/records/c45f361f-2944-4844-8a21-dbfe7b000b1c"},"record_list":{"href":"https://api.talkdeskapp.com/record-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5"}}}]}}},"Records with errors":{"value":{"record_list_id":"b3eb858c-e880-4938-bba3-bd5b733dd9b5","has_errors":true,"total_errors":1,"total_created":1,"_links":{"self":{"href":"https://api.talkdeskapp.com/record-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5/records?upload_request=h872f371f-3544-4324-8a21-dbfe7b999b1c"},"record_list":{"href":"https://api.talkdeskapp.com/record-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5"}},"_embedded":{"records":[{"id":"c45f361f-2944-4844-8a21-dbfe7b000b1c","record_list_id":"b3eb858c-e880-4938-bba3-bd5b733dd9b5","phone_number":"+351929312312","phone_numbers":[{"phone_number":"+351929312312","phone_type":"MOBILE"}],"first_name":"Joey","last_name":"Tribbiani","timezone":"Europe/Lisbon","priority":7,"extra_data":{"country":"USA","state":"California","job":"Actor"},"external_provider":"salesforce","external_id":"0030O000024ukNtQAD","external_url":"https://xxx.salesforce.com/0030O000024ukNtQAD","sync_external_id":true,"created_at":"2020-03-24T11:48:40.503Z","updated_at":"2020-03-24T11:48:40.503Z","_links":{"self":{"href":"https://api.talkdeskapp.com/record-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5/records/c45f361f-2944-4844-8a21-dbfe7b000b1c"},"record_list":{"href":"https://api.talkdeskapp.com/record-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5"}}},{"id":"c45f361f-2944-4844-8a21-dbfe7b000b1c","record_list_id":"b3eb858c-e880-4938-bba3-bd5b733dd9b5","phone_number":"+351929312313","last_name":"Doe","timezone":"Europe/Lisbon","priority":7,"extra_data":{"country":"USA","state":"California","job":"Actor"},"external_provider":"salesforce","external_id":"0030O000024ukNtQAD","external_url":"https://xxx.salesforce.com/0030O000024ukNtQAD","sync_external_id":true,"errors":["FIRST_NAME_MISSING","PHONE_NUMBER_NOT_UNIQUE","OTHER"]}]}}}}}}},"400":{"description":"Errors were found in the submitted data","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Request with too many records":{"value":{"code":"0530936","message":"Exceeded limit of records to insert."}},"Unable to find suitable timezone":{"value":{"code":"0530940","message":"Unable to find suitable timezone."}},"Request with a full record list":{"value":{"code":"0530911","message":"Record List is full."}},"Request with invalid upload request":{"value":{"code":"0530937","message":"Upload Request not found."}},"General Bad Request":{"value":{"code":"0530900","message":"Bad request."}}}}}},"401":{"description":"Unauthorized","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530901","message":"Missing or invalid authentication token."}}}},"403":{"description":"Forbidden","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530902","message":"Insufficient scopes for the requested operation."}}}},"404":{"description":"Record List not found","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530910","message":"Record List not found."}}}}}},"patch":{"x-namespace":"/record-lists","description":"bulk update a list of record in the record list","tags":["Record Lists"],"security":[{"EarlyAccess":["record-lists:manage"]}],"summary":"Updates a list of records in the record list.","operationId":"update_records","parameters":[{"name":"id","in":"path","description":"The identifier of the record list.","required":true,"schema":{"type":"string","minLength":1,"maxLength":36}}],"requestBody":{"content":{"application/json-patch+json":{"schema":{"type":"array","items":{"type":"object","properties":{"op":{"type":"string","enum":["replace","add"],"minLength":3,"maxLength":7,"description":"The operation to be performed

    • add -> Only allows 'value' field to pass 'extra_data'.
    • replace -> Only allows 'value' field to pass 'extra_data' or 'priority' or 'phone_numbers' or 'last_name' or 'first_name' or 'timezone'.
    • any other fields -> Do not allow.
    "},"path":{"type":"string","description":"A JSON-Pointer"},"value":{"type":"object","description":"The value to be used within the operations.

    • extra_data -> When 'op' is 'add' or 'replace'.
    • priority -> When 'op' is 'replace'.
    • phone_numbers -> When 'op' is 'replace'.
    • last_name -> When 'op' is 'replace'.
    • first_name -> When 'op' is 'replace'.
    • timezone -> When 'op' is 'replace'.
    • any other fields -> Do not allow.
    "}},"required":["op","path","value"]}},"example":[{"op":"replace","path":"/records/{record_id}","value":{"extra_data":{"home":"earth"},"priority":10}},{"op":"add","path":"/records/{record_id}","value":{"extra_data":{"name":"jerry"}}}]}},"description":"Updates a list of records in the record list.","required":true},"responses":{"200":{"description":"Records updated sucessfully","content":{"application/hal+json":{"schema":{"type":"object","description":"Response for multiple records creation","properties":{"record_list_id":{"type":"string","description":"Record list id","minLength":1,"maxLength":36},"has_errors":{"type":"boolean","description":"True if records upload has errors"},"total_errors":{"type":"integer","description":"Total number of errors found in the multiple records upload","minimum":0,"maximum":100},"total_created":{"type":"integer","description":"Total number of records created in multiple records upload request","minimum":0,"maximum":100},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string"}},"required":["href"]},"record_list":{"type":"object","properties":{"href":{"type":"string"}},"required":["href"]}},"required":["self","record_list"]},"_embedded":{"type":"object","description":"List of records resulted from insertion.","properties":{"records":{"type":"array","description":"Array of records","items":{"type":"object","description":"Record is completed with details if it was inserted or is annotated with errors otherwise.","properties":{"id":{"type":"string","description":"Record id"},"record_list_id":{"type":"string","description":"Record list id"},"phone_number":{"type":"string","description":"Phone number of the record","deprecated":true},"phone_numbers":{"type":"array","description":"List of phone numbers of the record","items":{"type":"object","description":"Record phone number","properties":{"phone_number":{"type":"string","description":"Record phone number","minLength":1,"maxLength":20},"phone_type":{"type":"string","description":"The type of the phone number","minLength":4,"maxLength":7,"enum":["HOME","OFFICE","MOBILE","EXTRA_1","EXTRA_2","EXTRA_3"]}},"required":["phone_number","phone_type"]},"minItems":1},"first_name":{"type":"string","description":"First name of the record"},"last_name":{"type":"string","description":"Last name of the record"},"timezone":{"type":"string","description":"Timezone of the record"},"priority":{"type":"integer","description":"Priority of the record within the record list","minimum":1,"maximum":10},"extra_data":{"type":"object","description":"Extra data of the record"},"external_provider":{"type":"string","description":"Reference for external provider source"},"external_id":{"type":"string","description":"Unique identifier for resource in external source"},"external_url":{"type":"string","description":"Resource location in external source"},"sync_external_id":{"type":"boolean","description":"Sync external id with contacts"},"errors":{"type":"array","items":{"type":"string","description":"Record errors","enum":["PHONE_NUMBER_INVALID","PHONE_NUMBER_MISSING","PHONE_NUMBER_NOT_UNIQUE","FIRST_NAME_INVALID","FIRST_NAME_MISSING","LAST_NAME_INVALID","LAST_NAME_MISSING","TIMEZONE_INVALID","TIMEZONE_MISSING","TIMEZONE_UNMATCHED","PRIORITY_INVALID","EXTERNAL_REF_MISSING","REQUIRED_FIELDS","OTHER"]}},"created_at":{"type":"string","description":"Record creation date"},"updated_at":{"type":"string","description":"Record udpate date"},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string"}}},"record_list":{"type":"object","properties":{"href":{"type":"string"}}}}}}}}}}}},"example":{"Records without errors":{"value":{"record_list_id":"b3eb858c-e880-4938-bba3-bd5b733dd9b5","has_errors":false,"total_errors":0,"total_created":2,"_links":{"self":{"href":"https://api.talkdeskapp.com/record-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5/records?upload_request=h872f371f-3544-4324-8a21-dbfe7b999b1c"},"record_list":{"href":"https://api.talkdeskapp.com/record-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5"}},"_embedded":{"records":[{"id":"c45f361f-2944-4844-8a21-dbfe7b000b1c","record_list_id":"b3eb858c-e880-4938-bba3-bd5b733dd9b5","phone_number":"+351929312312","phone_numbers":[{"phone_number":"+351929312312","phone_type":"MOBILE"}],"first_name":"Joey","last_name":"Tribbiani","timezone":"Europe/Lisbon","priority":7,"extra_data":{"country":"USA","state":"California","job":"Actor"},"external_provider":"salesforce","external_id":"0030O000024ukNtQAD","external_url":"https://xxx.salesforce.com/0030O000024ukNtQAD","sync_external_id":true,"created_at":"2020-03-24T11:48:40.503Z","updated_at":"2020-03-24T11:48:40.503Z","_links":{"self":{"href":"https://api.talkdeskapp.com/record-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5/records/c45f361f-2944-4844-8a21-dbfe7b000b1c"},"record_list":{"href":"https://api.talkdeskapp.com/record-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5"}}},{"id":"c45f361f-2944-4844-8a21-dbfe7b000b1c","record_list_id":"b3eb858c-e880-4938-bba3-bd5b733dd9b5","phone_number":"+351929312313","phone_numbers":[{"phone_number":"+351929312313","phone_type":"MOBILE"}],"first_name":"Jane","last_name":"Doe","timezone":"Europe/Lisbon","priority":7,"extra_data":{"country":"USA","state":"California","job":"Actor"},"external_provider":"salesforce","external_id":"0030O000024ukNtQAD","external_url":"https://xxx.salesforce.com/0030O000024ukNtQAD","sync_external_id":true,"created_at":"2020-03-24T11:48:40.503Z","updated_at":"2020-03-24T11:48:40.503Z","_links":{"self":{"href":"https://api.talkdeskapp.com/record-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5/records/c45f361f-2944-4844-8a21-dbfe7b000b1c"},"record_list":{"href":"https://api.talkdeskapp.com/record-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5"}}}]}}},"Records with errors":{"value":{"record_list_id":"b3eb858c-e880-4938-bba3-bd5b733dd9b5","has_errors":true,"total_errors":1,"total_updated":1,"_links":{"self":{"href":"https://api.talkdeskapp.com/record-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5/records?upload_request=h872f371f-3544-4324-8a21-dbfe7b999b1c"},"record_list":{"href":"https://api.talkdeskapp.com/record-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5"}},"_embedded":{"records":[{"id":"c45f361f-2944-4844-8a21-dbfe7b000b1c","record_list_id":"b3eb858c-e880-4938-bba3-bd5b733dd9b5","phone_number":"+351929312312","phone_numbers":[{"phone_number":"+351929312312","phone_type":"MOBILE"}],"first_name":"Joey","last_name":"Tribbiani","timezone":"Europe/Lisbon","priority":7,"extra_data":{"country":"USA","state":"California","job":"Actor"},"external_provider":"salesforce","external_id":"0030O000024ukNtQAD","external_url":"https://xxx.salesforce.com/0030O000024ukNtQAD","sync_external_id":true,"created_at":"2020-03-24T11:48:40.503Z","updated_at":"2020-03-24T11:48:40.503Z","_links":{"self":{"href":"https://api.talkdeskapp.com/record-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5/records/c45f361f-2944-4844-8a21-dbfe7b000b1c"},"record_list":{"href":"https://api.talkdeskapp.com/record-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5"}}},{"id":"c45f361f-2944-4844-8a21-dbfe7b000b1c","errors":["Priority must be a value between 1 and 10","record not child of record_list"]}]}}}}}}},"400":{"description":"Bad Request","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530900","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530901","message":"Missing or invalid authentication token."}}}},"403":{"description":"Forbidden","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530902","message":"Insufficient scopes for the requested operation."}}}},"404":{"description":"Record List not found","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530910","message":"Record List not found."}}}}}},"delete":{"x-namespace":"/record-lists","summary":"Bulk delete records from one record list by recordIds or phoneNumbers or externalProviders & externalIds","tags":["Record Lists"],"security":[{"EarlyAccess":["record-lists:manage","role-permissions:skip"]}],"parameters":[{"name":"id","in":"path","description":"The identifier of the record list.","required":true,"schema":{"type":"string","minLength":1,"maxLength":36}}],"requestBody":{"description":"An array of parameters needed to delete multiple Records.","required":true,"content":{"application/hal+json":{"schema":{"type":"array","description":"Choose one type of resource identifiers, id or phone number or external provider & external id","minItems":1,"maxItems":200,"items":{"type":"object","properties":{"id":{"type":"string","maxLength":36},"phone_number":{"type":"string","minLength":1,"maxLength":16},"external_provider":{"type":"string"},"external_id":{"type":"string"}}}},"examples":{"Example 1":{"value":[{"id":"8858c834-481d-4a02-8176-cffc02c50350"},{"id":"f03004be-2853-4660-b6e8-060cc383ddbe"},{"id":"ba85ef13-ed0c-4acc-8799-4b2e81e91dcb"}]},"Example 2":{"value":[{"phone_number":"+188888888"},{"phone_number":"+177777777"},{"phone_number":"+100000000"}]},"Example 3":{"value":[{"external_provider":"salesforce","external_id":"003DL0000212DetYAE"},{"external_provider":"salesforce","external_id":"003DL0000214OYdYAM"}]}}}}},"responses":{"200":{"description":"Record(s) have been deleted.","content":{"application/hal+json":{"schema":{"description":"Bulk deleted records response samples.","type":"object","properties":{"record_list_id":{"description":"The id of record list.","type":"string"},"has_errors":{"type":"boolean","description":"True if records deleted has errors."},"total_errors":{"type":"integer","description":"The number of the total errors.","minimum":0,"maximum":100},"total_deleted":{"type":"integer","description":"The total number of deleted.","minimum":0,"maximum":100},"_links":{"type":"object","description":"HAL API related links.","properties":{"self":{"type":"object","properties":{"href":{"type":"string"}},"description":"The records page link."},"record_list":{"type":"object","properties":{"href":{"type":"string"}},"description":"The record-lists page link."}}},"_embedded":{"type":"object","properties":{"failed_records":{"description":"The number of records that failed to delete.","type":"array","items":{"type":"object","description":"Failed Records HAL object.","properties":{"id":{"type":"string","description":"Entry id"},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string"}}}}}}}}}}}},"examples":{"Example 1":{"value":{"record_list_id":"b3eb858c-e880-4938-bba3-bd5b733dd9b5","has_errors":true,"total_errors":2,"total_deleted":1,"_links":{"self":{"href":"https://api.talkdeskapp.com/record-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5/records"},"record_list":{"href":"https://api.talkdeskapp.com/record-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5"}},"_embedded":{"failed_records":[{"id":"c45f361f-2944-4844-8a21-dbfe7b000b1c","_links":{"self":{"href":"https://api.talkdeskapp.com/record-lists/{id}/records/c45f361f-2944-4844-8a21-dbfe7b000b1c"}}}],"reason":{"bad_request_param":["8858c834-481d-4a02-8176-cffc02c50350"],"record_not_found":["ba85ef13-ed0c-4acc-8799-4b2e81e91dcb"]}}}},"Example 2":{"value":{"record_list_id":"b3eb858c-e880-4938-bba3-bd5b733dd9b5","has_errors":true,"total_errors":2,"total_deleted":1,"_links":{"self":{"href":"https://api.talkdeskapp.com/record-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5/records"},"record_list":{"href":"https://api.talkdeskapp.com/record-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5"}},"_embedded":{"reason":{"bad_request_param":["+100000000"],"record_not_found":["+177777777"]}}}},"Example 3":{"value":{"record_list_id":"b3eb858c-e880-4938-bba3-bd5b733dd9b5","has_errors":true,"total_errors":1,"total_deleted":1,"_links":{"self":{"href":"https://api.talkdeskapp.com/record-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5/records"},"record_list":{"href":"https://api.talkdeskapp.com/record-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5"}},"_embedded":{"reason":{"record_not_found":["external_provider=salesforce, external_id=003DL0000214OYdYAM"]}}}}}}}},"202":{"description":"Accepted record(s) delete request, will delete the record(s) in 5 seconds."},"400":{"description":"Bad request in the submitted data.","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530900","message":"Bad request."}}}},"403":{"description":"Forbidden","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530902","message":"Insufficient scopes for the requested operation."}}}},"404":{"description":"Resource not found","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530910","message":"Record List not found."}}}}}}},"/record-lists/{id}/upload-requests":{"post":{"summary":"Create a signed URL to upload a csv file into an existing record list","x-namespace":"/record-lists","tags":["Record Lists"],"description":"Returns a signed URL which allows to temporarily insert records into the record list as a csv_file","security":[{"EarlyAccess":["record-lists:manage"]}],"parameters":[{"name":"id","in":"path","description":"The identifier of the record list.","required":true,"schema":{"type":"string","minLength":1,"maxLength":36}}],"requestBody":{"description":"CSV file metadata and notification parameters","required":true,"content":{"application/hal+json":{"schema":{"type":"object","required":["csv_metadata"],"properties":{"csv_metadata":{"type":"object","description":"Object containing relevant information about the csv file","properties":{"filename":{"type":"string","description":"Name of the csv file to be uploaded","minLength":1,"maxLength":35},"byte_size":{"type":"integer","description":"Size of the file in bytes","minimum":1,"maximum":20000},"checksum":{"type":"string","description":"Hash of the file done using the algorithm MD5","minLength":1,"maxLength":32},"content_type":{"type":"string","description":"text/csv","minLength":1,"maxLength":35}}},"callback_action":{"type":"object","description":"Callback action invocation after the job has finished","required":["endpoint","method"],"properties":{"endpoint":{"type":"string","description":"The endpoint for the callback request"},"method":{"type":"string","description":"Method to call the callback request"},"body":{"type":"object","description":"Body of the callback request"},"headers":{"type":"object","description":"Headers used in the callback request","x-api-key":{"type":"string","description":"Contents in the headers of the request"}}}},"send_atlas_notification":{"type":"boolean","description":"true to send an atlas notification after the job has finished (default: false)"}}},"example":{"csv_metadata":{"filename":"recordList.csv","byte_size":413,"checksum":"d2c07dcf1589304317056dd7e28e32b8","content_type":"text/csv"},"callback_action":{"endpoint":"http://endpoint/callback","method":"POST","body":{"address":"old street"},"headers":{"x-api-key":"secret key"}},"send_atlas_notification":true}}}},"responses":{"201":{"description":"Created signed URL for the csv file","content":{"application/hal+json":{"schema":{"type":"object","description":"Created upload request and signed url to upload CSV file","properties":{"id":{"type":"string","description":"ID of upload request"},"record_list_id":{"type":"string","description":"ID of record list"},"signed_url":{"type":"string","description":"Url to save the csv file in S3"},"status":{"type":"string","description":"Current status of upload request"},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string"}}},"record_list":{"type":"object","properties":{"href":{"type":"string"}}},"upload":{"type":"object","properties":{"href":{"type":"string"}}}}}}},"example":{"id":"e9384556-065f-4c48-b097-355a427ca938","record_list_id":"d2960556-065f-4c48-b097-355a427ca805","signed_url":"https://s3.amazonaws.com/app_bucket_name/xkbe7qb3hkgm87pni31ip88n5zr5?X-Amz-Algorithm=AWS4-HMAC-SHA","status":"INCOMPLETE","_links":{"self":{"href":"https://api.talkdeskapp.com/record-lists/d2960556-065f-4c48-b097-355a427ca805/upload_request/e9384556-065f-4c48-b097-355a427ca938"},"record_list":{"href":"https://api.talkdeskapp.com/record-lists/d2960556-065f-4c48-b097-355a427ca805"},"upload":{"href":"https://s3.amazonaws.com/app_bucket_name/xkbe7qb3hkgm87pni31ip88n5zr5?X-Amz-Algorithm=AWS4-HMAC-SHA"}}}}}},"400":{"description":"Errors were found in the submitted data","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"General bad request":{"value":{"code":"0530900","message":"Bad request."}},"CSV metadata is missing":{"value":{"code":"0530933","message":"Missing required CSV metadata."}},"Callback endpoint missing":{"value":{"code":"0530934","message":"Callback action endpoint is missing."}},"Callback method missing":{"value":{"code":"0530935","message":"Callback action method is missing."}}}}}},"401":{"description":"Unauthorized","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530901","message":"Missing or invalid authentication token."}}}},"403":{"description":"Forbidden","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530902","message":"Insufficient scopes for the requested operation."}}}},"404":{"description":"Resource not found","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530910","message":"Record List not found."}}}},"413":{"description":"Payload too large","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530908","message":"Maximum file size allowed (20Mb) was reached."}}}}}}},"/record-lists/{id}/upload-requests/{id_upload_request}":{"patch":{"summary":"Update upload request","x-namespace":"/record-lists","tags":["Record Lists"],"description":"Returns a upload request object and starts file validation. Notifies by WebHook or Workspace notification when it is finished, if previously set to do so.","security":[{"EarlyAccess":["record-lists:manage"]}],"parameters":[{"name":"id","in":"path","description":"Record list id","required":true,"schema":{"type":"string","minLength":32,"maxLength":32}},{"name":"id_upload_request","in":"path","description":"Upload request id","required":true,"schema":{"type":"string","minLength":32,"maxLength":32}}],"requestBody":{"description":"Update status of upload request file","required":true,"content":{"application/json-patch+json":{"schema":{"type":"object","required":["op","path"],"properties":{"op":{"type":"string","description":"Operation to perform on path."},"path":{"type":"string","description":"Path to perform operation."},"value":{"type":"string","description":"New value of path, if operation is replace."}}},"example":{"op":"replace","path":"/status","value":"UPLOADED"}}}},"responses":{"200":{"description":"Upload request updated.","content":{"application/hal+json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID of upload request"},"record_list_id":{"type":"string","description":"ID of record list"},"status":{"type":"string","description":"Current status of upload request"},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string"}}},"record_list":{"type":"object","properties":{"href":{"type":"string"}}}}}}},"example":{"id":"e9384556-065f-4c48-b097-355a427ca938","record_list_id":"d2960556-065f-4c48-b097-355a427ca805","status":"UPLOADED","_links":{"self":{"href":"https://api.talkdeskapp.com/record-lists/d2960556-065f-4c48-b097-355a427ca805/upload_request/e9384556-065f-4c48-b097-355a427ca938"},"record_list":{"href":"https://api.talkdeskapp.com/record-lists/d2960556-065f-4c48-b097-355a427ca805"}}}}}},"400":{"description":"Errors were found in the submitted request","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Generic error":{"value":{"code":"0530900","message":"Bad request."}},"Concurrency limit exceeded":{"value":{"code":"0531000","message":"Concurrent upload requests limit reached."}}}}}},"401":{"description":"Unauthorized.","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530901","message":"Missing or invalid authentication token."}}}},"403":{"description":"Forbidden.","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530902","message":"Insufficient scopes for the requested operation."}}}},"404":{"description":"Resource not found.","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Record list not found":{"value":{"code":"0530910","message":"Record List not found."}},"Update request not found":{"value":{"code":"0530950","message":"Upload Request not found."}}}}}},"409":{"description":"Request conflicts with current state of Record List or Upload Request.","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Record list in conflict":{"value":{"code":"0530907","message":"Record List is in a state where the operation is not possible."}},"Upload request in conflict":{"value":{"code":"0530951","message":"Upload Request is in a state where the operation is not possible."}}}}}},"422":{"description":"Unable to perform the requested operation on target resource.","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530904","message":"Errors were found in the submitted data."}}}}}}},"/do-not-call-lists":{"post":{"summary":"Creates a Do Not Call List and returns a signed URL to upload a csv file","tags":["Do Not Call Lists"],"description":"Creates a Do Not Call List and returns a signed URL which allows to temporarily upload the do not call list as a csv_file","security":[{"EarlyAccess":["do-not-call-lists:manage"]}],"requestBody":{"description":"Do Not Call List configuration parameters","required":true,"content":{"application/hal+json":{"schema":{"example":{"name":"Do Not Call List 20","csv_metadata":{"filename":"donotcalllist.csv","byte_size":413,"checksum":"d2c07dcf1589304317056dd7e28e32b8","content_type":"text/csv"}},"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Name of the Do Not Call List","minLength":1,"maxLength":120},"csv_metadata":{"type":"object","description":"Object containing relevant information about the csv file","properties":{"filename":{"type":"string","description":"Name of the csv file to be uploaded"},"byte_size":{"type":"integer","description":"Size of the file in bytes"},"checksum":{"type":"string","description":"Hash of the file done using the algorithm MD5"},"content_type":{"type":"string","description":"text/csv"}}}}}}}},"responses":{"201":{"description":"Created do not call list and signed URL for the csv file","content":{"application/hal+json":{"schema":{"example":{"id":"e9e096fe-ec58-408b-8012-e19da4b21cca","name":"Do Not Call List 20","status":"INCOMPLETE","signed_url":"https://s3.amazonaws.com/app_bucket_name/xkbe7qb3hkgm87pni31ip88n5zr5?X-Amz-Algorithm=AWS4-HMAC-SHA","_links":{"self":{"href":"https://api.talkdeskapp.com/do-not-call-lists/e9e096fe-ec58-408b-8012-e19da4b21cca"},"upload":{"href":"https://s3.amazonaws.com/app_bucket_name/xkbe7qb3hkgm87pni31ip88n5zr5?X-Amz-Algorithm=AWS4-HMAC-SHA"}}},"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID of created list"},"name":{"type":"string","description":"Name of created list"},"status":{"type":"string","description":"status of the csv file"},"signed_url":{"type":"string","description":"url used to save the csv file in S3"},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string"}}}}}}}}}},"400":{"description":"Errors were found in the submitted data","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0531500","message":"Errors were found in the submitted data."}}}},"401":{"description":"Unauthorized","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0531501","message":"Missing or invalid authentication token."}}}},"403":{"description":"Forbidden","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0531502","message":"Insufficient scopes for the requested operation."}}}},"413":{"description":"Payload too large","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0531506","message":"Maximum file size allowed (100Mb) was reached"}}}}}},"get":{"summary":"List Do Not Call Lists","tags":["Do Not Call Lists"],"security":[{"EarlyAccess":["do-not-call-lists:manage"]}],"parameters":[{"name":"name","in":"query","description":"Filter Do Not Call Lists by name","schema":{"type":"string"}},{"name":"status","in":"query","description":"Filter Do Not Call Lists by status","schema":{"type":"string"}},{"name":"team_id","in":"query","description":"Filter Do Not Call Lists by team id. team_id and team_ids are mutually exclusive.","required":false,"schema":{"type":"string"}},{"name":"team_ids","in":"query","description":"Filter Do Not Call Lists by team ids. team_id and team_ids are mutually exclusive.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"campaign_ids","in":"query","description":"Filter do not call Lists by campaign ids.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"fields","in":"query","description":"Allows to request the sub entities of the do not call list.

    • teams -> Return the do not call list's teams information.
    ","required":false,"schema":{"type":"string","enum":["TEAMS"]}},{"name":"include_none_team","in":"query","description":"If include_none_team equals true, this parameter will also return do not call lists with no team.","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Number of the page listed","schema":{"type":"integer"}},{"name":"per_page","in":"query","description":"Number of max items per page","schema":{"type":"integer"}},{"name":"created_at_from","in":"query","description":"Filter by Do Not Call Lists created_at","schema":{"type":"string"}},{"name":"created_at_to","in":"query","description":"Filter by Do Not Call Lists created_at","schema":{"type":"string"}},{"name":"updated_at_from","in":"query","description":"Filter by Do Not Call Lists updated_at","schema":{"type":"string"}},{"name":"updated_at_to","in":"query","description":"Filter by Do Not Call Lists updated_at","schema":{"type":"string"}},{"name":"order_by","in":"query","description":"Order by Do Not Call Lists for names, number of entries, created_at, updated_at","schema":{"example":"name,entries_count:desc,created_at:desc,updated_at:asc","default":"created_at:desc","x-sorting_default_order":"asc","x-sorting_fields":["name","entries_count","created_at","updated_at"],"type":"string"}}],"responses":{"200":{"description":"Get the list of do not call lists","content":{"application/hal+json":{"schema":{"example":{"page":2,"total_pages":3,"total":3,"per_page":1,"count":1,"_links":{"self":{"href":"https://api.talkdeskapp.com/do-not-call-lists/?page=2&per_page=1"},"next":{"href":"https://api.talkdeskapp.com/do-not-call-lists/?page=3&per_page=1"},"prev":{"href":"https://api.talkdeskapp.com/do-not-call-lists/?page=1&per_page=1"},"first":{"href":"https://api.talkdeskapp.com/do-not-call-lists/?page=1&per_page=1"},"last":{"href":"https://api.talkdeskapp.com/do-not-call-lists/?page=3&per_page=1"}},"_embedded":{"do_not_call_lists":[{"id":"a0d3ca1d-112a-4309-9d48-b11501db702e","name":"do not call list 1","account_id":"5d0c9a22f8cf30001de12300","created_at":"2020-03-24T11:48:40.503Z","updated_at":"2020-03-24T11:48:40.503Z","entries_count":10,"status":"accepted","teams":[{"id":"367ac248e7c6415980bad277d2de91a5","name":"Team A","_links":{"self":{"href":"https://api-docs.talkdesk.org/teams/367ac248e7c6415980bad277d2de91a5"}}}],"_links":{"self":{"href":"https://api.talkdeskapp.com/do-not-call-lists/a0d3ca1d-112a-4309-9d48-b11501db702e"}},"campaign_page":[{"total":3,"total_pages":3,"page":1,"per_page":1,"count":3,"_embedded":{"campaigns":[{"id":"367ac248e7c6415980bad277d2de9112","campaign_name":"Campaign A","_links":{"self":{"href":"https://api-docs.talkdesk.org/campaigns/367ac248e7c6415980bad277d2de9112"}}}]},"_links":{"self":{"href":"https://api.talkdeskapp.com/do-not-call-lists/8858c834-481d-4a02-8176-cffc02c50350/campaigns?page=2&per_page=1"},"next":{"href":"https://api.talkdeskapp.com/do-not-call-lists/8858c834-481d-4a02-8176-cffc02c50350/campaigns?page=3&per_page=1"},"prev":{"href":"https://api.talkdeskapp.com/do-not-call-lists/8858c834-481d-4a02-8176-cffc02c50350/campaigns?page=1&per_page=1"},"first":{"href":"https://api.talkdeskapp.com/do-not-call-lists/8858c834-481d-4a02-8176-cffc02c50350/campaigns?page=1&per_page=1"},"last":{"href":"https://api.talkdeskapp.com/do-not-call-lists/8858c834-481d-4a02-8176-cffc02c50350/campaigns?page=3&per_page=1"}}}]}]}},"description":"List with the paginated samples","properties":{"per_page":{"description":"The number of items per page","type":"integer"},"total":{"description":"The total number of items","type":"integer"},"count":{"description":"The number of items in the page","type":"integer"},"page":{"description":"The number of the current page","type":"integer"},"total_pages":{"description":"The total number of pages","type":"integer"},"_links":{"description":"HAL API related links","type":"object","properties":{"next":{"description":"Link of the next page","type":"object","properties":{"href":{"description":"Address of the resource","type":"string"}}},"last":{"description":"Link of the last page","type":"object","properties":{"href":{"description":"Address of the resource","type":"string"}}},"prev":{"description":"Link of the previous page","type":"object","properties":{"href":{"description":"Address of the resource","type":"string"}}},"self":{"description":"Link of the current page","type":"object","properties":{"href":{"description":"Address of the resource","type":"string"}}},"first":{"description":"Link of the first page","type":"object","properties":{"href":{"description":"Address of the resource","type":"string"}}}},"required":["self","next","prev","first","last"]},"_embedded":{"properties":{"do_not_call_lists":{"description":"List of do not call lists paginated","items":{"description":"Do not call list HAL object","readOnly":true,"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID of the do not call list created."},"name":{"type":"string","description":"Do not call list name"},"created_at":{"type":"string","description":"Do not call list creation date."},"updated_at":{"type":"string","description":"Do not call list updated date."},"status":{"type":"string","description":"Status of validation process done on the do not call list csv file.","enum":["REJECTED","VALIDATION_STARTED","UPLOADED","ACCEPTED","INCOMPLETE","CORRUPTED"]},"entries_count":{"type":"integer","description":"How many entries are present in the do not call list."},"teams":{"type":"array","description":"Teams that this do not call list belongs to, if any.","items":{"type":"object","description":"The team assigned to the do not call list.","properties":{"id":{"type":"string","description":"The team ID of the do not call list."},"name":{"type":"string","description":"The team name of the do not call list."},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string"}}}}}}}},"campaign_page":{"description":"Campaigns associated with the do-not-call-lists.","type":"object","properties":{"total":{"description":"The number of items.","type":"integer"},"per_page":{"description":"The number of items per page.","type":"integer"},"count":{"description":"The total number of items in this page.","type":"integer"},"page":{"description":"The number of the current page.","type":"integer"},"total_pages":{"description":"The total number of pages.","type":"integer"},"_embedded":{"properties":{"campaigns":{"description":"List of campaigns paginated.","items":{"description":"Campaign HAL object.","readOnly":true,"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"External ID of the campaign created."},"campaign_name":{"type":"string","description":"Campaign name."},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string"}}}}}}},"type":"array"}},"type":"object","required":["campaigns"]},"_links":{"description":"HAL API related links.","type":"object","properties":{"next":{"description":"Link of the next page","type":"object","properties":{"href":{"description":"Address of the resource","type":"string"}}},"last":{"description":"Link of the last page","type":"object","properties":{"href":{"description":"Address of the resource","type":"string"}}},"prev":{"description":"Link of the previous page","type":"object","properties":{"href":{"description":"Address of the resource","type":"string"}}},"self":{"description":"Link of the current page","type":"object","properties":{"href":{"description":"Address of the resource","type":"string"}}},"first":{"description":"Link of the first page","type":"object","properties":{"href":{"description":"Address of the resource","type":"string"}}}},"required":["self","next","prev","first","last"]}},"required":["per_page","page","total","_links"]},"account_id":{"type":"string","description":"Account id of do not call list."},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string"}}}}}}},"type":"array"}},"type":"object"}},"required":["per_page","page"],"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0531501","message":"Missing or invalid authentication token."}}}},"403":{"description":"Forbidden","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0531502","message":"Insufficient scopes for the requested operation."}}}}}}},"/do-not-call-lists/{id}":{"get":{"summary":"Get a do not call list","tags":["Do Not Call Lists"],"description":"Get the details of a do not call list","security":[{"EarlyAccess":["do-not-call-lists:manage"]}],"parameters":[{"name":"id","in":"path","description":"The identifier of the do not call list.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Allows to request the sub entities of the do not call list

    • teams -> Return the do not call list's teams information.
    ","required":false,"schema":{"type":"string","enum":["TEAMS"]}}],"responses":{"200":{"description":"The do not call list details.","content":{"application/hal+json":{"schema":{"type":"object","description":"Do not call list object.","properties":{"id":{"type":"string","format":"uuid","description":"ID of the do not call list created."},"name":{"type":"string","description":"Do not call list name"},"created_at":{"type":"string","description":"Do not call list creation date."},"updated_at":{"type":"string","description":"Do not call list updated date."},"status":{"type":"string","description":"Status of validation process done on the do not call list csv file.","enum":["REJECTED","VALIDATION_STARTED","UPLOADED","ACCEPTED","INCOMPLETE","CORRUPTED"]},"entries_count":{"type":"integer","description":"How many entries are present in the do not call list."},"teams":{"type":"array","description":"Teams that this do not call list belongs to, if any.","items":{"type":"object","description":"The team assigned to the do not call list.","properties":{"id":{"type":"string","description":"The team ID of the do not call list."},"name":{"type":"string","description":"The team name of the do not call list."},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string"}}}}}}}},"campaign_page":{"description":"Campaigns associated with the do-not-call-lists.","type":"object","properties":{"total":{"description":"The number of items.","type":"integer"},"per_page":{"description":"The number of items per page.","type":"integer"},"count":{"description":"The total number of items in this page.","type":"integer"},"page":{"description":"The number of the current page.","type":"integer"},"total_pages":{"description":"The total number of pages.","type":"integer"},"_embedded":{"properties":{"campaigns":{"description":"List of campaigns paginated.","items":{"description":"Campaign HAL object.","readOnly":true,"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"External ID of the campaign created."},"campaign_name":{"type":"string","description":"Campaign name."},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string"}}}}}}},"type":"array"}},"type":"object","required":["campaigns"]},"_links":{"description":"HAL API related links.","type":"object","properties":{"next":{"description":"Link of the next page","type":"object","properties":{"href":{"description":"Address of the resource","type":"string"}}},"last":{"description":"Link of the last page","type":"object","properties":{"href":{"description":"Address of the resource","type":"string"}}},"prev":{"description":"Link of the previous page","type":"object","properties":{"href":{"description":"Address of the resource","type":"string"}}},"self":{"description":"Link of the current page","type":"object","properties":{"href":{"description":"Address of the resource","type":"string"}}},"first":{"description":"Link of the first page","type":"object","properties":{"href":{"description":"Address of the resource","type":"string"}}}},"required":["self","next","prev","first","last"]}},"required":["per_page","page","total","_links"]},"account_id":{"type":"string","description":"Account id of do not call list."},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string"}}}}}}},"example":{"id":"a0d3ca1d-112a-4309-9d48-b11501db702e","name":"do not call list 1","account_id":"5d0c9a22f8cf30001de12300","created_at":"2020-03-24T11:48:40.503Z","updated_at":"2020-03-24T11:48:40.503Z","entries_count":10,"status":"accepted","teams":[{"id":"367ac248e7c6415980bad277d2de91a5","name":"Team A","_links":{"self":{"href":"https://api-docs.talkdesk.org/teams/367ac248e7c6415980bad277d2de91a5"}}}],"_links":{"self":{"href":"https://api.talkdeskapp.com/do-not-call-lists/a0d3ca1d-112a-4309-9d48-b11501db702e"}},"campaign_page":[{"total":3,"total_pages":3,"page":1,"per_page":1,"count":3,"_embedded":{"campaigns":[{"id":"367ac248e7c6415980bad277d2de9112","campaign_name":"Campaign A","_links":{"self":{"href":"https://api-docs.talkdesk.org/campaigns/367ac248e7c6415980bad277d2de9112"}}}]},"_links":{"self":{"href":"https://api.talkdeskapp.com/do-not-call-lists/8858c834-481d-4a02-8176-cffc02c50350/campaigns?page=2&per_page=1"},"next":{"href":"https://api.talkdeskapp.com/do-not-call-lists/8858c834-481d-4a02-8176-cffc02c50350/campaigns?page=3&per_page=1"},"prev":{"href":"https://api.talkdeskapp.com/do-not-call-lists/8858c834-481d-4a02-8176-cffc02c50350/campaigns?page=1&per_page=1"},"first":{"href":"https://api.talkdeskapp.com/do-not-call-lists/8858c834-481d-4a02-8176-cffc02c50350/campaigns?page=1&per_page=1"},"last":{"href":"https://api.talkdeskapp.com/do-not-call-lists/8858c834-481d-4a02-8176-cffc02c50350/campaigns?page=3&per_page=1"}}}]}}}},"401":{"description":"Unauthorized","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0531501","message":"Missing or invalid authentication token."}}}},"403":{"description":"Forbidden","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0531502","message":"Insufficient scopes for the requested operation."}}}},"404":{"description":"Do not call list not found.","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0531510","message":"Do Not Call List not found."}}}}}}},"/do-not-call-lists/{id}/teams":{"get":{"summary":"Get teams assigned to a do not call list.","tags":["Do Not Call Lists"],"description":"Get teams assigned to a do not call list.","security":[{"EarlyAccess":["do-not-call-lists:manage"]}],"parameters":[{"name":"id","in":"path","description":"The identifier of the do not call list.","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"number of the page listed.","schema":{"format":"int32","type":"integer","default":1,"minimum":1,"maximum":2147483647}},{"name":"per_page","in":"query","description":"Number of max items per page.","schema":{"type":"integer","format":"int32","default":50,"minimum":1,"maximum":500}}],"responses":{"200":{"description":"Get team list of do not call lists.","content":{"application/hal+json":{"schema":{"description":"Teams of a do not call list with the paginated samples.","type":"object","properties":{"per_page":{"description":"The number of items per page.","type":"integer"},"count":{"description":"The total number of items.","type":"integer"},"page":{"description":"The number of the current page.","type":"integer"},"total_pages":{"description":"The total number of pages.","type":"integer"},"_links":{"description":"HAL API related links.","type":"object","properties":{"self":{"type":"object","allOf":[{"required":["href"],"type":"object","properties":{"href":{"type":"string","description":"The hypertext reference.","example":"http:///do-not-call-lists//teams?page=3"}},"description":"Contains information about the HAL link."}],"description":"The current page link."},"prev":{"type":"object","allOf":[{"required":["href"],"type":"object","properties":{"href":{"type":"string","description":"The hypertext reference.","example":"http:///do-not-call-lists//teams?page=3"}},"description":"Contains information about the HAL link."}],"description":"The previous page link."},"next":{"type":"object","allOf":[{"required":["href"],"type":"object","properties":{"href":{"type":"string","description":"The hypertext reference.","example":"http:///do-not-call-lists//teams?page=3"}},"description":"Contains information about the HAL link."}],"description":"The next page link."},"first":{"type":"object","allOf":[{"required":["href"],"type":"object","properties":{"href":{"type":"string","description":"The hypertext reference.","example":"http:///do-not-call-lists//teams?page=3"}},"description":"Contains information about the HAL link."}],"description":"The first page link."},"last":{"type":"object","allOf":[{"required":["href"],"type":"object","properties":{"href":{"type":"string","description":"The hypertext reference.","example":"http:///do-not-call-lists//teams?page=3"}},"description":"Contains information about the HAL link."}],"description":"The last page link."}}},"_embedded":{"type":"object","required":["teams"],"properties":{"teams":{"description":"List of paginated do not call list list teams.","type":"array","items":{"description":"Do Not Call List HAL object.","readOnly":true,"type":"object","properties":{"id":{"type":"string","description":"The team ID of the do not call list."},"name":{"type":"string","description":"The team name of the do not call list."},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string"}}},"teams":{"type":"object","properties":{"href":{"type":"string"}}}}}}}}}}}},"example":{"page":1,"total_pages":3,"per_page":1,"count":3,"_links":{"self":{"href":"https://api.talkdeskapp.com/do-not-call-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5/teams?page=1&per_page=1"},"next":{"href":"https://api.talkdeskapp.com/do-not-call-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5/teams?page=2&per_page=1"},"prev":{"href":"https://api.talkdeskapp.com/do-not-call-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5/teams?page=1&per_page=1"},"first":{"href":"https://api.talkdeskapp.com/do-not-call-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5/teams?page=1&per_page=1"},"last":{"href":"https://api.talkdeskapp.com/do-not-call-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5/teams?page=3&per_page=1"}},"_embedded":{"teams":[{"id":"c45f361f-2944-4844-8a21-dbfe7b000b1c","name":"Team A","_links":{"self":{"href":"https://api.talkdeskapp.com/teams/c45f361f-2944-4844-8a21-dbfe7b000b1c"},"teams":{"href":"https://api.talkdeskapp.com/teams"}}}]}}}}},"401":{"description":"Unauthorized.","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0531501","message":"Missing or invalid authentication token."}}}},"403":{"description":"Forbidden.","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0531502","message":"Insufficient scopes for the requested operation."}}}},"404":{"description":"Do Not Call List not found.","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0531510","message":"Do Not Call List not found."}}}},"405":{"description":"Method Not Allowed."}}},"post":{"summary":"Assign teams to a do not call list.","tags":["Do Not Call Lists"],"description":"Assign teams to a do not call list.","security":[{"EarlyAccess":["do-not-call-lists:manage"]}],"parameters":[{"name":"id","in":"path","description":"The identifier of the do not call list.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"parameters needed to assign teams to a do not call list.","required":true,"content":{"application/hal+json":{"schema":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"object","properties":{"id":{"type":"string","maxLength":36}},"required":["id"]}},"example":[{"id":"8858c834-481d-4a02-8176-cffc02c50350"},{"id":"f03004be-2853-4660-b6e8-060cc383ddbe"}]}}},"responses":{"201":{"description":"Assign teams success.","content":{"application/hal+json":{"schema":{"description":"Teams of a do not call list with the paginated samples.","type":"object","properties":{"per_page":{"description":"The number of items per page.","type":"integer"},"count":{"description":"The total number of items.","type":"integer"},"page":{"description":"The number of the current page.","type":"integer"},"total_pages":{"description":"The total number of pages.","type":"integer"},"_links":{"description":"HAL API related links.","type":"object","properties":{"self":{"type":"object","allOf":[{"required":["href"],"type":"object","properties":{"href":{"type":"string","description":"The hypertext reference.","example":"http:///do-not-call-lists//teams?page=3"}},"description":"Contains information about the HAL link."}],"description":"The current page link."},"prev":{"type":"object","allOf":[{"required":["href"],"type":"object","properties":{"href":{"type":"string","description":"The hypertext reference.","example":"http:///do-not-call-lists//teams?page=3"}},"description":"Contains information about the HAL link."}],"description":"The previous page link."},"next":{"type":"object","allOf":[{"required":["href"],"type":"object","properties":{"href":{"type":"string","description":"The hypertext reference.","example":"http:///do-not-call-lists//teams?page=3"}},"description":"Contains information about the HAL link."}],"description":"The next page link."},"first":{"type":"object","allOf":[{"required":["href"],"type":"object","properties":{"href":{"type":"string","description":"The hypertext reference.","example":"http:///do-not-call-lists//teams?page=3"}},"description":"Contains information about the HAL link."}],"description":"The first page link."},"last":{"type":"object","allOf":[{"required":["href"],"type":"object","properties":{"href":{"type":"string","description":"The hypertext reference.","example":"http:///do-not-call-lists//teams?page=3"}},"description":"Contains information about the HAL link."}],"description":"The last page link."}}},"_embedded":{"type":"object","required":["teams"],"properties":{"teams":{"description":"List of paginated do not call list list teams.","type":"array","items":{"description":"Do Not Call List HAL object.","readOnly":true,"type":"object","properties":{"id":{"type":"string","description":"The team ID of the do not call list."},"name":{"type":"string","description":"The team name of the do not call list."},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string"}}},"teams":{"type":"object","properties":{"href":{"type":"string"}}}}}}}}}}}},"example":{"page":1,"total_pages":3,"per_page":1,"count":3,"_links":{"self":{"href":"https://api.talkdeskapp.com/do-not-call-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5/teams?page=1&per_page=1"},"next":{"href":"https://api.talkdeskapp.com/do-not-call-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5/teams?page=2&per_page=1"},"prev":{"href":"https://api.talkdeskapp.com/do-not-call-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5/teams?page=1&per_page=1"},"first":{"href":"https://api.talkdeskapp.com/do-not-call-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5/teams?page=1&per_page=1"},"last":{"href":"https://api.talkdeskapp.com/do-not-call-lists/b3eb858c-e880-4938-bba3-bd5b733dd9b5/teams?page=3&per_page=1"}},"_embedded":{"teams":[{"id":"c45f361f-2944-4844-8a21-dbfe7b000b1c","name":"Team A","_links":{"self":{"href":"https://api.talkdeskapp.com/teams/c45f361f-2944-4844-8a21-dbfe7b000b1c"},"teams":{"href":"https://api.talkdeskapp.com/teams"}}}]}}}}},"401":{"description":"Unauthorized.","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0531501","message":"Missing or invalid authentication token."}}}},"403":{"description":"Forbidden.","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"General Forbidden":{"value":{"code":"0531502","message":"Insufficient scopes for the requested operation."}},"Insufficient Permissions":{"value":{"code":"0531509","message":"Insufficient permissions for the requested operation."}}}}}},"404":{"description":"do not call list not found.","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0531510","message":"Do Not Call List not found."}}}},"405":{"description":"Method Not Allowed."}}},"delete":{"summary":"Unassign teams from a do not call list.","tags":["Do Not Call Lists"],"description":"Unassign teams from a do not call list.","security":[{"EarlyAccess":["do-not-call-lists:manage"]}],"parameters":[{"name":"id","in":"path","description":"The identifier of the do not call list.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"parameters needed to unassign teams to a do not call list.","required":true,"content":{"application/hal+json":{"schema":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"object","properties":{"id":{"type":"string","maxLength":36}},"required":["id"]}},"example":[{"id":"8858c834-481d-4a02-8176-cffc02c50350"},{"id":"f03004be-2853-4660-b6e8-060cc383ddbe"}]}}},"responses":{"204":{"description":"Unassign teams success."},"400":{"description":"Errors were found in the submitted data.","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0531526","message":"Team is invalid."}}}},"401":{"description":"Unauthorized.","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0531501","message":"Missing or invalid authentication token."}}}},"403":{"description":"Forbidden.","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0531502","message":"Insufficient scopes for the requested operation."}}}},"404":{"description":"Do Not Call List not found.","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0531510","message":"Do Not Call List not found."}}}},"405":{"description":"Method Not Allowed."}}}},"/recordings/{id}":{"get":{"description":"Get recording details, screen recording is not included","security":[{"GA":["recordings:read"]}],"parameters":[{"name":"id","in":"path","description":"The recording id","required":true,"schema":{"type":"string"}},{"name":"redacted","in":"query","description":"If this parameter omitted or redacted=true, the api will show the redacted recordings if available, otherwise it will show the original recordings.","required":false,"schema":{"type":"string"},"example":"false"}],"tags":["Recordings"],"responses":{"200":{"description":"Recording details","content":{"application/json":{"schema":{"example":{"id":"1ba635df-963d-4f35-b22f-8b3271e43e41","call_id":"89efa1c4-2ac1-4241-9ab5-821251694584","created_at":"2016-07-11T16:34:50.000Z","index":0,"duration":10,"type":"conversation","agents":{"channel_1":[{"participant_type":"AGENT","participant_id":"0190ef26f59b750d84fc04128b211bd2"}],"channel_2":[{"participant_type":"CONTACT","participant_id":null}]},"_links":{"self":{"href":"http://api-docs.talkdesk.org/recordings/{recording_id}"},"media":{"href":"http://api-docs.talkdesk.org/recordings/{recording_id}/media"}}},"type":"object","properties":{"recording":{"type":"object","properties":{"id":{"type":"string"},"call_id":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"index":{"type":"integer"},"duration":{"type":"integer"},"type":{"description":"The type of content that was recorded.","type":"string","enum":["conversation","voicemail","agent","consultation"]},"agents":{"type":"object","properties":{"channel_1":{"type":"array","items":{"type":"object","properties":{"participant_type":{"type":"string","enum":["AGENT","CONTACT","EXTERNAL_NUM"]},"participant_id":{"type":"string"}}}},"channel_2":{"type":"array","items":{"type":"object","properties":{"participant_type":{"type":"string","enum":["AGENT","CONTACT","EXTERNAL_NUM"]},"participant_id":{"type":"string"}}}}}},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","default":"http://api-docs.talkdesk.org/recordings/:id"}}},"media":{"type":"object","properties":{"href":{"type":"string","default":"http://api-docs.talkdesk.org/recordings/:id/media"}}}}}}},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","default":"http://api-docs.talkdesk.org/recordings/:id"}}},"media":{"type":"object","properties":{"href":{"type":"string","default":"http://api-docs.talkdesk.org/recordings/:id"}}}}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0011009","message":"Unauthorized"}}}},"404":{"description":"Recording not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0050000","message":"Recording not found"}}}}}}},"/recordings/{id}/media":{"get":{"description":"Redirect to the recording file, screen recording is not included","security":[{"GA":["recordings:read"]}],"parameters":[{"name":"id","in":"path","description":"The recording id","required":true,"schema":{"type":"string"}},{"name":"redacted","in":"query","description":"If this parameter omitted or redacted=true, the api will play/download the redacted recordings if available, otherwise it will play/download the original recordings.","required":false,"schema":{"type":"string"},"example":"false"}],"tags":["Recordings"],"responses":{"200":{"description":"A HAL Link for the recording file, when requested content type is application/json+hal","content":{"application/json":{"schema":{"example":{"_links":{"self":{"href":"http://api-docs.talkdesk.org/recordings/{recording_id}/media"},"file":{"href":"http://api-docs.talkdesk.org/interactions/{interaction_id}/recordings/{recording_id}/content?token=some.token.signed"}}},"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","default":"http://api-docs.talkdesk.org/recordings/:id/media"}}},"file":{"type":"object","properties":{"href":{"type":"string","default":"http://api-docs.talkdesk.org/interactions/:interaction_id/recordings/:recording_id/content?token=some.token.signed"}}}}}}}}}},"302":{"description":"Redirect to the recording file","headers":{"Location":{"description":"Recording location","schema":{"type":"string","default":"http://api-docs.talkdesk.org/interactions/:interaction_id/recordings/:recording_id/content?token=some.token.signed"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0011009","message":"Unauthorized"}}}},"403":{"description":"Forbidden access","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0050003","message":"Forbidden access"}}}},"404":{"description":"Recording not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0050000","message":"Recording not found"}}}},"410":{"description":"Recording's media file deleted","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0050006","message":"Recording's media file deleted"}}}}}}},"/reports/{type}/jobs":{"get":{"deprecated":true,"description":"Gets all jobs from a single report type","security":[{"GA":["reports:read"]}],"parameters":[{"name":"type","in":"path","description":"The report type id","required":true,"schema":{"type":"string","default":"calls","enum":["calls","user_status"]}}],"tags":["Reports"],"responses":{"200":{"description":"An array of jobs","content":{"application/json":{"schema":{"example":{"total":2,"page":1,"per_page":2,"_embdedded":{"jobs":[{"id":"dc5f5339-a45f-428e-8b31-0b79269da60b","name":"my report number 1","status":"canceled","timespan":{"from":"2010-01-01T22:13:12Z","to":"2016-05-01T22:13:12Z"},"_links":{"self":{"href":"http://api-docs.talkdesk.org/reports/calls/jobs/{job_id}"},"files":{"href":"http://api-docs.talkdesk.org/reports/calls/files/{job_id}"}}},{"id":"ab967ad7-15df-49e6-8680-f3f1aa6356e2","name":"my report number 2","status":"done","timespan":{"from":"2010-01-01T22:13:12Z","to":"2016-05-01T22:13:12Z"},"_links":{"self":{"href":"http://api-docs.talkdesk.org/reports/calls/jobs/{job_id}"},"files":{"href":"http://api-docs.talkdesk.org/reports/calls/files/{job_id}"}}}]},"_links":{"self":{"href":"http://api-docs.talkdesk.org/reports/:type/jobs"},"page":{"templated":true,"href":"http://api-docs.talkdesk.org/reports/:type/jobs"},"next":{"href":"http://api-docs.talkdesk.org/reports/:type/jobs?page=1"}}},"type":"object","properties":{"total":{"type":"integer"},"page":{"type":"integer"},"per_page":{"type":"integer"},"_embdedded":{"type":"object","properties":{"jobs":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"status":{"type":"string","enum":["created","processing","uploading","done","failed","canceled","deleted"]},"timespan":{"type":"object","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"}}}}}}}},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","default":"http://api-docs.talkdesk.org/reports/:type/jobs"}}},"page":{"type":"object","properties":{"templated":{"type":"boolean"},"href":{"type":"string","default":"http://api-docs.talkdesk.org/reports/:type/jobs"}}},"next":{"type":"object","properties":{"href":{"type":"string","default":"http://api-docs.talkdesk.org/reports/:type/jobs?page=2"}}}}}}}}}},"400":{"description":"Report type is invalid","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1000","message":"Invalid input parameters"}}}}}},"post":{"deprecated":true,"description":"Creates a new report job","security":[{"GA":["reports:write"]}],"parameters":[{"name":"type","in":"path","description":"The report type id","required":true,"schema":{"type":"string","default":"calls","enum":["calls","user_status"]}}],"tags":["Reports"],"responses":{"202":{"description":"Job accepted","content":{"application/json":{"schema":{"example":{"job":{"id":"c65186ee-3780-468e-968b-ca15b981c312","name":"my_report_number_1","status":"created","timespan":{"from":"2016-09-01T21:47:45.867Z","to":"2016-09-01T21:47:45.867Z"}},"_links":{"self":{"href":"http://api-docs.talkdesk.org/reports/:type/jobs/:id"},"files":{"href":"http://api-docs.talkdesk.org/reports/:type/jobs/:id"}}},"type":"object","properties":{"job":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"status":{"type":"string","enum":["created","processing","uploading","done","failed","canceled","deleted"]},"timespan":{"type":"object","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"}}}}},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","default":"http://api-docs.talkdesk.org/reports/:type/jobs/:id"}}},"report":{"type":"object","properties":{"href":{"type":"string","default":"http://api-docs.talkdesk.org/reports/:type/files/:id"}}}}}}}}}},"400":{"description":"Report type is invalid","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1000","message":"Invalid input parameters"}}}},"401":{"description":"Unauthorized"}},"requestBody":{"description":"The body of the request","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"format":{"type":"string","default":"json","enum":["json","csv","xls"]},"timespan":{"type":"object","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"}}}}}}}}}},"/reports/{type}/jobs/{id}":{"get":{"deprecated":true,"description":"Get job report execution details","security":[{"GA":["reports:read"]}],"parameters":[{"name":"type","in":"path","description":"The report type id","required":true,"schema":{"type":"string","default":"calls","enum":["calls","user_status"]}},{"name":"id","in":"path","description":"The job id","required":true,"schema":{"type":"string"}}],"tags":["Reports"],"responses":{"200":{"description":"Report job execution result","content":{"application/json":{"schema":{"example":{"job":{"id":"c65186ee-3780-468e-968b-ca15b981c312","name":"my_report_number_1","status":"created","timespan":{"from":"2016-09-01T21:47:45.867Z","to":"2016-09-01T21:47:45.867Z"}},"_links":{"self":{"href":"http://api-docs.talkdesk.org/reports/:type/jobs/:id"},"files":{"href":"http://api-docs.talkdesk.org/reports/:type/jobs/:id"}}},"type":"object","properties":{"job":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"status":{"type":"string","enum":["created","processing","uploading","done","failed","canceled","deleted"]},"timespan":{"type":"object","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"}}}}},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","default":"http://api-docs.talkdesk.org/reports/:type/jobs/:id"}}},"report":{"type":"object","properties":{"href":{"type":"string","default":"http://api-docs.talkdesk.org/reports/:type/files/:id"}}}}}}}}}},"303":{"description":"Report job execution result location","headers":{"Location":{"description":"The job results location","schema":{"type":"string","default":"/reports/{type}/files/{id}"}}},"content":{"application/json":{"schema":{"type":"string","example":"a string"}}}},"400":{"description":"Report type is invalid","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1000","message":"Invalid input parameters"}}}},"404":{"description":"Report job not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1004","message":"Report job not found."}}}}}},"delete":{"deprecated":true,"description":"Delete report job","security":[{"GA":["reports:write"]}],"parameters":[{"name":"type","in":"path","description":"The report type id","required":true,"schema":{"type":"string","default":"calls","enum":["calls","user_status"]}},{"name":"id","in":"path","description":"The job id","required":true,"schema":{"type":"string"}}],"tags":["Reports"],"responses":{"204":{"description":"Job deleted"},"400":{"description":"Report type is invalid","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1000","message":"Invalid input parameters"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Operation not allowed","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1003","message":"Operation not allowed given the current job status."}}}},"404":{"description":"Report job not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1004","message":"Report job not found."}}}}}}},"/reports/{type}/files/{id}":{"get":{"deprecated":true,"description":"Get job report execution result","security":[{"GA":["reports:read"]}],"parameters":[{"name":"type","in":"path","description":"The report type","required":true,"schema":{"type":"string","default":"calls","enum":["calls","user_status"]}},{"name":"id","in":"path","description":"The job id","required":true,"schema":{"type":"string"}}],"tags":["Reports"],"responses":{"302":{"description":"Report job execution result location with target format file containing entries information","headers":{"Location":{"description":"The job results location","schema":{"type":"string","default":"https://s3.amazonaws.com/td-sandbox-public-api-mock/calls.json"}}},"content":{"application/json":{"schema":{"type":"object","discriminator":{"propertyName":"grant_type"},"properties":{"total":{"type":"number"},"type":{"type":"string"}}}}}},"400":{"description":"Report type is invalid","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1000","message":"Invalid input parameters"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"The error message"}}}}}},"404":{"description":"Report file not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1004","message":"Report file not found"}}}}}},"delete":{"deprecated":true,"description":"Delete report file","security":[{"GA":["reports:write"]}],"parameters":[{"name":"type","in":"path","description":"The report type id","required":true,"schema":{"type":"string","default":"calls","enum":["calls","user_status"]}},{"name":"id","in":"path","description":"The job id","required":true,"schema":{"type":"string"}}],"tags":["Reports"],"responses":{"204":{"description":"File deleted"},"400":{"description":"Report type is invalid","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1000","message":"Invalid input parameters"}}}},"404":{"description":"Report job not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1004","message":"Report file not found"}}}}}}},"/live-subscriptions":{"post":{"description":"Subscribe for a new stream","security":[{"GA":["live-subscriptions:write"]}],"tags":["Live API"],"parameters":[],"responses":{"200":{"description":"Subscription information","content":{"application/json":{"schema":{"example":{"id":"5da2c01204ad4f3aa73ca77e6a2115df","_links":{"stream":{"href":"https://live-api.meza.talkdeskstg.com/subscriptions/5da2c0120\\ 4ad4f3aa73ca77e6a2115df/stream?token=eyJhbGciOiJIUzI1NiIsInR5c\\ CI6IkpXVCJ9.eyJhY2NvdW50X2lkIjoiNWMxMTMwMzYxMzk4NWEwMDA5MmY4Mj\\ A1IiwiZXhwIjoxNTU2ODExODkzLCJpYXQiOjE1NTY4MDgyOTMsInN1YnNjcmlw\\ dGlvbl9pZCI6IjVkYTJjMDEyMDRhZDRmM2FhNzNjYTc3ZTZhMjExNWRmIn0.wq\\ B6pdf-gONdhOcI5is1-GPf34V9-Ug1WkBePz_XEXQ"},"self":{"href":"https://api.talkdeskstg.com/live-subscriptions/5da2c01204ad4f3aa73ca77e6a2115df"}},"_embedded":{"entries":[{"params":{},"metadata":{},"query_id":"f28adffac5e14df4aac57c3465dcd69d","id":"d440035ea9724e6989298a37beb4759d","filters":{},"_links":{"self":{"href":"https://api.talkdeskstg.com/live-subscriptions/5da2c01204ad4f3aa73ca77e6a2115df/entries/d440035ea9724e6989298a37beb4759d"},"query":{"href":"https://api.talkdeskstg.com/live-queries/f28adffac5e14df4aac57c3465dcd69d"}}},{"params":{},"metadata":{},"query_id":"de821a5813cb44bab3a06e0fc8b68389","id":"ax311b6823db54bab3a06e0fc8b472958","filters":{},"_links":{"self":{"href":"https://api.talkdeskstg.com/live-subscriptions/5da2c01204ad4f3aa73ca77e6a2115df/entries/ax311b6823db54bab3a06e0fc8b472958"},"query":{"href":"https://api.talkdeskstg.com/live-queries/de821a5813cb44bab3a06e0fc8b68389"}}}]}},"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The subscription unique identifier."},"_links":{"type":"object","properties":{"stream":{"type":"object","properties":{"href":{"type":"string"}}},"self":{"type":"object","properties":{"href":{"type":"string"}}}}},"entries":{"type":"object","required":["id"],"description":"List of subscribed entries.","properties":{"params":{"type":"object","description":"Set of parameters for the queries. Each one may have a default value and, if applicable, a hard limit. If a parameter does not have a default, then it is mandatory."},"metadata":{"type":"object","description":"Metadata related with the use of the query on the client side."},"query_id":{"type":"string","description":"Query unique identifier."},"id":{"type":"string","description":"Subscription query unique identifier"},"filters":{"type":"object","description":"Set of filters for the query"},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string"}}},"query":{"type":"object","properties":{"href":{"type":"string"}}}}}}}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0700003","message":"Missing required header X-Forwarded-Host"}}}},"401":{"description":"Unauthorized access","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0700001","message":"Unauthorized: Invalid audience"}}}},"403":{"description":"Forbidden access","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0700002","message":"Missing scope"}}}},"415":{"description":"Unsupported media type","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0700016","message":"Unsupported Media Type Error"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0700004","message":"Invalid subscription queries"}}}}},"requestBody":{"description":"The body of the request","content":{"application/json":{"schema":{"type":"object","properties":{"queries":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Query unique identifier."},"metadata":{"type":"object","description":"An arbitrary JSON object returned to the client with the query result stream messages. For example, the client can supply an ID for each query when creating a subscription."},"params":{"type":"object","description":"List of query parameters. Each one may have a default value and, if applicable, a hard limit. If a parameter does not have a default, then it is mandatory."},"filters":{"type":"object","description":"Dictates the rules for identifying the subset of data to be used for calculation. Note that for filters like `range`, you have to set the type and value."}}}}}},"example":{"queries":[{"id":"7b8deafb74bf490288220fd3543b76af","metadata":{"name":"arrived_contacts"},"params":{},"filters":{"ring_groups":["agents"],"range":{"type":"interval","interval":86400}}}]}}}}}},"/live-subscriptions/{subscription_id}":{"get":{"description":"Get Subscription","security":[{"GA":["live-subscriptions:read"]}],"parameters":[{"in":"path","name":"subscription_id","description":"The Subscription Unique Identifier","required":true,"schema":{"type":"string"}}],"tags":["Live API"],"responses":{"200":{"description":"Subscription information","content":{"application/json":{"schema":{"example":{"id":"5da2c01204ad4f3aa73ca77e6a2115df","_links":{"stream":{"href":"https://live-api.meza.talkdeskstg.com/subscriptions/5da2c0120\\ 4ad4f3aa73ca77e6a2115df/stream?token=eyJhbGciOiJIUzI1NiIsInR5c\\ CI6IkpXVCJ9.eyJhY2NvdW50X2lkIjoiNWMxMTMwMzYxMzk4NWEwMDA5MmY4Mj\\ A1IiwiZXhwIjoxNTU2ODExODkzLCJpYXQiOjE1NTY4MDgyOTMsInN1YnNjcmlw\\ dGlvbl9pZCI6IjVkYTJjMDEyMDRhZDRmM2FhNzNjYTc3ZTZhMjExNWRmIn0.wq\\ B6pdf-gONdhOcI5is1-GPf34V9-Ug1WkBePz_XEXQ"},"self":{"href":"https://api.talkdeskstg.com/live-subscriptions/5da2c01204ad4f3aa73ca77e6a2115df"}},"_embedded":{"entries":[{"params":{},"metadata":{},"query_id":"f28adffac5e14df4aac57c3465dcd69d","id":"d440035ea9724e6989298a37beb4759d","filters":{},"_links":{"self":{"href":"https://api.talkdeskstg.com/live-subscriptions/5da2c01204ad4f3aa73ca77e6a2115df/entries/d440035ea9724e6989298a37beb4759d"},"query":{"href":"https://api.talkdeskstg.com/live-queries/f28adffac5e14df4aac57c3465dcd69d"}}},{"params":{},"metadata":{},"query_id":"de821a5813cb44bab3a06e0fc8b68389","id":"ax311b6823db54bab3a06e0fc8b472958","filters":{},"_links":{"self":{"href":"https://api.talkdeskstg.com/live-subscriptions/5da2c01204ad4f3aa73ca77e6a2115df/entries/ax311b6823db54bab3a06e0fc8b472958"},"query":{"href":"https://api.talkdeskstg.com/live-queries/de821a5813cb44bab3a06e0fc8b68389"}}}]}},"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The subscription unique identifier."},"_links":{"type":"object","properties":{"stream":{"type":"object","properties":{"href":{"type":"string"}}},"self":{"type":"object","properties":{"href":{"type":"string"}}}}},"entries":{"type":"object","required":["id"],"description":"List of subscribed entries.","properties":{"params":{"type":"object","description":"Set of parameters for the queries. Each one may have a default value and, if applicable, a hard limit. If a parameter does not have a default, then it is mandatory."},"metadata":{"type":"object","description":"Metadata related with the use of the query on the client side."},"query_id":{"type":"string","description":"Query unique identifier."},"id":{"type":"string","description":"Subscription query unique identifier"},"filters":{"type":"object","description":"Set of filters for the query"},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string"}}},"query":{"type":"object","properties":{"href":{"type":"string"}}}}}}}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0700003","message":"Missing required header X-Forwarded-Host"}}}},"401":{"description":"Unauthorized access","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0700001","message":"Unauthorized: Invalid audience"}}}},"403":{"description":"Forbidden access","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0700002","message":"Missing scope"}}}},"404":{"description":"Subscription Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0700005","message":"Subscription Not Found"}}}},"415":{"description":"Unsupported media type","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0700016","message":"Unsupported Media Type Error"}}}}}}},"/live-subscriptions/{subscription_id}/stream":{"get":{"description":"Connect to the subscription stream","security":[{"GA":["live-subscriptions:read"]}],"parameters":[{"in":"path","name":"subscription_id","description":"The Subscription Unique Identifier","required":true,"schema":{"type":"string"}},{"in":"query","name":"token","description":"The JWT required to connect to the stream - The token is provided when creating a new stream in the response body(_links > stream > href)","required":true,"schema":{"type":"string"}}],"tags":["Live API"],"responses":{"200":{"description":"Results from subscription","content":{"text/event-stream":{"schema":{"example":"event:result\ndata:{\"metadata\":{\"name\":\"today--abandoned_contacts\",\"timestamp\":\"2020-11-13T18:17:43.091587Z\"},\"result\":[{\"_value\":0}]}\n\nevent:result\ndata:{\"metadata\":{\"name\":\"today--abandon_rate\",\"timestamp\":\"2020-11-13T18:17:43.092158Z\"},\"result\":[{\"_value\":\"0.0000\"}]}\n\nevent:result\ndata:{\"metadata\":{\"name\":\"last15min--arrived_contacts\",\"timestamp\":\"2020-11-13T18:17:43.092308Z\"},\"result\":[{\"_value\":0}]}\n\nevent:result\ndata:{\"metadata\":{\"name\":\"inbound_contacts\",\"timestamp\":\"2020-11-13T18:17:43.092392Z\"},\"result\":[{\"_value\":1}]}\n\nevent:result\ndata:{\"metadata\":{\"name\":\"today--arrived_contacts\",\"timestamp\":\"2020-11-13T18:17:43.092647Z\"},\"result\":[{\"_value\":1}]}\n\nevent:result\ndata:{\"metadata\":{\"name\":\"live_contacts_list\",\"timestamp\":\"2020-11-13T18:17:43.092794Z\"},\"result\":[]}\n","type":"string","properties":{"event":{"type":"string","description":"Type of event"},"data":{"type":"object","description":"Results from a query in the subscription.","properties":{"metadata":{"type":"object","description":"Metadata related with the use of the query on the client side."},"result":{"type":"string","description":"A set of results from the query."}}}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0700003","message":"Missing required header X-Forwarded-Host"}}}},"401":{"description":"Unauthorized access","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0700001","message":"Unauthorized: Invalid audience"}}}},"403":{"description":"Forbidden access","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0700002","message":"Missing scope"}}}},"404":{"description":"Subscription Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0700005","message":"Subscription Not Found"}}}},"415":{"description":"Unsupported media type","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0700016","message":"Unsupported Media Type Error"}}}}}}},"/live-subscriptions/{subscription_id}/entries/{id}":{"put":{"description":"Update query from subscription","security":[{"GA":["live-subscriptions:write"]}],"parameters":[{"in":"path","name":"subscription_id","description":"The Subscription Unique Identifier","required":true,"schema":{"type":"string"}},{"in":"path","name":"id","description":"The Subscribed Query Unique Identifier","required":true,"schema":{"type":"string"}}],"tags":["Live API"],"responses":{"200":{"description":"Query from subscription","content":{"application/json":{"schema":{"example":{"id":"5da2c01204ad4f3aa73ca77e6a2115df","_links":{"query":{"href":"https://api.talkdeskstg.com/live/queries/de821a5813cb44bab3a06e0fc8b68389"},"self":{"href":"https://api.talkdeskstg.com/live/subscriptions/5da2c01204ad4f3aa73ca77e6a2115df/entries/d440035ea9724e6989298a37beb4759d"},"subscription":{"href":"https://api.talkdeskstg.com/subscriptions/5da2c01204ad4f3aa73ca77e6a2115df"}},"query_id":"ead2cf959ab44a6f9b48c97c672cb1ba","filters":{"range":{"type":"interval","interval":86400}},"metadata":{"name":"today--abandon_rate"},"params":{"order_by":"user_name","order_direction":"ASC"}},"type":"object","properties":{"id":{"type":"string","description":"Subscription entry unique identifier"},"_links":{"type":"object","properties":{"query":{"type":"object","properties":{"href":{"type":"string","description":"Query URL"}}},"self":{"type":"object","properties":{"href":{"type":"string","description":"Entry URL"}}},"subscription":{"type":"object","properties":{"href":{"type":"string","description":"Subscription URL"}}}}},"query_id":{"type":"string","description":"Query unique identifier."},"filters":{"type":"object","description":"Set of filters for the query"},"metadata":{"type":"object","description":"Metadata related with the use of the query on the client side."},"params":{"type":"object","description":"Set of parameters for the query"}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0700003","message":"Missing required header X-Forwarded-Host"}}}},"401":{"description":"Unauthorized access","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0700001","message":"Unauthorized: Invalid audience"}}}},"403":{"description":"Forbidden access","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0700002","message":"Missing scope"}}}},"404":{"description":"Forbidden access","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0700005","message":"Subscription Not Found"}}}},"415":{"description":"Unsupported media type","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0700016","message":"Unsupported Media Type Error"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0700010","message":"Invalid subscription query"}}}}},"requestBody":{"description":"The body of the request","content":{"application/json":{"schema":{"type":"object","properties":{"query_id":{"type":"string","description":"Query unique identifier."},"metadata":{"type":"object","description":"An arbitrary JSON object returned to the client with the query result stream messages. For example, the client can supply an ID for each query when creating a subscription."},"params":{"type":"object","description":"List of query parameters. Each one may have a default value and, if applicable, a hard limit. If a parameter does not have a default, then it is mandatory."},"filters":{"type":"object","description":"Dictates the rules for identifying the subset of data to be used for calculation."}}},"example":{"query_id":"ead2cf959ab44a6f9b48c97c672cb1ba","metadata":{"name":"today--abandon_rate"},"params":{"order_by":"user_name","order_direction":"ASC"},"filters":{"range":null,"type":"interval","interval":86400}}}}}}},"/live-queries":{"get":{"description":"List available queries","security":[{"GA":["live-queries:read"]}],"tags":["Live API"],"parameters":[{"name":"page","in":"query","description":"Requested page number.","required":false,"schema":{"type":"integer","default":1,"minimum":1}},{"name":"per_page","in":"query","description":"Number of elements per page.","required":false,"schema":{"type":"integer","default":50,"minimum":1,"maximum":50}}],"responses":{"200":{"description":"Available queries","content":{"application/json":{"schema":{"example":{"total":1,"per_page":2,"page":1,"count":2,"_links":{"self":{"href":"https://api.talkdeskstg.com/live-queries?page=1&per_page=2"}},"_embedded":{"queries":[{"params":[],"name":"total_arrived_contacts","id":"f28adffac5e14df4aac57c3465dcd69d","filters":[],"_links":{"self":{"href":"https://api.talkdeskstg.com/live-queries/f28adffac5e14df4aac57c3465dcd69d"}}},{"params":[{"name":"result_size","limit":1000,"default":1000}],"name":"abandon_rate_by_ring_group","id":"bfaca4e766464dfd90c7be2a1e83a50b","filters":[{"name":"ring_groups","json_map":true,"default":"null"},{"name":"range__from","default":"null"},{"name":"range__interval","default":"null"}],"_links":{"self":{"href":"https://api.talkdeskstg.com/live-queries/6fb2d1a9c3e54dac82de8322cf6028ea"}}}]}},"type":"object","properties":{"total":{"type":"integer"},"per_page":{"type":"integer"},"page":{"type":"integer"},"count":{"type":"integer"},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string"}}}}},"_embedded":{"type":"object","properties":{"queries":{"type":"object","required":["id","name","params"],"properties":{"params":{"type":"array","description":"List of query parameters. Each one may have a default value and, if applicable, a hard limit. If a parameter does not have a default, then it is mandatory."},"name":{"type":"string","description":"Query name."},"id":{"type":"string","description":"Query unique identifier."},"filters":{"type":"array","description":"Set of filters for the query","items":{"type":"object","properties":{"name":{"type":"string"},"json_map":{"type":"boolean"},"type":{"type":"string"},"default":{"type":"string"}}}},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string"}}}}}}}}}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0700003","message":"Missing required header X-Forwarded-Host"}}}},"401":{"description":"Unauthorized access","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0700001","message":"Unauthorized: Invalid audience"}}}},"403":{"description":"Forbidden access","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0700002","message":"Missing scope"}}}}}}},"/users":{"get":{"description":"Get list of Users","security":[{"GA":["users:read"]}],"parameters":[{"in":"query","name":"active","description":"Filter users by activation status","required":false,"schema":{"type":"boolean","x-filterable":true}},{"in":"query","name":"email","description":"Filter users with the given email","required":false,"schema":{"type":"string","x-filterable":true}},{"in":"query","name":"page","schema":{"type":"integer","default":1,"minimum":1}},{"in":"query","name":"per_page","schema":{"type":"integer","default":20,"minimum":1,"maximum":200}}],"tags":["Users"],"responses":{"200":{"description":"User List","content":{"application/json":{"schema":{"example":{"_embedded":{"users":[{"type":"object","properties":{"id":{"type":"string","description":"the Id of the user"},"email":{"type":"string","description":"the e-mail of the user"},"name":{"type":"string","description":"the name of the user"},"active":{"type":"boolean","description":"the activation state of the user"},"gender":{"type":"string","description":"the gender of the user"},"extension":{"type":"integer","description":"the phone extension for the user"},"external_phone_number":{"type":"string","description":"the external phone number for the user"},"created_at":{"type":"string","format":"date-time","description":"the date for the creation of the user"},"_links":{"type":"object","description":"the defined links","properties":{"self":{"type":"object","description":"the URI of the details of the user","properties":{"href":{"type":"string","default":"http://api-docs.talkdesk.org/users/:id"}}}}}}}]},"count":1,"total":2,"page":1,"per_page":1,"total_pages":2,"_links":{"self":{"href":"http://api-docs.talkdesk.org/users?page=1&per_page=20"},"next":{"href":"http://api-docs.talkdesk.org/users?page=2&per_page=20"},"first":{"href":"http://api-docs.talkdesk.org/users?page=1&per_page=20"},"last":{"href":"http://api-docs.talkdesk.org/users?page=2&per_page=20"},"show":{"templated":true,"href":"http://api-docs.talkdesk.org/users/{id}"},"index":{"templated":true,"href":"https://api-docs.talkdesk.org/users{?active,email,page,per_page}"}}},"type":"object","properties":{"count":{"type":"integer","description":"the number of results in the current page"},"total":{"type":"integer","description":"the total of results in the account"},"page":{"type":"integer","description":"the current page"},"per_page":{"type":"integer","description":"the number of results per page"},"total_pages":{"type":"integer","description":"the number of the total of result pages"},"_embedded":{"type":"object","properties":{"users":{"type":"array","description":"the results displayed in an array","items":{"type":"object","properties":{"id":{"type":"string","description":"the Id of the user"},"email":{"type":"string","description":"the e-mail of the user"},"name":{"type":"string","description":"the name of the user"},"active":{"type":"boolean","description":"the activation state of the user"},"gender":{"type":"string","description":"the gender of the user"},"extension":{"type":"integer","description":"the phone extension for the user"},"external_phone_number":{"type":"string","description":"the external phone number for the user"},"created_at":{"type":"string","format":"date-time","description":"the date for the creation of the user"},"_links":{"type":"object","description":"the defined links","properties":{"self":{"type":"object","description":"the URI of the details of the user","properties":{"href":{"type":"string","default":"http://api-docs.talkdesk.org/users/:id"}}}}}}}}}},"_links":{"type":"object","description":"the defined links","properties":{"self":{"type":"object","description":"the URI of the users list","properties":{"href":{"type":"string","description":"the URI value","default":"http://api-docs.talkdesk.org/users"}}},"next":{"type":"object","description":"the URI of the next page of the users list","properties":{"href":{"type":"string","description":"the URI value","default":"http://api-docs.talkdesk.org/users?page=2"}}},"first":{"type":"object","description":"the URI of the first page of the users list","properties":{"href":{"type":"string","description":"the URI value","default":"http://api-docs.talkdesk.org/users?page=1"}}},"last":{"type":"object","description":"the URI of the last page of the users list","properties":{"href":{"type":"string","description":"the URI value","default":"http://api-docs.talkdesk.org/users?page=2"}}},"show":{"type":"object","description":"the URI of a user details","properties":{"templated":{"type":"boolean","description":"the URI value","default":true},"href":{"type":"string","default":"http://api-docs.talkdesk.org/users/{id}"}}},"index":{"type":"object","description":"the URI of the users list with filters","properties":{"templated":{"type":"boolean","description":"the URI value","default":true},"href":{"type":"string","default":"https://api-docs.talkdesk.org/users{?active,email,page,per_page}"}}}}}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid Pagination":{"value":{"code":"0040001","message":"Bad request","description":"Invalid pagination parameters."}},"Invalid Query":{"value":{"code":"0040001","message":"Bad request","description":"Invalid query parameter types"}},"Invalid pagination size request":{"value":{"code":"0040021","message":"Pagination out of bounds"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0040002","message":"Unauthorized"}}}},"403":{"description":"Forbidden access","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Missing Scopes":{"value":{"code":"0040003","message":"Forbidden access"}},"Missing Policies":{"value":{"code":"0040018","message":"Forbidden"}}}}}}}}},"/users/{id}":{"get":{"description":"Get User Details","security":[{"GA":["users:read"]}],"parameters":[{"name":"id","in":"path","description":"The user id","required":true,"schema":{"type":"string"}}],"tags":["Users"],"responses":{"200":{"description":"User Details","content":{"application/json":{"schema":{"example":{"id":"5b34eb0cdcba1b000bdbd320","email":"paulo@talkdesk.com","name":"Paulo Omni","active":true,"gender":"Male","extension":null,"external_phone_number":"+351915555555","created_at":"2018-06-28T14:05:00Z","_links":{"self":{"href":"https://api-docs.talkdesk.org/users/{user_id}"}}},"type":"object","properties":{"id":{"type":"string","description":"the Id of the user"},"email":{"type":"string","description":"the e-mail of the user"},"name":{"type":"string","description":"the name of the user"},"active":{"type":"boolean","description":"the activation state of the user"},"gender":{"type":"string","description":"the gender of the user"},"extension":{"type":"integer","description":"the phone extension for the user"},"external_phone_number":{"type":"string","description":"the external phone number for the user"},"created_at":{"type":"string","format":"date-time","description":"the date for the creation of the user"},"_links":{"type":"object","description":"the defined links","properties":{"self":{"type":"object","description":"the URI of the details of the user","properties":{"href":{"type":"string","default":"http://api-docs.talkdesk.org/users/:id"}}}}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0040002","message":"Unauthorized"}}}},"403":{"description":"Forbidden access","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Missing Scopes":{"value":{"code":"0040003","message":"Forbidden access"}},"Missing Policies":{"value":{"code":"0040018","message":"Forbidden"}}}}}},"404":{"description":"User not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0040000","message":"User not found"}}}}}}},"/users/{user_id}/attributes":{"get":{"x-namespace":"/users","description":"Get the list of attributes of a user","security":[{"GA":["attributes:read"]}],"summary":"User attributes list","tags":["Attributes"],"operationId":"GetUserAttributes","parameters":[{"in":"path","name":"user_id","description":"The identifier of the user.","required":true,"schema":{"type":"string"}},{"in":"query","name":"page","description":"Desired page. Defaults to 1.","required":false,"schema":{"type":"integer","default":1,"minimum":1,"maximum":10000000}},{"in":"query","name":"per_page","description":"Limit the number of attributes per page. Defaults to 50.","required":false,"schema":{"type":"integer","default":50,"minimum":1,"maximum":100}}],"responses":{"200":{"description":"User attributes list","content":{"application/json":{"schema":{"example":{"total":2,"count":1,"page":1,"per_page":1,"_embedded":{"attributes":[{"id":"123e4567-e89b-12d3-a456-426655440000","name":"Attribute 1","active":true,"proficiency":"five_stars_scale","user_proficiency":60,"_links":{"self":{"href":"http://api-docs.talkdesk.org/attributes/123e4567-e89b-12d3-a456-426655440000"},"attributes":{"href":"http://api-docs.talkdesk.org/attributes"}}}]},"_links":{"self":{"href":"http://api-docs.talkdesk.org/users/:id/attributes"},"page":{"href":"http://api-docs.talkdesk.org/users/:id/attributes?page=1"},"next":{"href":"http://api-docs.talkdesk.org/users/:id/attributes?page=2"}}},"type":"object","properties":{"total":{"type":"integer"},"count":{"type":"integer"},"page":{"type":"integer"},"per_page":{"type":"integer"},"_embedded":{"type":"object","description":"The list of attributes","properties":{"attributes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The id of the attribute"},"name":{"type":"string","description":"The name of the attribute"},"active":{"type":"boolean","description":"Whether the attribute is active or inactive"},"proficiency":{"type":"string","description":"The type of proficiency","enum":["five_stars_scale","none"]},"user_proficiency":{"type":"integer","description":"The default value of the proficiency","minimum":0,"maximum":100},"_links":{"type":"object","description":"HAL API related links.","properties":{"self":{"type":"object","description":"Link to fetch the detail of the attribute","properties":{"href":{"type":"string","description":"Address of the resource","default":"http://api-docs.talkdesk.org/attributes/:id"}}},"attributes":{"type":"object","description":"Link to fetch the list of all attributes","properties":{"href":{"type":"string","description":"Address of the resource","default":"http://api-docs.talkdesk.org/attributes"}}}},"required":["self","attributes"]}},"required":["id","name","active","user_proficiency","default_proficiency","_links"]}}},"required":["attributes"]},"_links":{"type":"object","description":"HAL API related links.","properties":{"self":{"type":"object","description":"Link to fetch a list of all the attributes","properties":{"href":{"type":"string","description":"Address of the resource","default":"http://api-docs.talkdesk.org/users/:id/attributes"}}},"page":{"type":"object","properties":{"templated":{"type":"boolean"},"href":{"type":"string"}}},"next":{"type":"object","properties":{"templated":{"type":"boolean"},"href":{"type":"string"}}}}}},"required":["_embedded","_links"]}}}},"400":{"description":"Invalid parameter values submitted.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0360002","message":"Bad request."}}}},"401":{"description":"Missing or invalid 'Authorization' header.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0360000","message":"Missing or invalid 'Authorization' header."}}}},"403":{"description":"Insufficient permissions.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0360003","message":"Forbidden."}}}},"404":{"description":"Attribute Not Found.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0360004","message":"Not found."}}}}}}},"/users/{id}/presence":{"get":{"description":"Get user presence.","security":[{"Deprecated":["presence-user:read"]}],"parameters":[{"name":"id","in":"path","description":"The user id","required":true,"schema":{}}],"tags":["Presence"],"responses":{"200":{"description":"User Presence","content":{"application/json":{"schema":{"example":{"id":"9610b0c6-cad0-4dc5-9c08-95249e8d9c1e","account_id":"5a4f5c04522953000bccca75","user_id":"59df62c81507b35a7cf2bbd3","status":"away","custom_status":"Custom","custom_status_id":"away_custom","occupancy":100,"channels":[{"name":"voice","occupancy":100,"devices":["some_id_1","some_id_2"]}],"devices":[{"id":"some_id_1"},{"id":"some_id_2"}],"interactions":[{"id":"59df62c81507b35a7cf2bbd4","device_id":"some_id_1","channel_name":"voice","cost":100}],"updated_by":"some_client_id","updated_at":"2018-02-28T15:08:54:02Z","_links":{"self":{"href":"https://api.talkdeskstg.com/users/{id}/presence"}}},"type":"object","required":["id","account_id","user_id","status","custom_status_id","custom_status","occupancy","channels","devices","interactions","updated_by","updated_at"],"properties":{"id":{"type":"string","format":"uuidv4","description":"a unique ID for the event"},"account_id":{"type":"string","description":"the ID of the account"},"user_id":{"type":"string","description":"the ID of the user"},"status":{"type":"string","description":"The user current status","enum":["available","away","offline","hidden"]},"custom_status":{"type":"string","description":"The user current custom status"},"custom_status_id":{"type":"string","description":"The user current custom status id"},"occupancy":{"type":"integer","description":"The user occupancy level"},"channels":{"type":"array","items":{"type":"object","description":"The channel details","required":["name","devices","occupancy"],"properties":{"name":{"type":"string","description":"The name of the channel"},"devices":{"type":"array","description":"The list of device IDs belonging to the channel","items":{"type":"string"}},"occupancy":{"type":"integer","description":"The channel occupancy level"}}}},"devices":{"type":"array","description":"The list of devices available","items":{"type":"object","description":"The device detail","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the device"}}}},"interactions":{"type":"array","description":"The list of ongoing interactions","items":{"type":"object","description":"The interation detail","required":["id","channel_name","cost"],"properties":{"id":{"type":"string","description":"the ID of the interaction"},"channel_name":{"type":"string","description":"The name of the channel"},"device_id":{"type":"string","description":"The ID of the device"},"cost":{"type":"integer","description":"The cost of the interaction"}}}},"updated_by":{"type":"string"},"updated_at":{"type":"string","format":"date-time","description":"The time the last status was updated"},"_links":{"type":"object","description":"the defined links","properties":{"self":{"type":"object","description":"the URI of the main resource being exposed","properties":{"href":{"type":"string","description":"the URI value"}}}}}}}}}},"403":{"description":"Forbidden access","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0230008","message":"Forbidden","description":"X-Request-Scopes header does not contain the required scopes for the requested operation"}}}},"404":{"description":"User not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0230005","message":"User not found","description":"The specified user id doesn't exist"}}}},"406":{"description":"Accept format mime type not supported","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0230020","message":"Accept MIME type not supported","description":"The accept MIME type in the request header is not supported"}}}}}},"post":{"description":"Subscribe to user presence","security":[{"Deprecated":["presence-user:read"]}],"parameters":[{"name":"id","in":"path","description":"The user id","required":true,"schema":{}}],"tags":["Presence"],"responses":{"200":{"description":"Connection details","content":{"application/json":{"schema":{"example":{"url":"wss://some.broker.com:8084","password":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyDzY2NvdW50X2lkIjoi\\ NWE0ZjVjMDQ1MjI5NTMwMDBiY2NjYTg1IiwiYXVkIjoiUHJlc2VuY2UtTVFUVCIsIm\\ NsaWVudF9pZCI6IjVhNGY1YzA0NTIyOTUzMDAwYmNjY2E4NS01YTRmNWMwZTUyMjk1\\ MzAwMGJjY2NhOGEtZjBhYjMzM2UtN2M5OC00NDYxLTg4NTAtNTQ4YTc5ODJhNTU4Ii\\ wiZXhwIjoxNTIwOTUwNTE0LCJpYXQiOjE1MjA5NTAyMTQsImlzcyI6Imh0dHBzOi8v\\ YXBpLnRhbGtkZXNrLm9yZy9wcmVzZW5jZSIsInN1YiI6IjVhNGY1YzBlNTIyOTUzMD\\ AwYmNjY2E4YSJ9.9kNMQMoRgN89yzedKAPPgIj4_F4j60TUX-u-g228wXY","username":"5a4f5c04522953000bccca75","client_id":"5a4f5c04522953000bccca75-5a4f5c0e522953000bddda8a-OJ+huaZeRl9GVZupIZ2mTRAJuPN8WKvs","topic":"v1/5a4f5c04522953000bccca75/5a4f5c0e522953000bddda8a"},"type":"object","required":["url","password","username","client_id","topic"],"properties":{"url":{"type":"string","description":"The url for the broker"},"password":{"type":"string","description":"The password to access the broker"},"username":{"type":"string","description":"The username to access the broker"},"client_id":{"type":"string","description":"The client identification to the broker"},"topic":{"type":"string","description":"The topic to subscribe"}}}}}},"403":{"description":"Forbidden access","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0230008","message":"Forbidden","description":"X-Request-Scopes header does not contain the required scopes for the requested operation"}}}},"404":{"description":"User not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0230005","message":"User not found","description":"The specified user id doesn't exist"}}}}}}},"/users/{id}/presence/status":{"put":{"description":"Update user presence status","security":[{"Deprecated":["presence-status:write"]}],"parameters":[{"name":"id","in":"path","description":"The user id","required":true,"schema":{}}],"requestBody":{"description":"The body of the request","content":{"application/json":{"schema":{"properties":{"status":{"type":"string","description":"the status to set for the user"},"custom_status_id":{"type":"string","description":"the custom status id to set for the user"}}}}}},"tags":["Presence"],"responses":{"204":{"description":"No content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid Status":{"value":{"code":"0230011","message":"Invalid status"}},"Malformed JSON Payload":{"value":{"code":"0230024","message":"Malformed JSON payload","description":"The payload is malformed"}}}}}},"403":{"description":"Forbidden access","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0230008","message":"Forbidden","description":"X-Request-Scopes header does not contain the required scopes for the requested operation"}}}},"404":{"description":"User not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0230005","message":"User not found","description":"The specified user id doesn't exist"}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0230025","message":"Invalid Content-Type Header","description":"Content-Type Header is invalid or not present"}}}}}}},"/users/{id}/presence/occupancy":{"patch":{"description":"Change user occupancy","security":[{"Deprecated":["presence-occupancy:write"]}],"parameters":[{"name":"id","in":"path","description":"The user id","required":true,"schema":{}}],"requestBody":{"description":"The json patch to update the occupancy.","required":true,"content":{"application/json":{"schema":{"example":[{"op":"add","path":"interactions/-","value":[{"id":"some_busy_state","channel_name":"custom_busy","cost":100}]},{"op":"test","path":"/interactions/0/id","value":"d290f1ee-6c54-4b01-90e6-d701748f0851"},{"op":"remove","path":"/interactions/0"}],"type":"array","items":{"type":"object","required":["op","path"],"properties":{"op":{"type":"string","description":"The operation to be made","enum":["add","remove","test"],"example":"test"},"path":{"type":"string","description":"The path of the JSON document","example":"/interactions/0/id"},"value":{"type":"string","description":"The value to be changed","example":"d290f1ee-6c54-4b01-90e6-d701748f0851"}}}}}}},"tags":["Presence"],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Example 0":{"value":{"code":"0230015","message":"Invalid Operation","description":"The operation to be applied in the patch is invalid"}},"Example 1":{"value":{"code":"0230011","message":"Invalid status"}},"Example 2":{"value":{"code":"0230026","message":"Invalid payload schema","description":"The request payload schema is invalid according to the defined schema.","fields":[{"name":"#/0/op","description":"Value is not allowed in enum."},{"name":"#/0","description":"Required property path was not present."}]}}}}}},"403":{"description":"Forbidden access","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Example 0":{"value":{"code":"0230008","message":"Forbidden","description":"X-Request-Scopes header does not contain the required scopes for the requested operation"}},"Example 1":{"value":{"code":"0230017","message":"Forbidden","description":"The patch operation is forbidden"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Example 0":{"value":{"code":"0230005","message":"User not found","description":"The specified user id doesn't exist"}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Example 0":{"value":{"code":"0230016","message":"Invalid Format","description":"The format of the patch operation is invalid"}},"Example 1":{"value":{"code":"0230018","message":"Invalid custom busy cost","description":"The custom busy cost is invalid"}},"Example 2":{"value":{"code":"0230019","message":"Invalid occupancy limit","description":"The occupancy has reached the limit"}}}}}}}}},"/users/{user_id}/integrations/{integration_name}":{"post":{"summary":"Set external_id of user from integration","x-namespace":"/users","description":"Post request to set external_id of user from integration","security":[{"GA":["users:write"]}],"parameters":[{"name":"user_id","in":"path","description":"The user id","required":true,"schema":{"type":"string","minLength":1,"maxLength":255}},{"name":"integration_name","in":"path","description":"The name of the integration","required":true,"schema":{"type":"string","minLength":1,"maxLength":255}}],"tags":["Users"],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0550005","message":"A bad request was given"}}}},"404":{"description":"Resource Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Example 0":{"value":{"code":"0550007","message":"Integration not found"}},"Example 1":{"value":{"code":"0550013","message":"Agent not found"}},"Example 2":{"value":{"code":"0550010","message":"Account not found"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0550000","message":"Internal server error"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["external_id"],"properties":{"external_id":{"type":"string","description":"External id of the user","minLength":1,"maxLength":255}}},"example":{"external_id":"123456789"}}}}}},"/users/me":{"get":{"description":"User info endpoint as per the OpenId Connect spec","security":[{"GA":["openid"]}],"tags":["Users"],"responses":{"200":{"description":"The default success response","content":{"application/json":{"schema":{"example":{"properties":{"sub":"1","id":"40f684c2-99ff-4ece-a613-9dd10dbe1662","name":"John Smith","email":"john.smith@example.com","_links":{"self":{"href":"http://api-docs.talkdesk.org/users/{user_id}"}}}},"type":"object","required":["sub","name","email"],"properties":{"id":{"type":"string","description":"The id of the user"},"sub":{"type":"string","description":"The subject of the token"},"name":{"type":"string","description":"The name of the user"},"email":{"type":"string","description":"The email of the user"},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"default":"http://api-docs.talkdesk.org/users/{id}"}}}}}}}}}},"400":{"description":"No User Context","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0040001","message":"Bad request"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0070010","message":"Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0070011","message":"Invalid scopes"}}}}}}},"/users/{email}/recordings/pause":{"post":{"description":"Pause a recording given a contact person's email from an ongoing interaction.","security":[{"Deprecated":["interactions:control-recordings"]}],"parameters":[{"name":"email","in":"path","description":"The email of the contact person","required":true,"schema":{"type":"string"}}],"tags":["Users"],"responses":{"204":{"description":"Pause successful, no content"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"code":{"type":"string"},"message":{"type":"string"}}},"example":{"code":"0350001","message":"Unauthorized"}}}},"403":{"description":"Forbidden access","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"code":{"type":"string"},"message":{"type":"string"}}},"example":{"code":"0350002","message":"Forbidden"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"code":{"type":"string"},"message":{"type":"string"}}},"examples":{"Example 0":{"value":{"code":"0350003","message":"User not found"}},"Example 1":{"value":{"code":"0350004","message":"Voice interaction not found"}}}}}},"409":{"description":"Unsupported action","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"code":{"type":"string"},"message":{"type":"string"}}},"example":{"code":"0350005","message":"Action not allowed on voice interaction"}}}}}}},"/users/{email}/recordings/start":{"post":{"description":"Start a recording given a contact person's email from an ongoing interaction.","security":[{"Deprecated":["interactions:control-recordings"]}],"parameters":[{"name":"email","in":"path","description":"The email of the contact person","required":true,"schema":{"type":"string"}}],"tags":["Users"],"responses":{"204":{"description":"Pause successful, no content"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"code":{"type":"string"},"message":{"type":"string"}}},"example":{"code":"0350001","message":"Unauthorized"}}}},"403":{"description":"Forbidden access","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"code":{"type":"string"},"message":{"type":"string"}}},"example":{"code":"0350002","message":"Forbidden"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"code":{"type":"string"},"message":{"type":"string"}}},"examples":{"Example 0":{"value":{"code":"0350003","message":"User not found"}},"Example 1":{"value":{"code":"0350004","message":"Voice interaction not found"}}}}}},"409":{"description":"Unsupported action","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"code":{"type":"string"},"message":{"type":"string"}}},"example":{"code":"0350005","message":"Action not allowed on voice interaction"}}}}}}},"/users/{id}/disposition/settings":{"patch":{"description":"Update user dispositions settings for the user","x-namespace":"/users","security":[{"EarlyAccess":["user-disposition-settings:write"]}],"parameters":[{"name":"id","in":"path","description":"The user id","required":true,"schema":{"type":"string","minLength":1,"maxLength":255}}],"requestBody":{"description":"The body of the request","content":{"application/json":{"schema":{"type":"object","properties":{"active":{"description":"The activation state of the after call work settings","type":"boolean"},"inbound_enabled":{"description":"Indicates if the user has the disposition enabled for inbound calls","type":"boolean"},"outbound_enabled":{"description":"Indicates if the user has the disposition enabled for outbound calls","type":"boolean"},"timeout":{"description":"Indicates how long in seconds the disposition screen will be shown without human interaction (can also be null)","type":"number","minimum":1,"maximum":3600},"internal_transfer":{"description":"The enablement of after call work after an internal transfer","type":"boolean"},"finish_occupancy_after_wrap_up":{"description":"Determines whether the user will terminate his occupancy as soon as the wrap-up form is submitted or dismissed"}}},"example":{"active":true,"inbound_enabled":false,"outbound_enabled":true,"timeout":60,"internal_transfer":false,"finish_occupancy_after_wrap_up":false}}}},"tags":["Users"],"responses":{"204":{"description":"Dispositions settings successfully updated"},"400":{"description":"Invalid request data","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid request body":{"value":{"code":"2880102","message":"Invalid request data"}},"Invalid parameter type":{"value":{"code":"2880102","message":"Invalid request data","fields":[{"name":"active","description":"Invalid field type. Expected: bool"},{"name":"timeout","description":"Invalid field type. Expected: number"}]}},"Timeout value not in allowlist":{"value":{"code":"2880102","message":"Invalid request data","fields":[{"name":"timeout","description":"The specified value is not in the allowlist"}]}},"Timeout value not in range":{"value":{"code":"2880102","message":"Invalid request data","fields":[{"name":"timeout"}],"description":"The specified value is not within the accepted range (1-3600 seconds)"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2880003","message":"Unauthorized"}}}},"403":{"description":"Forbidden access","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2880004","message":"Forbidden"}}}},"404":{"description":"Resource Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Example 0":{"value":{"code":"2880005","message":"Not Found"}},"Example 1":{"value":{"code":"2880101","message":"Agent not found"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Example 0":{"value":{"code":"2880001","message":"An unexpected error occurred."}},"Example 1":{"value":{"code":"2880103","message":"An unexpected error has occurred. Contact Talkdesk Support."}}}}}}}}},"/scim/v2/Users":{"get":{"description":"Queries multiple user identities in authenticate account. Filtering is available.","operationId":"getUsers","security":[{"GA":["scim"]}],"parameters":[{"in":"query","name":"filter","schema":{"type":"string","minLength":1,"example":"https://api.talkdeskapp.com/scim/v2/Users?filter=username eq \"email@domain.com\"&sortBy=name&sortOrder=ASCENDING"},"description":"Filter records based on username, name, externalId and active status. Check http://www.simplecloud.info/ for full capability."},{"in":"query","name":"sortBy","schema":{"type":"string","minLength":1,"example":"https://api.talkdeskapp.com/scim/v2/Users?sortBy=id"},"description":"Sort records based on username, name, id, active, createdat and externalid (case-insensitive). Check http://www.simplecloud.info/ for full capability."},{"in":"query","name":"sortOrder","schema":{"type":"string","minLength":9,"maxLength":10,"enum":["ASCENDING","DESCENDING"],"default":"ASCENDING","example":"https://api.talkdeskapp.com/scim/v2/Users?sortBy=name&sortOrder=DESCENDING"},"description":"Sort records based on the sortBy query parameter, \"ASCENDING\" or \"DESCENDING\"(case-insensitive). \"ASCENDING\" by default."},{"in":"query","name":"startIndex","schema":{"type":"integer","minimum":1,"maximum":2147483647,"default":1},"description":"Paginates result starting an 1-based index. 1 by default or if negative."},{"in":"query","name":"count","schema":{"type":"integer","minimum":1,"maximum":200,"default":20},"description":"Max of elements in the pagination. 20 by default or if negative. Limit 200."}],"responses":{"200":{"description":"The request has succeeded.","content":{"application/json":{"schema":{"description":"Collection of users","type":"object","properties":{"schemas":{"description":"URN Schema for ListResponse","type":"array","items":{"type":"string","minLength":50,"maxLength":50,"enum":["urn:ietf:params:scim:api:messages:2.0:ListResponse"]}},"Resources":{"description":"The list of users","items":{"description":"User entity","type":"object","properties":{"schemas":{"description":"URN schemas for User resource.","type":"array","items":{"type":"string","description":"","minLength":42,"maxLength":56,"enum":["urn:ietf:params:scim:schemas:core:2.0:User"]}},"id":{"description":"The ID for the object. Immutable.","type":"string","minLength":24,"maxLength":24},"active":{"description":"The user's administrative status.","type":"boolean"},"externalId":{"description":"The external id for the user.","type":"string","minLength":1},"meta":{"description":"User metadata","type":"object","properties":{"created":{"description":"Date and time the resource was created","format":"date-time","type":"string"},"lastModified":{"description":"Date and time the resource was last modified","format":"date-time","type":"string"},"resourceType":{"description":"The resource Type","type":"string"},"location":{"description":"The location (URI) of the resource","type":"string"},"version":{"description":"The version of the resource","type":"string"}}},"name":{"description":"The components of the user's real name","type":"object","properties":{"familyName":{"description":"The family name of the User, or Last Name in most Western languages (for example, Jensen given the full name Ms. Barbara J Jensen, III.)","type":"string","minLength":1},"givenName":{"description":"The given name of the User, or First Name in most Western languages.","type":"string","minLength":1}},"required":["familyName","givenName"]},"userName":{"description":"The user's email.","type":"string","minLength":6}},"required":["id","name","userName"]},"type":"array"},"totalResults":{"description":"The number of users in the collection","type":"integer","minimum":0},"startIndex":{"description":"The 1-based index of the first result in the current set of list results","type":"integer","minimum":1},"itemsPerPage":{"description":"The number of resources returned in a list response page","type":"integer","minimum":1,"maximum":200}},"required":["schemas","Resources","totalResults","startIndex","itemsPerPage"]},"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:ListResponse"],"Resources":[{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User"],"id":"5de931b9f9e4c60001140b38","meta":{"resourceType":"User","created":"2019-12-05T16:35:05.451Z","lastModified":"2022-10-20T17:50:38.930Z","location":"/Users/5de931b9f9e4c60001140b38"},"userName":"john.doe@email.com","active":true,"name":{"familyName":"Doe","givenName":"John"},"valid":true}],"totalResults":105,"startIndex":1,"itemsPerPage":20}},"application/scim+json":{"schema":{"description":"Collection of users","type":"object","properties":{"schemas":{"description":"URN Schema for ListResponse","type":"array","items":{"type":"string","minLength":50,"maxLength":50,"enum":["urn:ietf:params:scim:api:messages:2.0:ListResponse"]}},"Resources":{"description":"The list of users","items":{"description":"User entity","type":"object","properties":{"schemas":{"description":"URN schemas for User resource.","type":"array","items":{"type":"string","description":"","minLength":42,"maxLength":56,"enum":["urn:ietf:params:scim:schemas:core:2.0:User"]}},"id":{"description":"The ID for the object. Immutable.","type":"string","minLength":24,"maxLength":24},"active":{"description":"The user's administrative status.","type":"boolean"},"externalId":{"description":"The external id for the user.","type":"string","minLength":1},"meta":{"description":"User metadata","type":"object","properties":{"created":{"description":"Date and time the resource was created","format":"date-time","type":"string"},"lastModified":{"description":"Date and time the resource was last modified","format":"date-time","type":"string"},"resourceType":{"description":"The resource Type","type":"string"},"location":{"description":"The location (URI) of the resource","type":"string"},"version":{"description":"The version of the resource","type":"string"}}},"name":{"description":"The components of the user's real name","type":"object","properties":{"familyName":{"description":"The family name of the User, or Last Name in most Western languages (for example, Jensen given the full name Ms. Barbara J Jensen, III.)","type":"string","minLength":1},"givenName":{"description":"The given name of the User, or First Name in most Western languages.","type":"string","minLength":1}},"required":["familyName","givenName"]},"userName":{"description":"The user's email.","type":"string","minLength":6}},"required":["id","name","userName"]},"type":"array"},"totalResults":{"description":"The number of users in the collection","type":"integer","minimum":0},"startIndex":{"description":"The 1-based index of the first result in the current set of list results","type":"integer","minimum":1},"itemsPerPage":{"description":"The number of resources returned in a list response page","type":"integer","minimum":1,"maximum":200}},"required":["schemas","Resources","totalResults","startIndex","itemsPerPage"]},"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:ListResponse"],"Resources":[{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User"],"id":"5de931b9f9e4c60001140b38","meta":{"resourceType":"User","created":"2019-12-05T16:35:05.451Z","lastModified":"2022-10-20T17:50:38.930Z","location":"/Users/5de931b9f9e4c60001140b38"},"userName":"john.doe@email.com","active":true,"name":{"familyName":"Doe","givenName":"John"},"valid":true}],"totalResults":105,"startIndex":1,"itemsPerPage":20}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"SCIM-related error","type":"object","properties":{"schemas":{"description":"URN Schema for Errors","type":"array","items":{"type":"string","minLength":43,"maxLength":43,"enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"status":{"description":"Http Status Code","type":"string","minLength":3,"maxLength":3},"detail":{"description":"Message detailing the error","type":"string","minLength":1},"scimType":{"description":"Type of SCIM error","type":"string","minLength":1}},"required":["schemas","status","detail"]},"examples":{"InvalidFilter":{"value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"status":"400","detail":"Bad Request","scimType":"invalidFilter"}}}}}},"401":{"description":"Missing or invalid Authorization","content":{"application/json":{"schema":{"description":"SCIM-related error","type":"object","properties":{"schemas":{"description":"URN Schema for Errors","type":"array","items":{"type":"string","minLength":43,"maxLength":43,"enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"status":{"description":"Http Status Code","type":"string","minLength":3,"maxLength":3},"detail":{"description":"Message detailing the error","type":"string","minLength":1},"scimType":{"description":"Type of SCIM error","type":"string","minLength":1}},"required":["schemas","status","detail"]},"examples":{"Example":{"value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"status":"401","detail":"Unauthorized"}}}}}},"403":{"description":"Forbidden operation","content":{"application/json":{"schema":{"description":"SCIM-related error","type":"object","properties":{"schemas":{"description":"URN Schema for Errors","type":"array","items":{"type":"string","minLength":43,"maxLength":43,"enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"status":{"description":"Http Status Code","type":"string","minLength":3,"maxLength":3},"detail":{"description":"Message detailing the error","type":"string","minLength":1},"scimType":{"description":"Type of SCIM error","type":"string","minLength":1}},"required":["schemas","status","detail"]},"examples":{"Example":{"value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"status":"403","detail":"Forbidden"}}}}}},"406":{"description":"Invalid Accept header","content":{"application/json":{"schema":{"description":"SCIM-related error","type":"object","properties":{"schemas":{"description":"URN Schema for Errors","type":"array","items":{"type":"string","minLength":43,"maxLength":43,"enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"status":{"description":"Http Status Code","type":"string","minLength":3,"maxLength":3},"detail":{"description":"Message detailing the error","type":"string","minLength":1},"scimType":{"description":"Type of SCIM error","type":"string","minLength":1}},"required":["schemas","status","detail"]},"examples":{"Example":{"value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"status":"406","detail":"Not Acceptable"}}}}}}},"summary":"Get Users","tags":["SCIM"]},"post":{"description":"Creates new user in authenticated account","operationId":"createUsers","security":[{"GA":["scim"]}],"requestBody":{"description":"The details of the user to create","required":true,"content":{"application/json":{"schema":{"description":"Create/update user","type":"object","properties":{"schemas":{"description":"URN schemas for User resource.","type":"array","items":{"type":"string","description":"The 'urn:ietf:params:scim:schemas:extension:talkdesk:2.0:User' is only required if the user has custom attributes.","minLength":42,"maxLength":56,"enum":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:talkdesk:2.0:User"]}},"name":{"description":"The components of the user's real name","type":"object","properties":{"familyName":{"description":"The family name of the User, or Last Name in most Western languages (for example, Jensen given the full name Ms. Barbara J Jensen, III.)","type":"string","minLength":1},"givenName":{"description":"The given name of the User, or First Name in most Western languages.","type":"string","minLength":1}},"required":["familyName","givenName"]},"externalId":{"description":"The user's external identifier","type":"string","minLength":1},"userName":{"description":"The user's email","type":"string","minLength":1},"active":{"description":"The user's administrative status.","type":"boolean"},"urn:ietf:params:scim:schemas:extension:talkdesk:2.0:User":{"description":"The user's custom attributes.","type":"object","properties":{"rolesString":{"description":"A list of roles for the user that collectively represent who the user is separated by semicolons, e.g., 'Student;Faculty'.","type":"string","minLength":1},"teamsString":{"description":"The user's team list separated by semicolons.","type":"string","minLength":1}}}},"required":["name","userName","active"]}},"application/scim+json":{"schema":{"description":"Create/update user","type":"object","properties":{"schemas":{"description":"URN schemas for User resource.","type":"array","items":{"type":"string","description":"The 'urn:ietf:params:scim:schemas:extension:talkdesk:2.0:User' is only required if the user has custom attributes.","minLength":42,"maxLength":56,"enum":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:talkdesk:2.0:User"]}},"name":{"description":"The components of the user's real name","type":"object","properties":{"familyName":{"description":"The family name of the User, or Last Name in most Western languages (for example, Jensen given the full name Ms. Barbara J Jensen, III.)","type":"string","minLength":1},"givenName":{"description":"The given name of the User, or First Name in most Western languages.","type":"string","minLength":1}},"required":["familyName","givenName"]},"externalId":{"description":"The user's external identifier","type":"string","minLength":1},"userName":{"description":"The user's email","type":"string","minLength":1},"active":{"description":"The user's administrative status.","type":"boolean"},"urn:ietf:params:scim:schemas:extension:talkdesk:2.0:User":{"description":"The user's custom attributes.","type":"object","properties":{"rolesString":{"description":"A list of roles for the user that collectively represent who the user is separated by semicolons, e.g., 'Student;Faculty'.","type":"string","minLength":1},"teamsString":{"description":"The user's team list separated by semicolons.","type":"string","minLength":1}}}},"required":["name","userName","active"]}}}},"responses":{"201":{"description":"User response","content":{"application/json":{"schema":{"description":"User entity","type":"object","properties":{"schemas":{"description":"URN schemas for User resource.","type":"array","items":{"type":"string","description":"The 'urn:ietf:params:scim:schemas:extension:talkdesk:2.0:User' is only required if the user has custom attributes.","minLength":42,"maxLength":56,"enum":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:talkdesk:2.0:User"]}},"id":{"description":"The ID for the object. Immutable.","type":"string","minLength":24,"maxLength":24},"active":{"description":"The user's administrative status.","type":"boolean"},"externalId":{"description":"The external id for the user.","type":"string","minLength":1},"meta":{"description":"User metadata","type":"object","properties":{"created":{"description":"Date and time the resource was created","format":"date-time","type":"string"},"lastModified":{"description":"Date and time the resource was last modified","format":"date-time","type":"string"},"resourceType":{"description":"The resource Type","type":"string"},"location":{"description":"The location (URI) of the resource","type":"string"},"version":{"description":"The version of the resource","type":"string"}}},"name":{"description":"The components of the user's real name","type":"object","properties":{"familyName":{"description":"The family name of the User, or Last Name in most Western languages (for example, Jensen given the full name Ms. Barbara J Jensen, III.)","type":"string","minLength":1},"givenName":{"description":"The given name of the User, or First Name in most Western languages.","type":"string","minLength":1}},"required":["familyName","givenName"]},"userName":{"description":"The user's email.","type":"string","minLength":6},"urn:ietf:params:scim:schemas:extension:talkdesk:2.0:User":{"description":"The user's custom attributes.","type":"object","properties":{"rolesString":{"description":"A list of roles for the user that collectively represent who the user is separated by semicolons, e.g., 'Student;Faculty'.","type":"string","minLength":1},"teamsString":{"description":"The user's team list separated by semicolons.","type":"string","minLength":1}}}},"required":["id","name","userName"]},"example":{"schemas":["urn:ietf:params:scim:schemas:extension:talkdesk:2.0:User","urn:ietf:params:scim:schemas:core:2.0:User"],"id":"5de931b9f9e4c60001140b38","externalId":123456789,"meta":{"resourceType":null,"created":"2019-12-05T16:35:05.451Z","lastModified":"2022-10-20T17:50:38.930Z","location":null,"version":null},"userName":"john.doe@email.com","active":true,"name":{"familyName":"Doe","givenName":"John"},"urn:ietf:params:scim:schemas:extension:talkdesk:2.0:User":{"rolesString":"Administrator","teamsString":"Marketing"}}},"application/scim+json":{"schema":{"description":"User entity","type":"object","properties":{"schemas":{"description":"URN schemas for User resource.","type":"array","items":{"type":"string","description":"The 'urn:ietf:params:scim:schemas:extension:talkdesk:2.0:User' is only required if the user has custom attributes.","minLength":42,"maxLength":56,"enum":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:talkdesk:2.0:User"]}},"id":{"description":"The ID for the object. Immutable.","type":"string","minLength":24,"maxLength":24},"active":{"description":"The user's administrative status.","type":"boolean"},"externalId":{"description":"The external id for the user.","type":"string","minLength":1},"meta":{"description":"User metadata","type":"object","properties":{"created":{"description":"Date and time the resource was created","format":"date-time","type":"string"},"lastModified":{"description":"Date and time the resource was last modified","format":"date-time","type":"string"},"resourceType":{"description":"The resource Type","type":"string"},"location":{"description":"The location (URI) of the resource","type":"string"},"version":{"description":"The version of the resource","type":"string"}}},"name":{"description":"The components of the user's real name","type":"object","properties":{"familyName":{"description":"The family name of the User, or Last Name in most Western languages (for example, Jensen given the full name Ms. Barbara J Jensen, III.)","type":"string","minLength":1},"givenName":{"description":"The given name of the User, or First Name in most Western languages.","type":"string","minLength":1}},"required":["familyName","givenName"]},"userName":{"description":"The user's email.","type":"string","minLength":6},"urn:ietf:params:scim:schemas:extension:talkdesk:2.0:User":{"description":"The user's custom attributes.","type":"object","properties":{"rolesString":{"description":"A list of roles for the user that collectively represent who the user is separated by semicolons, e.g., 'Student;Faculty'.","type":"string","minLength":1},"teamsString":{"description":"The user's team list separated by semicolons.","type":"string","minLength":1}}}},"required":["id","name","userName"]},"example":{"schemas":["urn:ietf:params:scim:schemas:extension:talkdesk:2.0:User","urn:ietf:params:scim:schemas:core:2.0:User"],"id":"5de931b9f9e4c60001140b38","externalId":123456789,"meta":{"resourceType":null,"created":"2019-12-05T16:35:05.451Z","lastModified":"2022-10-20T17:50:38.930Z","location":null,"version":null},"userName":"john.doe@email.com","active":true,"name":{"familyName":"Doe","givenName":"John"},"urn:ietf:params:scim:schemas:extension:talkdesk:2.0:User":{"rolesString":"Administrator","teamsString":"Marketing"}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"SCIM-related error","type":"object","properties":{"schemas":{"description":"URN Schema for Errors","type":"array","items":{"type":"string","minLength":43,"maxLength":43,"enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"status":{"description":"Http Status Code","type":"string","minLength":3,"maxLength":3},"detail":{"description":"Message detailing the error","type":"string","minLength":1},"scimType":{"description":"Type of SCIM error","type":"string","minLength":1}},"required":["schemas","status","detail"]},"examples":{"InvalidSyntax":{"value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"status":"400","detail":"Bad Request","scimType":"invalidSyntax"}},"InvalidValue":{"value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"status":"400","detail":"Bad Request","scimType":"invalidValue"}}}}}},"401":{"description":"Missing or invalid Authorization","content":{"application/json":{"schema":{"description":"SCIM-related error","type":"object","properties":{"schemas":{"description":"URN Schema for Errors","type":"array","items":{"type":"string","minLength":43,"maxLength":43,"enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"status":{"description":"Http Status Code","type":"string","minLength":3,"maxLength":3},"detail":{"description":"Message detailing the error","type":"string","minLength":1},"scimType":{"description":"Type of SCIM error","type":"string","minLength":1}},"required":["schemas","status","detail"]},"examples":{"Example":{"value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"status":"401","detail":"Unauthorized"}}}}}},"403":{"description":"Forbidden operation","content":{"application/json":{"schema":{"description":"SCIM-related error","type":"object","properties":{"schemas":{"description":"URN Schema for Errors","type":"array","items":{"type":"string","minLength":43,"maxLength":43,"enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"status":{"description":"Http Status Code","type":"string","minLength":3,"maxLength":3},"detail":{"description":"Message detailing the error","type":"string","minLength":1},"scimType":{"description":"Type of SCIM error","type":"string","minLength":1}},"required":["schemas","status","detail"]},"examples":{"Example":{"value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"status":"403","detail":"Forbidden"}}}}}},"406":{"description":"Invalid Accept header","content":{"application/json":{"schema":{"description":"SCIM-related error","type":"object","properties":{"schemas":{"description":"URN Schema for Errors","type":"array","items":{"type":"string","minLength":43,"maxLength":43,"enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"status":{"description":"Http Status Code","type":"string","minLength":3,"maxLength":3},"detail":{"description":"Message detailing the error","type":"string","minLength":1},"scimType":{"description":"Type of SCIM error","type":"string","minLength":1}},"required":["schemas","status","detail"]},"examples":{"Example":{"value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"status":"406","detail":"Not Acceptable"}}}}}},"409":{"description":"Conflict with user","content":{"application/json":{"schema":{"description":"SCIM-related error","type":"object","properties":{"schemas":{"description":"URN Schema for Errors","type":"array","items":{"type":"string","minLength":43,"maxLength":43,"enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"status":{"description":"Http Status Code","type":"string","minLength":3,"maxLength":3},"detail":{"description":"Message detailing the error","type":"string","minLength":1},"scimType":{"description":"Type of SCIM error","type":"string","minLength":1}},"required":["schemas","status","detail"]},"examples":{"Username already exists":{"value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"status":"409","detail":"User {id} already exists","scimType":"uniqueness"}},"Account is out of licenses":{"value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"status":"409","detail":"Account is out of licenses."}}}}}}},"summary":"Create User","tags":["SCIM"]}},"/scim/v2/Users/{user_id}":{"delete":{"description":"Deletes user from account","operationId":"deleteUser","security":[{"GA":["scim"]}],"parameters":[{"in":"path","name":"user_id","schema":{"type":"string","minLength":24,"maxLength":24},"required":true,"description":"User Id"}],"responses":{"204":{"description":"The request has succeeded."},"401":{"description":"Missing or invalid Authorization","content":{"application/json":{"schema":{"description":"SCIM-related error","type":"object","properties":{"schemas":{"description":"URN Schema for Errors","type":"array","items":{"type":"string","minLength":43,"maxLength":43,"enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"status":{"description":"Http Status Code","type":"string","minLength":3,"maxLength":3},"detail":{"description":"Message detailing the error","type":"string","minLength":1},"scimType":{"description":"Type of SCIM error","type":"string","minLength":1}},"required":["schemas","status","detail"]},"examples":{"Example":{"value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"status":"401","detail":"Unauthorized"}}}}}},"403":{"description":"Forbidden operation","content":{"application/json":{"schema":{"description":"SCIM-related error","type":"object","properties":{"schemas":{"description":"URN Schema for Errors","type":"array","items":{"type":"string","minLength":43,"maxLength":43,"enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"status":{"description":"Http Status Code","type":"string","minLength":3,"maxLength":3},"detail":{"description":"Message detailing the error","type":"string","minLength":1},"scimType":{"description":"Type of SCIM error","type":"string","minLength":1}},"required":["schemas","status","detail"]},"examples":{"Example":{"value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"status":"403","detail":"Forbidden"}}}}}},"404":{"description":"User not found","content":{"application/json":{"schema":{"description":"SCIM-related error","type":"object","properties":{"schemas":{"description":"URN Schema for Errors","type":"array","items":{"type":"string","minLength":43,"maxLength":43,"enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"status":{"description":"Http Status Code","type":"string","minLength":3,"maxLength":3},"detail":{"description":"Message detailing the error","type":"string","minLength":1},"scimType":{"description":"Type of SCIM error","type":"string","minLength":1}},"required":["schemas","status","detail"]},"examples":{"Example":{"value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"status":"404","detail":"User {id} not found"}}}}}}},"summary":"Delete User","tags":["SCIM"]},"get":{"description":"Get user details","operationId":"getUser","security":[{"GA":["scim"]}],"parameters":[{"in":"path","name":"user_id","schema":{"type":"string","minLength":24,"maxLength":24},"required":true,"description":"User Id"}],"responses":{"200":{"description":"User response","content":{"application/json":{"schema":{"description":"User entity","type":"object","properties":{"schemas":{"description":"URN schemas for User resource.","type":"array","items":{"type":"string","description":"The 'urn:ietf:params:scim:schemas:extension:talkdesk:2.0:User' is only required if the user has custom attributes.","minLength":42,"maxLength":56,"enum":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:talkdesk:2.0:User"]}},"id":{"description":"The ID for the object. Immutable.","type":"string","minLength":24,"maxLength":24},"active":{"description":"The user's administrative status.","type":"boolean"},"externalId":{"description":"The external id for the user.","type":"string","minLength":1},"meta":{"description":"User metadata","type":"object","properties":{"created":{"description":"Date and time the resource was created","format":"date-time","type":"string"},"lastModified":{"description":"Date and time the resource was last modified","format":"date-time","type":"string"},"resourceType":{"description":"The resource Type","type":"string"},"location":{"description":"The location (URI) of the resource","type":"string"},"version":{"description":"The version of the resource","type":"string"}}},"name":{"description":"The components of the user's real name","type":"object","properties":{"familyName":{"description":"The family name of the User, or Last Name in most Western languages (for example, Jensen given the full name Ms. Barbara J Jensen, III.)","type":"string","minLength":1},"givenName":{"description":"The given name of the User, or First Name in most Western languages.","type":"string","minLength":1}},"required":["familyName","givenName"]},"userName":{"description":"The user's email.","type":"string","minLength":6},"urn:ietf:params:scim:schemas:extension:talkdesk:2.0:User":{"description":"The user's custom attributes.","type":"object","properties":{"rolesString":{"description":"A list of roles for the user that collectively represent who the user is separated by semicolons, e.g., 'Student;Faculty'.","type":"string","minLength":1},"teamsString":{"description":"The user's team list separated by semicolons.","type":"string","minLength":1}}}},"required":["id","name","userName"]},"example":{"schemas":["urn:ietf:params:scim:schemas:extension:talkdesk:2.0:User","urn:ietf:params:scim:schemas:core:2.0:User"],"id":"5de931b9f9e4c60001140b38","externalId":123456789,"meta":{"resourceType":null,"created":"2019-12-05T16:35:05.451Z","lastModified":"2022-10-20T17:50:38.930Z","location":null,"version":null},"userName":"john.doe@email.com","active":true,"name":{"familyName":"Doe","givenName":"John"},"urn:ietf:params:scim:schemas:extension:talkdesk:2.0:User":{"rolesString":"Administrator","teamsString":"Marketing"}}},"application/scim+json":{"schema":{"description":"User entity","type":"object","properties":{"schemas":{"description":"URN schemas for User resource.","type":"array","items":{"type":"string","description":"The 'urn:ietf:params:scim:schemas:extension:talkdesk:2.0:User' is only required if the user has custom attributes.","minLength":42,"maxLength":56,"enum":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:talkdesk:2.0:User"]}},"id":{"description":"The ID for the object. Immutable.","type":"string","minLength":24,"maxLength":24},"active":{"description":"The user's administrative status.","type":"boolean"},"externalId":{"description":"The external id for the user.","type":"string","minLength":1},"meta":{"description":"User metadata","type":"object","properties":{"created":{"description":"Date and time the resource was created","format":"date-time","type":"string"},"lastModified":{"description":"Date and time the resource was last modified","format":"date-time","type":"string"},"resourceType":{"description":"The resource Type","type":"string"},"location":{"description":"The location (URI) of the resource","type":"string"},"version":{"description":"The version of the resource","type":"string"}}},"name":{"description":"The components of the user's real name","type":"object","properties":{"familyName":{"description":"The family name of the User, or Last Name in most Western languages (for example, Jensen given the full name Ms. Barbara J Jensen, III.)","type":"string","minLength":1},"givenName":{"description":"The given name of the User, or First Name in most Western languages.","type":"string","minLength":1}},"required":["familyName","givenName"]},"userName":{"description":"The user's email.","type":"string","minLength":6},"urn:ietf:params:scim:schemas:extension:talkdesk:2.0:User":{"description":"The user's custom attributes.","type":"object","properties":{"rolesString":{"description":"A list of roles for the user that collectively represent who the user is separated by semicolons, e.g., 'Student;Faculty'.","type":"string","minLength":1},"teamsString":{"description":"The user's team list separated by semicolons.","type":"string","minLength":1}}}},"required":["id","name","userName"]},"example":{"schemas":["urn:ietf:params:scim:schemas:extension:talkdesk:2.0:User","urn:ietf:params:scim:schemas:core:2.0:User"],"id":"5de931b9f9e4c60001140b38","externalId":123456789,"meta":{"resourceType":null,"created":"2019-12-05T16:35:05.451Z","lastModified":"2022-10-20T17:50:38.930Z","location":null,"version":null},"userName":"john.doe@email.com","active":true,"name":{"familyName":"Doe","givenName":"John"},"urn:ietf:params:scim:schemas:extension:talkdesk:2.0:User":{"rolesString":"Administrator","teamsString":"Marketing"}}}}},"401":{"description":"Missing or invalid Authorization","content":{"application/json":{"schema":{"description":"SCIM-related error","type":"object","properties":{"schemas":{"description":"URN Schema for Errors","type":"array","items":{"type":"string","minLength":43,"maxLength":43,"enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"status":{"description":"Http Status Code","type":"string","minLength":3,"maxLength":3},"detail":{"description":"Message detailing the error","type":"string","minLength":1},"scimType":{"description":"Type of SCIM error","type":"string","minLength":1}},"required":["schemas","status","detail"]},"examples":{"Example":{"value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"status":"401","detail":"Unauthorized"}}}}}},"403":{"description":"Forbidden operation","content":{"application/json":{"schema":{"description":"SCIM-related error","type":"object","properties":{"schemas":{"description":"URN Schema for Errors","type":"array","items":{"type":"string","minLength":43,"maxLength":43,"enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"status":{"description":"Http Status Code","type":"string","minLength":3,"maxLength":3},"detail":{"description":"Message detailing the error","type":"string","minLength":1},"scimType":{"description":"Type of SCIM error","type":"string","minLength":1}},"required":["schemas","status","detail"]},"examples":{"Example":{"value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"status":"403","detail":"Forbidden"}}}}}},"404":{"description":"User not found","content":{"application/json":{"schema":{"description":"SCIM-related error","type":"object","properties":{"schemas":{"description":"URN Schema for Errors","type":"array","items":{"type":"string","minLength":43,"maxLength":43,"enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"status":{"description":"Http Status Code","type":"string","minLength":3,"maxLength":3},"detail":{"description":"Message detailing the error","type":"string","minLength":1},"scimType":{"description":"Type of SCIM error","type":"string","minLength":1}},"required":["schemas","status","detail"]},"examples":{"Example":{"value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"status":"404","detail":"User {id} not found"}}}}}},"406":{"description":"Invalid Accept header","content":{"application/json":{"schema":{"description":"SCIM-related error","type":"object","properties":{"schemas":{"description":"URN Schema for Errors","type":"array","items":{"type":"string","minLength":43,"maxLength":43,"enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"status":{"description":"Http Status Code","type":"string","minLength":3,"maxLength":3},"detail":{"description":"Message detailing the error","type":"string","minLength":1},"scimType":{"description":"Type of SCIM error","type":"string","minLength":1}},"required":["schemas","status","detail"]},"examples":{"Example":{"value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"status":"406","detail":"Not Acceptable"}}}}}}},"summary":"Get User","tags":["SCIM"]},"patch":{"description":"Change selected fields of the User entity (cannot change ID).","operationId":"patchUser","security":[{"GA":["scim"]}],"parameters":[{"in":"path","name":"user_id","schema":{"type":"string","minLength":24,"maxLength":24},"required":true,"description":"User Id"}],"requestBody":{"description":"The new user data","required":true,"content":{"application/json":{"schema":{"description":"Patch Operations","type":"object","properties":{"schemas":{"description":"URN Schema for PatchOp","type":"array","items":{"type":"string","minLength":45,"maxLength":45,"enum":["urn:ietf:params:scim:api:messages:2.0:PatchOp"]}},"Operations":{"description":"List of operations in JSON PATCH format","type":"array","items":{"type":"object","properties":{"op":{"type":"string","minLength":3,"maxLength":7,"enum":["add","remove","replace"]},"path":{"type":"string","minLength":1},"value":{"oneOf":[{"type":"string","minLength":1},{"type":"object","properties":{"attribute-path":{"type":"string","minLength":1}},"required":["attribute-path"]}]}},"required":["op","value"]}}},"required":["schemas","Operations"]}},"application/scim+json":{"schema":{"description":"Patch Operations","type":"object","properties":{"schemas":{"description":"URN Schema for PatchOp","type":"array","items":{"type":"string","minLength":45,"maxLength":45,"enum":["urn:ietf:params:scim:api:messages:2.0:PatchOp"]}},"Operations":{"description":"List of operations in JSON PATCH format","type":"array","items":{"type":"object","properties":{"op":{"type":"string","minLength":3,"maxLength":7,"enum":["add","remove","replace"]},"path":{"type":"string","minLength":1},"value":{"oneOf":[{"type":"string","minLength":1},{"type":"object","properties":{"attribute-path":{"type":"string","minLength":1}},"required":["attribute-path"]}]}},"required":["op","value"]}}},"required":["schemas","Operations"]}}}},"responses":{"200":{"description":"The user has been updated.","content":{"application/json":{"schema":{"description":"User entity","type":"object","properties":{"schemas":{"description":"URN schemas for User resource.","type":"array","items":{"type":"string","description":"The 'urn:ietf:params:scim:schemas:extension:talkdesk:2.0:User' is only required if the user has custom attributes.","minLength":42,"maxLength":56,"enum":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:talkdesk:2.0:User"]}},"id":{"description":"The ID for the object. Immutable.","type":"string","minLength":24,"maxLength":24},"active":{"description":"The user's administrative status.","type":"boolean"},"externalId":{"description":"The external id for the user.","type":"string","minLength":1},"meta":{"description":"User metadata","type":"object","properties":{"created":{"description":"Date and time the resource was created","format":"date-time","type":"string"},"lastModified":{"description":"Date and time the resource was last modified","format":"date-time","type":"string"},"resourceType":{"description":"The resource Type","type":"string"},"location":{"description":"The location (URI) of the resource","type":"string"},"version":{"description":"The version of the resource","type":"string"}}},"name":{"description":"The components of the user's real name","type":"object","properties":{"familyName":{"description":"The family name of the User, or Last Name in most Western languages (for example, Jensen given the full name Ms. Barbara J Jensen, III.)","type":"string","minLength":1},"givenName":{"description":"The given name of the User, or First Name in most Western languages.","type":"string","minLength":1}},"required":["familyName","givenName"]},"userName":{"description":"The user's email.","type":"string","minLength":6},"urn:ietf:params:scim:schemas:extension:talkdesk:2.0:User":{"description":"The user's custom attributes.","type":"object","properties":{"rolesString":{"description":"A list of roles for the user that collectively represent who the user is separated by semicolons, e.g., 'Student;Faculty'.","type":"string","minLength":1},"teamsString":{"description":"The user's team list separated by semicolons.","type":"string","minLength":1}}}},"required":["id","name","userName"]},"example":{"schemas":["urn:ietf:params:scim:schemas:extension:talkdesk:2.0:User","urn:ietf:params:scim:schemas:core:2.0:User"],"id":"5de931b9f9e4c60001140b38","externalId":123456789,"meta":{"resourceType":null,"created":"2019-12-05T16:35:05.451Z","lastModified":"2022-10-20T17:50:38.930Z","location":null,"version":null},"userName":"john.doe@email.com","active":true,"name":{"familyName":"Doe","givenName":"John"},"urn:ietf:params:scim:schemas:extension:talkdesk:2.0:User":{"rolesString":"Administrator","teamsString":"Marketing"}}},"application/scim+json":{"schema":{"description":"User entity","type":"object","properties":{"schemas":{"description":"URN schemas for User resource.","type":"array","items":{"type":"string","description":"The 'urn:ietf:params:scim:schemas:extension:talkdesk:2.0:User' is only required if the user has custom attributes.","minLength":42,"maxLength":56,"enum":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:talkdesk:2.0:User"]}},"id":{"description":"The ID for the object. Immutable.","type":"string","minLength":24,"maxLength":24},"active":{"description":"The user's administrative status.","type":"boolean"},"externalId":{"description":"The external id for the user.","type":"string","minLength":1},"meta":{"description":"User metadata","type":"object","properties":{"created":{"description":"Date and time the resource was created","format":"date-time","type":"string"},"lastModified":{"description":"Date and time the resource was last modified","format":"date-time","type":"string"},"resourceType":{"description":"The resource Type","type":"string"},"location":{"description":"The location (URI) of the resource","type":"string"},"version":{"description":"The version of the resource","type":"string"}}},"name":{"description":"The components of the user's real name","type":"object","properties":{"familyName":{"description":"The family name of the User, or Last Name in most Western languages (for example, Jensen given the full name Ms. Barbara J Jensen, III.)","type":"string","minLength":1},"givenName":{"description":"The given name of the User, or First Name in most Western languages.","type":"string","minLength":1}},"required":["familyName","givenName"]},"userName":{"description":"The user's email.","type":"string","minLength":6},"urn:ietf:params:scim:schemas:extension:talkdesk:2.0:User":{"description":"The user's custom attributes.","type":"object","properties":{"rolesString":{"description":"A list of roles for the user that collectively represent who the user is separated by semicolons, e.g., 'Student;Faculty'.","type":"string","minLength":1},"teamsString":{"description":"The user's team list separated by semicolons.","type":"string","minLength":1}}}},"required":["id","name","userName"]},"example":{"schemas":["urn:ietf:params:scim:schemas:extension:talkdesk:2.0:User","urn:ietf:params:scim:schemas:core:2.0:User"],"id":"5de931b9f9e4c60001140b38","externalId":123456789,"meta":{"resourceType":null,"created":"2019-12-05T16:35:05.451Z","lastModified":"2022-10-20T17:50:38.930Z","location":null,"version":null},"userName":"john.doe@email.com","active":true,"name":{"familyName":"Doe","givenName":"John"},"urn:ietf:params:scim:schemas:extension:talkdesk:2.0:User":{"rolesString":"Administrator","teamsString":"Marketing"}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"SCIM-related error","type":"object","properties":{"schemas":{"description":"URN Schema for Errors","type":"array","items":{"type":"string","minLength":43,"maxLength":43,"enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"status":{"description":"Http Status Code","type":"string","minLength":3,"maxLength":3},"detail":{"description":"Message detailing the error","type":"string","minLength":1},"scimType":{"description":"Type of SCIM error","type":"string","minLength":1}},"required":["schemas","status","detail"]},"examples":{"Mutability":{"value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"status":"400","detail":"Bad Request","scimType":"mutability"}},"InvalidSyntax":{"value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"status":"400","detail":"Bad Request","scimType":"invalidSyntax"}},"InvalidValue":{"value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"status":"400","detail":"Bad Request","scimType":"invalidValue"}}}}}},"401":{"description":"Missing or invalid Authorization","content":{"application/json":{"schema":{"description":"SCIM-related error","type":"object","properties":{"schemas":{"description":"URN Schema for Errors","type":"array","items":{"type":"string","minLength":43,"maxLength":43,"enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"status":{"description":"Http Status Code","type":"string","minLength":3,"maxLength":3},"detail":{"description":"Message detailing the error","type":"string","minLength":1},"scimType":{"description":"Type of SCIM error","type":"string","minLength":1}},"required":["schemas","status","detail"]},"examples":{"Example":{"value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"status":"401","detail":"Unauthorized"}}}}}},"403":{"description":"Forbidden operation","content":{"application/json":{"schema":{"description":"SCIM-related error","type":"object","properties":{"schemas":{"description":"URN Schema for Errors","type":"array","items":{"type":"string","minLength":43,"maxLength":43,"enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"status":{"description":"Http Status Code","type":"string","minLength":3,"maxLength":3},"detail":{"description":"Message detailing the error","type":"string","minLength":1},"scimType":{"description":"Type of SCIM error","type":"string","minLength":1}},"required":["schemas","status","detail"]},"examples":{"Example":{"value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"status":"403","detail":"Forbidden"}}}}}},"404":{"description":"User not found","content":{"application/json":{"schema":{"description":"SCIM-related error","type":"object","properties":{"schemas":{"description":"URN Schema for Errors","type":"array","items":{"type":"string","minLength":43,"maxLength":43,"enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"status":{"description":"Http Status Code","type":"string","minLength":3,"maxLength":3},"detail":{"description":"Message detailing the error","type":"string","minLength":1},"scimType":{"description":"Type of SCIM error","type":"string","minLength":1}},"required":["schemas","status","detail"]},"examples":{"Example":{"value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"status":"404","detail":"User {id} not found"}}}}}},"406":{"description":"Invalid Accept header","content":{"application/json":{"schema":{"description":"SCIM-related error","type":"object","properties":{"schemas":{"description":"URN Schema for Errors","type":"array","items":{"type":"string","minLength":43,"maxLength":43,"enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"status":{"description":"Http Status Code","type":"string","minLength":3,"maxLength":3},"detail":{"description":"Message detailing the error","type":"string","minLength":1},"scimType":{"description":"Type of SCIM error","type":"string","minLength":1}},"required":["schemas","status","detail"]},"examples":{"Example":{"value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"status":"406","detail":"Not Acceptable"}}}}}},"409":{"description":"Conflict with user","content":{"application/json":{"schema":{"description":"SCIM-related error","type":"object","properties":{"schemas":{"description":"URN Schema for Errors","type":"array","items":{"type":"string","minLength":43,"maxLength":43,"enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"status":{"description":"Http Status Code","type":"string","minLength":3,"maxLength":3},"detail":{"description":"Message detailing the error","type":"string","minLength":1},"scimType":{"description":"Type of SCIM error","type":"string","minLength":1}},"required":["schemas","status","detail"]},"examples":{"Username already exists":{"value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"status":"409","detail":"User {id} already exists","scimType":"uniqueness"}},"Account is out of licenses":{"value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"status":"409","detail":"Account is out of licenses."}}}}}}},"summary":"Update partial User's attributes","tags":["SCIM"]},"put":{"description":"Change all fields of the User entity (cannot change ID).","operationId":"updateUser","security":[{"GA":["scim"]}],"parameters":[{"in":"path","name":"user_id","schema":{"type":"string","minLength":24,"maxLength":24},"required":true,"description":"User Id"}],"requestBody":{"description":"The new user data","required":true,"content":{"application/json":{"schema":{"description":"Create/update user","type":"object","properties":{"schemas":{"description":"URN schemas for User resource.","type":"array","items":{"type":"string","description":"The 'urn:ietf:params:scim:schemas:extension:talkdesk:2.0:User' is only required if the user has custom attributes.","minLength":42,"maxLength":56,"enum":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:talkdesk:2.0:User"]}},"name":{"description":"The components of the user's real name","type":"object","properties":{"familyName":{"description":"The family name of the User, or Last Name in most Western languages (for example, Jensen given the full name Ms. Barbara J Jensen, III.)","type":"string","minLength":1},"givenName":{"description":"The given name of the User, or First Name in most Western languages.","type":"string","minLength":1}},"required":["familyName","givenName"]},"externalId":{"description":"The user's external identifier","type":"string","minLength":1},"userName":{"description":"The user's email","type":"string","minLength":1},"active":{"description":"The user's administrative status.","type":"boolean"},"urn:ietf:params:scim:schemas:extension:talkdesk:2.0:User":{"description":"The user's custom attributes.","type":"object","properties":{"rolesString":{"description":"A list of roles for the user that collectively represent who the user is separated by semicolons, e.g., 'Student;Faculty'.","type":"string","minLength":1},"teamsString":{"description":"The user's team list separated by semicolons.","type":"string","minLength":1}}}},"required":["name","userName","active"]}},"application/scim+json":{"schema":{"description":"Create/update user","type":"object","properties":{"schemas":{"description":"URN schemas for User resource.","type":"array","items":{"type":"string","description":"The 'urn:ietf:params:scim:schemas:extension:talkdesk:2.0:User' is only required if the user has custom attributes.","minLength":42,"maxLength":56,"enum":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:talkdesk:2.0:User"]}},"name":{"description":"The components of the user's real name","type":"object","properties":{"familyName":{"description":"The family name of the User, or Last Name in most Western languages (for example, Jensen given the full name Ms. Barbara J Jensen, III.)","type":"string","minLength":1},"givenName":{"description":"The given name of the User, or First Name in most Western languages.","type":"string","minLength":1}},"required":["familyName","givenName"]},"externalId":{"description":"The user's external identifier","type":"string","minLength":1},"userName":{"description":"The user's email","type":"string","minLength":1},"active":{"description":"The user's administrative status.","type":"boolean"},"urn:ietf:params:scim:schemas:extension:talkdesk:2.0:User":{"description":"The user's custom attributes.","type":"object","properties":{"rolesString":{"description":"A list of roles for the user that collectively represent who the user is separated by semicolons, e.g., 'Student;Faculty'.","type":"string","minLength":1},"teamsString":{"description":"The user's team list separated by semicolons.","type":"string","minLength":1}}}},"required":["name","userName","active"]}}}},"responses":{"200":{"description":"The user has been updated.","content":{"application/json":{"schema":{"description":"User entity","type":"object","properties":{"schemas":{"description":"URN schemas for User resource.","type":"array","items":{"type":"string","description":"The 'urn:ietf:params:scim:schemas:extension:talkdesk:2.0:User' is only required if the user has custom attributes.","minLength":42,"maxLength":56,"enum":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:talkdesk:2.0:User"]}},"id":{"description":"The ID for the object. Immutable.","type":"string","minLength":24,"maxLength":24},"active":{"description":"The user's administrative status.","type":"boolean"},"externalId":{"description":"The external id for the user.","type":"string","minLength":1},"meta":{"description":"User metadata","type":"object","properties":{"created":{"description":"Date and time the resource was created","format":"date-time","type":"string"},"lastModified":{"description":"Date and time the resource was last modified","format":"date-time","type":"string"},"resourceType":{"description":"The resource Type","type":"string"},"location":{"description":"The location (URI) of the resource","type":"string"},"version":{"description":"The version of the resource","type":"string"}}},"name":{"description":"The components of the user's real name","type":"object","properties":{"familyName":{"description":"The family name of the User, or Last Name in most Western languages (for example, Jensen given the full name Ms. Barbara J Jensen, III.)","type":"string","minLength":1},"givenName":{"description":"The given name of the User, or First Name in most Western languages.","type":"string","minLength":1}},"required":["familyName","givenName"]},"userName":{"description":"The user's email.","type":"string","minLength":6},"urn:ietf:params:scim:schemas:extension:talkdesk:2.0:User":{"description":"The user's custom attributes.","type":"object","properties":{"rolesString":{"description":"A list of roles for the user that collectively represent who the user is separated by semicolons, e.g., 'Student;Faculty'.","type":"string","minLength":1},"teamsString":{"description":"The user's team list separated by semicolons.","type":"string","minLength":1}}}},"required":["id","name","userName"]},"example":{"schemas":["urn:ietf:params:scim:schemas:extension:talkdesk:2.0:User","urn:ietf:params:scim:schemas:core:2.0:User"],"id":"5de931b9f9e4c60001140b38","externalId":123456789,"meta":{"resourceType":null,"created":"2019-12-05T16:35:05.451Z","lastModified":"2022-10-20T17:50:38.930Z","location":null,"version":null},"userName":"john.doe@email.com","active":true,"name":{"familyName":"Doe","givenName":"John"},"urn:ietf:params:scim:schemas:extension:talkdesk:2.0:User":{"rolesString":"Administrator","teamsString":"Marketing"}}},"application/scim+json":{"schema":{"description":"User entity","type":"object","properties":{"schemas":{"description":"URN schemas for User resource.","type":"array","items":{"type":"string","description":"The 'urn:ietf:params:scim:schemas:extension:talkdesk:2.0:User' is only required if the user has custom attributes.","minLength":42,"maxLength":56,"enum":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:talkdesk:2.0:User"]}},"id":{"description":"The ID for the object. Immutable.","type":"string","minLength":24,"maxLength":24},"active":{"description":"The user's administrative status.","type":"boolean"},"externalId":{"description":"The external id for the user.","type":"string","minLength":1},"meta":{"description":"User metadata","type":"object","properties":{"created":{"description":"Date and time the resource was created","format":"date-time","type":"string"},"lastModified":{"description":"Date and time the resource was last modified","format":"date-time","type":"string"},"resourceType":{"description":"The resource Type","type":"string"},"location":{"description":"The location (URI) of the resource","type":"string"},"version":{"description":"The version of the resource","type":"string"}}},"name":{"description":"The components of the user's real name","type":"object","properties":{"familyName":{"description":"The family name of the User, or Last Name in most Western languages (for example, Jensen given the full name Ms. Barbara J Jensen, III.)","type":"string","minLength":1},"givenName":{"description":"The given name of the User, or First Name in most Western languages.","type":"string","minLength":1}},"required":["familyName","givenName"]},"userName":{"description":"The user's email.","type":"string","minLength":6},"urn:ietf:params:scim:schemas:extension:talkdesk:2.0:User":{"description":"The user's custom attributes.","type":"object","properties":{"rolesString":{"description":"A list of roles for the user that collectively represent who the user is separated by semicolons, e.g., 'Student;Faculty'.","type":"string","minLength":1},"teamsString":{"description":"The user's team list separated by semicolons.","type":"string","minLength":1}}}},"required":["id","name","userName"]},"example":{"schemas":["urn:ietf:params:scim:schemas:extension:talkdesk:2.0:User","urn:ietf:params:scim:schemas:core:2.0:User"],"id":"5de931b9f9e4c60001140b38","externalId":123456789,"meta":{"resourceType":null,"created":"2019-12-05T16:35:05.451Z","lastModified":"2022-10-20T17:50:38.930Z","location":null,"version":null},"userName":"john.doe@email.com","active":true,"name":{"familyName":"Doe","givenName":"John"},"urn:ietf:params:scim:schemas:extension:talkdesk:2.0:User":{"rolesString":"Administrator","teamsString":"Marketing"}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"SCIM-related error","type":"object","properties":{"schemas":{"description":"URN Schema for Errors","type":"array","items":{"type":"string","minLength":43,"maxLength":43,"enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"status":{"description":"Http Status Code","type":"string","minLength":3,"maxLength":3},"detail":{"description":"Message detailing the error","type":"string","minLength":1},"scimType":{"description":"Type of SCIM error","type":"string","minLength":1}},"required":["schemas","status","detail"]},"examples":{"Mutability":{"value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"status":"400","detail":"Bad Request","scimType":"mutability"}},"InvalidSyntax":{"value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"status":"400","detail":"Bad Request","scimType":"invalidSyntax"}},"InvalidValue":{"value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"status":"400","detail":"Bad Request","scimType":"invalidValue"}}}}}},"401":{"description":"Missing or invalid Authorization","content":{"application/json":{"schema":{"description":"SCIM-related error","type":"object","properties":{"schemas":{"description":"URN Schema for Errors","type":"array","items":{"type":"string","minLength":43,"maxLength":43,"enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"status":{"description":"Http Status Code","type":"string","minLength":3,"maxLength":3},"detail":{"description":"Message detailing the error","type":"string","minLength":1},"scimType":{"description":"Type of SCIM error","type":"string","minLength":1}},"required":["schemas","status","detail"]},"examples":{"Example":{"value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"status":"401","detail":"Unauthorized"}}}}}},"403":{"description":"Forbidden operation","content":{"application/json":{"schema":{"description":"SCIM-related error","type":"object","properties":{"schemas":{"description":"URN Schema for Errors","type":"array","items":{"type":"string","minLength":43,"maxLength":43,"enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"status":{"description":"Http Status Code","type":"string","minLength":3,"maxLength":3},"detail":{"description":"Message detailing the error","type":"string","minLength":1},"scimType":{"description":"Type of SCIM error","type":"string","minLength":1}},"required":["schemas","status","detail"]},"examples":{"Example":{"value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"status":"403","detail":"Forbidden"}}}}}},"404":{"description":"User not found","content":{"application/json":{"schema":{"description":"SCIM-related error","type":"object","properties":{"schemas":{"description":"URN Schema for Errors","type":"array","items":{"type":"string","minLength":43,"maxLength":43,"enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"status":{"description":"Http Status Code","type":"string","minLength":3,"maxLength":3},"detail":{"description":"Message detailing the error","type":"string","minLength":1},"scimType":{"description":"Type of SCIM error","type":"string","minLength":1}},"required":["schemas","status","detail"]},"examples":{"Example":{"value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"status":"404","detail":"User {id} not found"}}}}}},"406":{"description":"Invalid Accept header","content":{"application/json":{"schema":{"description":"SCIM-related error","type":"object","properties":{"schemas":{"description":"URN Schema for Errors","type":"array","items":{"type":"string","minLength":43,"maxLength":43,"enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"status":{"description":"Http Status Code","type":"string","minLength":3,"maxLength":3},"detail":{"description":"Message detailing the error","type":"string","minLength":1},"scimType":{"description":"Type of SCIM error","type":"string","minLength":1}},"required":["schemas","status","detail"]},"examples":{"Example":{"value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"status":"406","detail":"Not Acceptable"}}}}}},"409":{"description":"Conflict with user","content":{"application/json":{"schema":{"description":"SCIM-related error","type":"object","properties":{"schemas":{"description":"URN Schema for Errors","type":"array","items":{"type":"string","minLength":43,"maxLength":43,"enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"status":{"description":"Http Status Code","type":"string","minLength":3,"maxLength":3},"detail":{"description":"Message detailing the error","type":"string","minLength":1},"scimType":{"description":"Type of SCIM error","type":"string","minLength":1}},"required":["schemas","status","detail"]},"examples":{"Username already exists":{"value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"status":"409","detail":"User {id} already exists","scimType":"uniqueness"}},"Account is out of licenses":{"value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"status":"409","detail":"Account is out of licenses."}}}}}}},"summary":"Update User's attributes","tags":["SCIM"]}},"/scim/v2/ServiceProviderConfig":{"get":{"description":"Check the service provider configurations available in this instance","operationId":"getServiceProviderConfigs","security":[{"GA":["scim"]}],"responses":{"200":{"description":"The request has succeeded.","content":{"application/json":{"schema":{"description":"Represents the Service Provider's configuration","type":"object","properties":{"schemas":{"description":"URN of the schemas for this document","type":"array","items":{"type":"string"}},"bulk":{"description":"Displays Bulk feature","type":"object","properties":{"supported":{"description":"Displays if feature is supported or not","type":"boolean"},"maxOperations":{"description":"Maximum number of operations","type":"integer","maximum":10000,"minimum":0},"maxPayloadSize":{"description":"Maximum payload size in bytes","type":"integer","maximum":10000,"minimum":0}},"required":["supported","maxOperations","maxPayloadSize"]},"changePassword":{"description":"Displays Change Password feature","type":"object","properties":{"supported":{"description":"Displays if feature is supported or not","type":"boolean"}},"required":["supported"]},"documentationUri":{"description":"Service Provider's documentation","type":"string"},"etag":{"description":"Displays Etag feature","type":"object","properties":{"supported":{"description":"Displays if feature is supported or not","type":"boolean"}},"required":["supported"]},"filter":{"description":"Displays Filter feature","type":"object","properties":{"supported":{"description":"Displays if feature is supported or not","type":"boolean"},"maxResults":{"description":"Default value for max results in pagination","type":"integer"}},"required":["supported","maxResults"]},"patch":{"description":"Displays Patch feature","type":"object","properties":{"supported":{"description":"Displays if feature is supported or not","type":"boolean"}},"required":["supported"]},"sort":{"description":"Displays Sort feature","type":"object","properties":{"supported":{"description":"Displays if feature is supported or not","type":"boolean"}},"required":["supported"]},"meta":{"description":"Displays meta information","type":"object","properties":{"resourceType":{"description":"Displays the resource type","type":"string"},"location":{"description":"Displays the resource location","type":"string"}},"required":["resourceType","location"]}},"required":["documentationUri","patch","bulk","filter","changePassword","sort","etag","schemas"]},"example":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig"],"documentationUri":"https://docs.talkdesk.com/docs/scim-api","patch":{"supported":true},"bulk":{"supported":false,"maxOperations":1000,"maxPayloadSize":1000},"filter":{"supported":true,"maxResults":20},"changePassword":{"supported":false},"sort":{"supported":false},"etag":{"supported":false},"meta":{"resourceType":"ServiceProviderConfig","location":"https://api.talkdeskapp.com/scim/v2/ServiceProviderConfig"}}}}},"401":{"description":"Missing or invalid Authorization","content":{"application/json":{"schema":{"description":"SCIM-related error","type":"object","properties":{"schemas":{"description":"URN Schema for Errors","type":"array","items":{"type":"string","minLength":43,"maxLength":43,"enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"status":{"description":"Http Status Code","type":"string","minLength":3,"maxLength":3},"detail":{"description":"Message detailing the error","type":"string","minLength":1},"scimType":{"description":"Type of SCIM error","type":"string","minLength":1}},"required":["schemas","status","detail"]},"examples":{"Example":{"value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"status":"401","detail":"Unauthorized"}}}}}},"403":{"description":"Forbidden operation","content":{"application/json":{"schema":{"description":"SCIM-related error","type":"object","properties":{"schemas":{"description":"URN Schema for Errors","type":"array","items":{"type":"string","minLength":43,"maxLength":43,"enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"status":{"description":"Http Status Code","type":"string","minLength":3,"maxLength":3},"detail":{"description":"Message detailing the error","type":"string","minLength":1},"scimType":{"description":"Type of SCIM error","type":"string","minLength":1}},"required":["schemas","status","detail"]},"examples":{"Example":{"value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"status":"403","detail":"Forbidden"}}}}}}},"summary":"Get Service Provider Configurations","tags":["SCIM"]}},"/scim/v2/ResourceTypes":{"get":{"description":"Check the service provider available resource types","operationId":"getResourceTypes","security":[{"GA":["scim"]}],"responses":{"200":{"description":"The request has succeeded","content":{"application/json":{"schema":{"type":"object","properties":{"schemas":{"description":"Related URNs of the resource type of the response","type":"array","items":{"type":"string","minLength":50,"maxLength":50,"enum":["urn:ietf:params:scim:api:messages:2.0:ListResponse"]}},"Resources":{"description":"List of Resource types supported","type":"array","items":{"description":"Describes the attributes and metadata constituting a resource such as a user.","type":"object","properties":{"schemas":{"description":"Related URNs of the resource type","type":"array","items":{"type":"string"}},"description":{"description":"The resource's description, e.g. Access User Resources","type":"string"},"endpoint":{"description":"The relative endpoint to obtain the resource, e.g. /scim/v2/Users","type":"string"},"id":{"description":"The resource's id, e.g. \"User\"","type":"string"},"name":{"description":"The resource's name, e.g. \"User\"","type":"string"},"schema":{"description":"The resource's associated schema, e.g. urn:ietf:params:scim:schemas:core:2.0:User","type":"string"},"meta":{"type":"object","description":"Type and location of resource type","properties":{"resourceType":{"description":"Resource's type","type":"string"},"location":{"description":"URL of resource schema of the resource, e.g. https://api.talkdeskapp.com/scim/v2/ResourceTypes/User","type":"string"}},"required":["resourceType","location"]}},"required":["id","name","description","schema","endpoint","schemas"]}},"totalResults":{"description":"The number of resources in the collection","type":"integer","minimum":0},"startIndex":{"description":"The 1-based index of the first result in the current set of list results","type":"integer","minimum":1},"itemsPerPage":{"description":"The number of resources returned in a list response page","type":"integer","minimum":1,"maximum":200}},"required":["schemas","Resources","totalResults","startIndex","itemsPerPage"]},"example":{"schemas":["urn:ietf:params:scim:api:messages:2.0:ListResponse"],"Resources":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:ResourceType"],"description":"Access User Resources","endpoint":"/scim/v2/Users","id":"User","name":"User","schema":"urn:ietf:params:scim:schemas:core:2.0:User","meta":{"resourceType":"ResourceType","location":"https://api.talkdeskapp.com/scim/v2/ResourceTypes/User"}},"totalResults":1,"startIndex":1,"itemsPerPage":1}}}},"401":{"description":"Missing or invalid Authorization","content":{"application/json":{"schema":{"description":"SCIM-related error","type":"object","properties":{"schemas":{"description":"URN Schema for Errors","type":"array","items":{"type":"string","minLength":43,"maxLength":43,"enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"status":{"description":"Http Status Code","type":"string","minLength":3,"maxLength":3},"detail":{"description":"Message detailing the error","type":"string","minLength":1},"scimType":{"description":"Type of SCIM error","type":"string","minLength":1}},"required":["schemas","status","detail"]},"examples":{"Example":{"value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"status":"401","detail":"Unauthorized"}}}}}},"403":{"description":"Forbidden operation","content":{"application/json":{"schema":{"description":"SCIM-related error","type":"object","properties":{"schemas":{"description":"URN Schema for Errors","type":"array","items":{"type":"string","minLength":43,"maxLength":43,"enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"status":{"description":"Http Status Code","type":"string","minLength":3,"maxLength":3},"detail":{"description":"Message detailing the error","type":"string","minLength":1},"scimType":{"description":"Type of SCIM error","type":"string","minLength":1}},"required":["schemas","status","detail"]},"examples":{"Example":{"value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"status":"403","detail":"Forbidden"}}}}}}},"summary":"Get Service Provider's Resource Types","tags":["SCIM"]}},"/scim/v2/ResourceTypes/User":{"get":{"description":"Check User Resource Type","operationId":"getUserResourceTypes","security":[{"GA":["scim"]}],"responses":{"200":{"description":"The request has succeeded.","content":{"application/json":{"schema":{"description":"Describes the attributes and metadata constituting a resource such as a user.","type":"object","properties":{"schemas":{"description":"Related URNs of the resource type","type":"array","items":{"type":"string"}},"description":{"description":"The resource's description, e.g. Access User Resources","type":"string"},"endpoint":{"description":"The relative endpoint to obtain the resource, e.g. /scim/v2/Users","type":"string"},"id":{"description":"The resource's id, e.g. \"User\"","type":"string"},"name":{"description":"The resource's name, e.g. \"User\"","type":"string"},"schema":{"description":"The resource's associated schema, e.g. urn:ietf:params:scim:schemas:core:2.0:User","type":"string"},"meta":{"type":"object","description":"Type and location of resource type","properties":{"resourceType":{"description":"Resource's type","type":"string"},"location":{"description":"URL of resource schema of the resource, e.g. https://api.talkdeskapp.com/scim/v2/ResourceTypes/User","type":"string"}},"required":["resourceType","location"]}},"required":["id","name","description","schema","endpoint","schemas"]},"example":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:ResourceType"],"description":"Access User Resources","endpoint":"/scim/v2/Users","id":"User","name":"User","schema":"urn:ietf:params:scim:schemas:core:2.0:User","meta":{"resourceType":"ResourceType","location":"https://api.talkdeskapp.com/scim/v2/ResourceTypes/User"}}}}},"401":{"description":"Missing or invalid Authorization","content":{"application/json":{"schema":{"description":"SCIM-related error","type":"object","properties":{"schemas":{"description":"URN Schema for Errors","type":"array","items":{"type":"string","minLength":43,"maxLength":43,"enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"status":{"description":"Http Status Code","type":"string","minLength":3,"maxLength":3},"detail":{"description":"Message detailing the error","type":"string","minLength":1},"scimType":{"description":"Type of SCIM error","type":"string","minLength":1}},"required":["schemas","status","detail"]},"examples":{"Example":{"value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"status":"401","detail":"Unauthorized"}}}}}},"403":{"description":"Forbidden operation","content":{"application/json":{"schema":{"description":"SCIM-related error","type":"object","properties":{"schemas":{"description":"URN Schema for Errors","type":"array","items":{"type":"string","minLength":43,"maxLength":43,"enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"status":{"description":"Http Status Code","type":"string","minLength":3,"maxLength":3},"detail":{"description":"Message detailing the error","type":"string","minLength":1},"scimType":{"description":"Type of SCIM error","type":"string","minLength":1}},"required":["schemas","status","detail"]},"examples":{"Example":{"value":{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"status":"403","detail":"Forbidden"}}}}}}},"summary":"Get Service Provider's User Resource Type","tags":["SCIM"]}},"/data/reports/{type}/jobs":{"get":{"description":"Gets all jobs from a report type","security":[{"GA":["data-reports:read"]}],"parameters":[{"name":"type","in":"path","description":"The report type id","required":true,"schema":{"type":"string","enum":["studio_flow_execution","ring_attempts","contacts","outbound_dialer_calls","qm_evaluation_score","inbound_contact_volume","talk_time_data","hold_time_data","acw_time_data","contact_online_time","csat_score","user_status","calls","explore_calls","qm_interaction_details","qm_evaluation_analysis","feedback","adherence","messaging_contacts","messaging_traffic","wfm_dce_queues","wfm_dce_history","audit_logs","timeseries_history_reports","timeseries_report","erc_omnichannel_report","insurance_omnichannel_report","banking_omnichannel_report","wfm_team_schedule_report","wfm_team_schedule_report_for_internal","wfm_contact_history_report_v2","wfm_dce_history_v3","advanced_dialer_calls_report","va_conversation_markers","case_sla_events","patient_interaction_report"]}},{"name":"page","in":"query","description":"The page number to request. Starts at 1, defaults to 1 when not provided.","required":false,"schema":{"default":1,"minimum":1,"maximum":2147483647,"type":"integer"}},{"name":"per_page","in":"query","description":"The maximum amount of items per page. Defaults to 20 when not provided.","required":false,"schema":{"default":20,"minimum":1,"maximum":200,"type":"integer"}}],"tags":["Explore"],"responses":{"200":{"description":"An array of jobs","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"type":"integer"},"count":{"type":"integer"},"_embedded":{"type":"object","properties":{"jobs":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The job id"},"name":{"type":"string","description":"Report's name"},"timezone":{"type":"string","description":"Timezone in IANA format which the report timespan (from and to) will be applied"},"status":{"type":"string","description":"Report status indicating the workflow progress","enum":["created","processing","uploading","done","failed","canceled","deleted"]},"format":{"type":"string","description":"Format in which the report file will be created","enum":["csv","json","json_bulk"]},"timespan":{"type":"object","description":"Time range to filter for the report content","properties":{"from":{"type":"string","format":"date-time","description":"Start datetime filter for the records to be retrieved from the report"},"to":{"type":"string","format":"date-time","description":"End datetime filter for the records to be retrieved from the report"}}},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","default":"http://api-docs.talkdesk.org/data/reports/:type/jobs/:id"}}},"files":{"type":"object","properties":{"href":{"type":"string","default":"http://api-docs.talkdesk.org/data/reports/:type/files/:id"}}}}}}}}}},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","properties":{"href":{"type":"string"}}},"next":{"type":"object","properties":{"href":{"type":"string"}}},"prev":{"type":"object","properties":{"href":{"type":"string"}}}}}}},"example":{"total":2,"count":2,"_embdedded":{"jobs":[{"id":"dc5f5339-a45f-428e-8b31-0b79269da60b","name":"my report number 1","status":"canceled","format":"csv","timespan":{"from":"2010-01-01T22:13:12Z","to":"2016-05-01T22:13:12Z"},"_links":{"self":{"href":"http://api-docs.talkdesk.org/data/reports/studio_flow_execution/jobs/dc5f5339-a45f-428e-8b31-0b79269da60b"},"files":{"href":"http://api-docs.talkdesk.org/data/reports/studio_flow_execution/files/dc5f5339-a45f-428e-8b31-0b79269da60b"}}},{"id":"ab967ad7-15df-49e6-8680-f3f1aa6356e2","name":"my report number 2","status":"done","format":"csv","timespan":{"from":"2010-01-01T22:13:12Z","to":"2016-05-01T22:13:12Z"},"_links":{"self":{"href":"http://api-docs.talkdesk.org/data/reports/studio_flow_execution/jobs/ab967ad7-15df-49e6-8680-f3f1aa6356e2"},"files":{"href":"http://api-docs.talkdesk.org/data/reports/studio_flow_execution/files/ab967ad7-15df-49e6-8680-f3f1aa6356e2"}}}]},"_links":{"self":{"href":"http://api-docs.talkdesk.org/data/reports/studio_flow_execution/jobs"},"next":{"href":"http://api-docs.talkdesk.org/data/reports/studio_flow_execution/jobs?page=2"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Example 1":{"value":{"code":"1020001","message":"Input parameters validation failed","fields":[{"name":"report_type","description":"report_type does not have a valid value"}]}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1020018","message":"Unauthorized","description":"The provided authorization is not valid."}}}},"403":{"description":"Inputs Misconfiguration","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1020004","message":"Provided scopes do not allow access to the requested resource"}}}},"503":{"description":"Unable to audit operation","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1020019","message":"Unable to audit operation","description":"The audit service could not audit the operation."}}}}}},"post":{"description":"Creates a new report job","security":[{"GA":["data-reports:write"]}],"parameters":[{"name":"type","in":"path","description":"The report type id","required":true,"schema":{"type":"string","default":"studio_flow_execution","enum":["studio_flow_execution","ring_attempts","contacts","outbound_dialer_calls","qm_evaluation_score","inbound_contact_volume","talk_time_data","hold_time_data","acw_time_data","contact_online_time","csat_score","user_status","calls","explore_calls","qm_interaction_details","qm_evaluation_analysis","feedback","adherence","messaging_contacts","messaging_traffic","wfm_dce_queues","wfm_dce_history","audit_logs","timeseries_history_reports","timeseries_report","erc_omnichannel_report","insurance_omnichannel_report","banking_omnichannel_report","wfm_team_schedule_report","wfm_contact_history_report_v2","wfm_dce_history_v3","advanced_dialer_calls_report","va_conversation_markers","case_sla_events","patient_interaction_report"]}}],"tags":["Explore"],"requestBody":{"description":"The body of the request","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Report's name"},"timezone":{"type":"string","description":"Timezone in IANA format which the report timespan (from and to) will be applied"},"format":{"type":"string","default":"csv","description":"Format in which the report file will be created","enum":["csv","json","json_bulk"]},"timespan":{"type":"object","description":"Time range to filter for the report content","properties":{"from":{"type":"string","description":"Start datetime filter for the records to be retrieved from the report","format":"date-time"},"to":{"type":"string","description":"End datetime filter for the records to be retrieved from the report","format":"date-time"}}}}}}}},"responses":{"202":{"description":"Job accepted","content":{"application/json":{"schema":{"example":{"job":{"id":"c65186ee-3780-468e-968b-ca15b981c312","name":"my_report_number_1","status":"created","timezone":"UTC","format":"csv","timespan":{"from":"2016-09-01T21:47:45.867Z","to":"2016-09-01T21:47:45.867Z"}},"_links":{"self":{"href":"http://api-docs.talkdesk.org/data/reports/studio_flow_execution/jobs/c65186ee-3780-468e-968b-ca15b981c312"},"files":{"href":"http://api-docs.talkdesk.org/data/reports/studio_flow_execution/files/c65186ee-3780-468e-968b-ca15b981c312"}}},"type":"object","properties":{"id":{"type":"string","description":"The job id"},"name":{"type":"string","description":"Report's name"},"timezone":{"type":"string","description":"Timezone in IANA format which the report timespan (from and to) will be applied"},"status":{"type":"string","description":"Report status indicating the workflow progress","enum":["created","processing","uploading","done","failed","canceled","deleted"]},"format":{"type":"string","description":"Format in which the report file will be created","enum":["csv","json","json_bulk"]},"timespan":{"type":"object","description":"Time range to filter for the report content","properties":{"from":{"type":"string","format":"date-time","description":"Start datetime filter for the records to be retrieved from the report"},"to":{"type":"string","format":"date-time","description":"End datetime filter for the records to be retrieved from the report"}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Example 1":{"value":{"code":"1020001","message":"input parameters validation failed","fields":[{"name":"timespan[from]","description":"timespan[from] format is not supported"},{"name":"timespan[to]","description":"timespan[to] format is not supported"}]}},"Example 2":{"value":{"code":"1020005","message":"Timespan lower boundary must be older than upper boundary"}},"Example 3":{"value":{"code":"1020013","message":"Requested report time span too long"}},"Example 4":{"value":{"code":"1020016","message":"Invalid timezone received"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1020018","message":"Unauthorized","description":"The provided authorization is not valid."}}}},"403":{"description":"Inputs Misconfiguration","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1020004","message":"Provided scopes do not allow access to the requested resource"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1020017","message":"Reached the maximum of account-based quota of 15 simultaneous reports","description":"The account is using all of it's available quota."}}}},"503":{"description":"Unable to audit operation","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1020019","message":"Unable to audit operation","description":"The audit service could not audit the operation."}}}}}}},"/data/reports/{type}/jobs/{id}":{"get":{"description":"Get job report execution details","security":[{"GA":["data-reports:read"]}],"parameters":[{"name":"type","in":"path","description":"The report type id","required":true,"schema":{"type":"string","enum":["studio_flow_execution","ring_attempts","contacts","outbound_dialer_calls","qm_evaluation_score","inbound_contact_volume","talk_time_data","hold_time_data","acw_time_data","contact_online_time","csat_score","user_status","calls","explore_calls","qm_interaction_details","qm_evaluation_analysis","feedback","adherence","messaging_contacts","messaging_traffic","wfm_dce_queues","wfm_dce_history","audit_logs","timeseries_history_reports","timeseries_report","erc_omnichannel_report","insurance_omnichannel_report","banking_omnichannel_report","wfm_team_schedule_report","wfm_team_schedule_report_for_internal","wfm_contact_history_report_v2","wfm_dce_history_v3","advanced_dialer_calls_report","va_conversation_markers","case_sla_events","patient_interaction_report"]}},{"name":"id","in":"path","description":"The job id","required":true,"schema":{"type":"string"}}],"tags":["Explore"],"responses":{"200":{"description":"Report job execution result","content":{"application/json":{"schema":{"example":{"job":{"id":"c65186ee-3780-468e-968b-ca15b981c312","name":"my_report_number_1","status":"created","timezone":"UTC","format":"csv","timespan":{"from":"2016-09-01T21:47:45.867Z","to":"2016-09-01T21:47:45.867Z"}},"_links":{"self":{"href":"http://api-docs.talkdesk.org/data/reports/studio_flow_execution/jobs/c65186ee-3780-468e-968b-ca15b981c312"},"files":{"href":"http://api-docs.talkdesk.org/data/reports/studio_flow_execution/files/c65186ee-3780-468e-968b-ca15b981c312"}}},"type":"object","properties":{"job":{"type":"object","properties":{"id":{"type":"string","description":"The job id"},"name":{"type":"string","description":"Report's name"},"timezone":{"type":"string","description":"Timezone in IANA format which the report timespan (from and to) will be applied"},"status":{"type":"string","description":"Report status indicating the workflow progress","enum":["created","processing","uploading","done","failed","canceled","deleted"]},"format":{"type":"string","description":"Format in which the report file will be created","enum":["csv","json","json_bulk"]},"timespan":{"type":"object","description":"Time range to filter for the report content","properties":{"from":{"type":"string","format":"date-time","description":"Start datetime filter for the records to be retrieved from the report"},"to":{"type":"string","format":"date-time","description":"End datetime filter for the records to be retrieved from the report"}}}}},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","default":"http://api-docs.talkdesk.org/data/reports/:type/jobs/:id"}}},"files":{"type":"object","properties":{"href":{"type":"string","default":"http://api-docs.talkdesk.org/data/reports/:type/files/:id"}}}}}}}}}},"303":{"description":"Report job execution result location","headers":{"Location":{"description":"The job results location","schema":{"type":"string","default":"/data/reports/{type}/files/{id}"}}},"content":{"application/json":{"schema":{"example":{"job":{"id":"c65186ee-3780-468e-968b-ca15b981c312","name":"my_report_number_1","status":"created","timezone":"UTC","format":"csv","timespan":{"from":"2016-09-01T21:47:45.867Z","to":"2016-09-01T21:47:45.867Z"}},"_links":{"self":{"href":"http://api-docs.talkdesk.org/data/reports/studio_flow_execution/jobs/c65186ee-3780-468e-968b-ca15b981c312"},"files":{"href":"http://api-docs.talkdesk.org/data/reports/studio_flow_execution/files/c65186ee-3780-468e-968b-ca15b981c312"}}},"type":"object","properties":{"job":{"type":"object","properties":{"id":{"type":"string","description":"The job id"},"name":{"type":"string","description":"Report's name"},"timezone":{"type":"string","description":"Timezone in IANA format which the report timespan (from and to) will be applied"},"status":{"type":"string","description":"Report status indicating the workflow progress","enum":["created","processing","uploading","done","failed","canceled","deleted"]},"format":{"type":"string","description":"Format in which the report file will be created","enum":["csv","json","json_bulk"]},"timespan":{"type":"object","description":"Time range to filter for the report content","properties":{"from":{"type":"string","format":"date-time","description":"Start datetime filter for the records to be retrieved from the report"},"to":{"type":"string","format":"date-time","description":"End datetime filter for the records to be retrieved from the report"}}}}},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","default":"http://api-docs.talkdesk.org/data/reports/:type/jobs/:id"}}},"files":{"type":"object","properties":{"href":{"type":"string","default":"http://api-docs.talkdesk.org/data/reports/:type/files/:id"}}}}}}}}}},"400":{"description":"Report type is invalid","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1020001","message":"Input parameters validation failed","fields":[{"name":"report_type","description":"report_type does not have a valid value"}]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1020018","message":"Unauthorized","description":"The provided authorization is not valid."}}}},"403":{"description":"Inputs Misconfiguration","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1020004","message":"Provided scopes do not allow access to the requested resource"}}}},"404":{"description":"Report job not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1020011","message":"Report execution not found"}}}},"503":{"description":"Unable to audit operation","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1020019","message":"Unable to audit operation","description":"The audit service could not audit the operation."}}}}}}},"/data/reports/{type}/files/{id}":{"get":{"description":"Get job report execution result","security":[{"GA":["data-reports:read"]}],"parameters":[{"name":"type","in":"path","description":"The report type","required":true,"schema":{"type":"string","enum":["studio_flow_execution","ring_attempts","contacts","outbound_dialer_calls","qm_evaluation_score","inbound_contact_volume","talk_time_data","hold_time_data","acw_time_data","contact_online_time","csat_score","user_status","calls","qm_interaction_details","qm_evaluation_analysis","feedback","adherence","messaging_contacts","messaging_traffic","wfm_dce_queues","wfm_dce_history","audit_logs","timeseries_history_reports","timeseries_report","erc_omnichannel_report","insurance_omnichannel_report","banking_omnichannel_report","wfm_team_schedule_report","wfm_team_schedule_report_for_internal","wfm_contact_history_report_v2","wfm_dce_history_v3","advanced_dialer_calls_report","va_conversation_markers","case_sla_events","patient_interaction_report"]}},{"name":"id","in":"path","description":"The job id","required":true,"schema":{"type":"string"}}],"tags":["Explore"],"responses":{"302":{"description":"Data report job execution result location with target format file containing entries information","headers":{"Location":{"description":"The job results location","schema":{"type":"string","default":"https://s3.amazonaws.com/td-sandbox-public-api-mock/calls.json"}}},"content":{"application/json":{"schema":{"type":"object","discriminator":{"propertyName":"grant_type"},"properties":{"total":{"type":"number"},"type":{"type":"string"}}}}}},"400":{"description":"Report type is invalid","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1020001","message":"Input parameters validation failed","fields":[{"name":"report_type","description":"report_type does not have a valid value"}]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1020018","message":"Unauthorized","description":"The provided authorization is not valid."}}}},"403":{"description":"Inputs Misconfiguration","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1020004","message":"Provided scopes do not allow access to the requested resource"}}}},"404":{"description":"Report file not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1020008","message":"Report file not found"}}}},"503":{"description":"Unable to audit operation","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1020019","message":"Unable to audit operation","description":"The audit service could not audit the operation."}}}}}},"delete":{"description":"Delete a report","security":[{"GA":["data-reports:write"]}],"parameters":[{"name":"type","in":"path","description":"The report type","required":true,"schema":{"type":"string","enum":["studio_flow_execution","messaging_contacts","messaging_traffic"]}},{"name":"id","in":"path","description":"The job id","required":true,"schema":{"type":"string"}}],"tags":["Explore"],"responses":{"204":{"description":"Report deleted"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1020018","message":"Unauthorized","description":"The provided authorization is not valid."}}}},"403":{"description":"Inputs Misconfiguration","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1020004","message":"Provided scopes do not allow access to the requested resource"}}}},"404":{"description":"Report not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Example 1":{"value":{"code":"1020011","message":"Report execution not found"}},"Example 2":{"value":{"code":"1020009","message":"Report file not found"}}}}}},"409":{"description":"Report not ready for deletion","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1020007","message":"Operation not allowed due to the current job status"}}}},"503":{"description":"Unable to audit operation","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1020019","message":"Unable to audit operation","description":"The audit service could not audit the operation."}}}}}}},"/industries/events/subscriptions":{"post":{"tags":["Industries Events"],"summary":"Creates a new event subscription","security":[{"EarlyAccess":["industries-event-subscriptions:write"]}],"requestBody":{"required":true,"content":{"application/json":{"example":{"event_key":"healthcare.phonesystem.call-recording.action","webhook_uri":"http://localhost:8080/callRecordingCB","callback_data":"CALLBACK_DATA"},"schema":{"type":"object","required":["event_key","webhook_uri"],"properties":{"event_key":{"type":"string","description":"The id of the event to be subscribed"},"webhook_uri":{"type":"string","description":"The callback uri"},"callback_data":{"type":"string","description":"Data to be posted on a call to the endpoint specified on webhook_uri"}}}}}},"responses":{"201":{"description":"Subscription created","content":{"application/json":{"example":{"id":"2a02e7aa181f4f418423b80930cc8436","account_id":"60191179089d410201e8ab42","event_key":"healthcare.phonesystem.call-recording.action","webhook_uri":"http://localhost:8080/callRecordingCB","callback_data":"CALLBACK_DATA","_links":{"self":{"href":"https://api.talkdesk.org//industries/events/subscriptions/2a02e7aa181f4f418423b80930cc8436"}}},"schema":{"type":"object","required":["id","account_id","event_key","webhook_uri"],"properties":{"id":{"type":"string","description":"The subscription unique identifier"},"account_id":{"type":"string","description":"The account id"},"event_key":{"type":"string","description":"The event id"},"webhook_uri":{"type":"string","description":"The callback uri"},"callback_data":{"type":"string","description":"Data to be posted on a call to the endpoint specified on webhook_uri"},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1570001","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1570002","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1570003","message":"Required scopes are missing."}}}}}}},"/industries/events/subscriptions/{id}":{"get":{"tags":["Industries Events"],"summary":"Provides subscription information","operationId":"industriesEventsGetSubscription","security":[{"EarlyAccess":["industries-event-subscriptions:read"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"id":"2a02e7aa181f4f418423b80930cc8436","account_id":"60191179089d410201e8ab42","event_key":"healthcare.phonesystem.call-recording.action","webhook_uri":"http://localhost:8080/callRecordingCB","callback_data":"CALLBACK_DATA","_links":{"self":{"href":"https://api.talkdesk.org//industries/events/subscriptions/2a02e7aa181f4f418423b80930cc8436"}}},"schema":{"type":"object","required":["id","account_id","event_key","webhook_uri"],"properties":{"id":{"type":"string","description":"The subscription unique identifier"},"account_id":{"type":"string","description":"The account id"},"event_key":{"type":"string","description":"The event id"},"webhook_uri":{"type":"string","description":"The callback uri"},"callback_data":{"type":"string","description":"Data to be posted on a call to the endpoint specified on webhook_uri"},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}}}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1570002","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1570003","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1570003","message":"Required scopes are missing."}}}}}},"delete":{"tags":["Industries Events"],"summary":"Deletes the subscription","operationId":"deleteSubscription","security":[{"EarlyAccess":["industries-event-subscriptions:write"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1570002","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1570003","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1570003","message":"Required scopes are missing."}}}}}}},"/fsi/contacts/{contact_id}/accounts":{"get":{"tags":["FSI Accounts"],"summary":"Returns contact accounts list","description":"The endpoint allows you to retrieve the accounts associated with a specific contact.\nBy providing the unique contact ID as a path parameter, this endpoint enables you to fetch the financial or membership accounts linked to the contact.\n","security":[{"GA":["fsi-accounts:read"]}],"parameters":[{"in":"path","name":"contact_id","schema":{"type":"string"},"required":true,"description":"The contact id"},{"in":"query","name":"skip","description":"The number of elements to skip in accounts collection","schema":{"type":"integer","minimum":0,"maximum":2147483647,"default":0}},{"in":"query","name":"limit","description":"The maximum number of elements in accounts collection","schema":{"type":"integer","minimum":1,"maximum":500,"default":20}},{"in":"query","name":"interaction_id","schema":{"type":"string"},"required":false,"description":"The interaction id"}],"responses":{"200":{"description":"The accounts list.","content":{"application/json":{"schema":{"type":"object","description":"Offset based pagination for accounts","required":["_embedded","total"],"properties":{"_embedded":{"type":"object","required":["accounts"],"properties":{"accounts":{"description":"List of accounts","type":"array","items":{"type":"object","required":["id","description","currency_code","balance","available_balance","account_type","status","parties"],"properties":{"id":{"type":"string","description":"Identification for an account"},"description":{"type":"string","description":"Description of the account"},"account_number":{"type":"string","description":"Account number associated"},"currency_code":{"type":"string","description":"Currency used in this account using ISO 4217 standard","minLength":3,"maxLength":3},"iban":{"type":"string","description":"IBAN number associated to this account","maxLength":34},"financial_institution_name":{"type":"string","description":"Financial institution name"},"swift_code":{"type":"string","description":"SWIFT code associated to this account","minLength":8,"maxLength":11},"account_name":{"type":"string","description":"Name provided by the account owner (nickname)"},"account_type":{"type":"string","description":"Account type","enum":["DEBIT","UNDEFINED","SAVINGS","CHECKING","CERTIFICATE_OF_DEPOSIT","STUDENT","MORTGAGE_LOAN","HOME_EQUITY_LOAN","AUTO_LOAN","PERSONAL_LOAN","BUSINESS_LOAN","STUDENT_LOAN","CREDIT_CARD","CREDIT","BUSINESS_CREDIT_CARD","STUDENT_CREDIT_CARD","PERSONAL_CREDIT_CARD","OTHER"]},"parties":{"description":"List of parties. A party is a person or company associated with the account.","type":"array","items":{"type":"object","required":["contact_id","role"],"description":"Party identity information","properties":{"contact_id":{"type":"string","description":"Identifier for a contact"},"role":{"type":"string","description":"Type of role associated with a party member","enum":["HOLDER","AUTHORIZED_PARTY","OTHER","UNKNOWN","JOINT","PRIMARY","SECONDARY"]},"custom_role":{"type":"string","description":"Account's customized party by bank client"},"transfer_permission":{"type":"boolean","description":"Indicates if the party has permission to transfer funds"}}},"minItems":0},"update_at":{"type":"string","format":"date"},"open_date":{"type":"string","format":"date","description":"Account's created date"},"close_date":{"type":"string","format":"date","description":"Account's closed date"},"balance":{"type":"string","description":"Account's booked balance. For loans this field will be equal to \"Current Principal Balance\""},"available_balance":{"type":"string","description":"Account's available balance"},"status":{"type":"string","description":"Account type","enum":["ACTIVE","INACTIVE","OPEN","CLOSED","CHARGE_OFF","FROZEN"]},"custom_type":{"type":"string","description":"Account's customized type by bank client"},"custom_status":{"type":"string","description":"Account's customized status by bank client"},"custom_fields":{"description":"Custom fields list. It allows the core the retrieve custom data for each FSI account.","items":{"type":"object","required":["key"],"properties":{"key":{"type":"string","description":"custom field name"},"value":{"type":"string","description":"custom field value"}}}},"loan_number":{"type":"string","description":"The loan number"},"interest_details":{"type":"object","properties":{"interest_rate":{"type":"string","description":"The interest rate"},"interest_rate_type":{"type":"string","description":"Interest rate type","enum":["FIXED","VARIABLE","ANNUAL_PERCENTAGE","PRIME","DISCOUNTED","SIMPLE","COMPOUND"]},"last_interest_paid":{"type":"string","description":"Last interest paid"},"last_interest_paid_date":{"type":"string","format":"date","description":"Last interest paid date","example":"2021-06-16"},"ytd_interest_paid":{"type":"string","description":"Current ytd interest paid"},"previous_year_interest_paid":{"type":"string","description":"Previous year interest paid"}}},"previous_year_taxes_paid":{"type":"string","description":"One value expected with the sum of all year taxes paid"},"last_statement_date":{"type":"string","format":"date","description":"Last statement date","example":"2021-06-16"},"credit_limit":{"type":"string","description":"Credit limit"},"statement_balance":{"type":"string","description":"Statement balance"},"next_closing_date":{"type":"string","format":"date","description":"Next closing date","example":"2021-06-16"},"periodic_frequency":{"type":"string","description":"Periodic Frequency"},"purchase_apr":{"type":"string","description":"Purchase APR"},"cash_advance_apr":{"type":"string","description":"Cash advance APR"},"balance_transfer_apr":{"type":"string","description":"Balance transfer APR"},"term":{"type":"string","description":"The term"},"loan_start_date":{"type":"string","format":"date","description":"Loan start date","example":"2021-06-16"},"maturity_date":{"type":"string","format":"date","description":"Maturity date","example":"2021-06-16"},"loan_amount":{"type":"string","description":"Contracted loan amount"},"property_address":{"type":"string","description":"The property address"},"automatic_payment":{"type":"boolean","description":"Automatic payment"},"automatic_payment_date":{"type":"string","format":"date","description":"Automatic payment date","example":"2021-06-16"},"monthly_loan_payment_details":{"type":"object","properties":{"monthly_loan_payment":{"type":"string","description":"Monthly loan payment"},"principal_payment":{"type":"string","description":"Principal payment (detail amount of monthly_loan_payment)"},"interest_payment":{"type":"string","description":"Interest payment (detail amount of monthly_loan_payment)"},"monthly_escrow_payment":{"type":"string","description":"Monthly escrow payment (detail amount of monthly_loan_payment)"},"fee":{"type":"string","description":"Fee payment (detail amount of monthly_loan_payment)"}}},"account_routing_number":{"type":"string","description":"The MICR routing number consists of 9 digits (XXXXYYYYC) where XXXX is Federal Reserve Routing Symbol, YYYY is ABA Institution Identifier, and C is the check digit."},"transfer_authorization":{"type":"string","description":"Transfer Authorization. INQUIRY means transfers and withdrawals not allowed; TRANSFERS means allowed transfers depending on transferRules; TRANSFERS_AND_WITHDRAWALS means allowed transfers depending on transferRules, and withdrawals to be made from the account.","enum":["INQUIRY","TRANSFERS","TRANSFERS_AND_WITHDRAWALS"]},"transfer_rules":{"description":"Transfer Rules","type":"object","properties":{"transfer_in":{"type":"boolean","description":"Active when the account has permission to receive money from other accounts."},"transfer_out_own_accounts":{"type":"boolean","description":"Active when the account has permission to send money between own accounts."},"transfer_out_others":{"type":"boolean","description":"Active when the account has permission to send money to other accounts of the same bank."},"transfer_out_external":{"type":"boolean","description":"Active when the account has permission to send money to other accounts of a different bank."},"transfer_out_international":{"type":"boolean","description":"Active when the account has permission to send money to international accounts."},"withdrawals_by_check":{"type":"boolean","description":"Active then allows withdrawals from the account by check."}}}}}}}},"total":{"type":"integer","description":"Total number of accounts in the collection","minimum":0,"default":0}}},"example":{"_embedded":{"accounts":[{"id":"account_id_1234546","account_number":"1234-124-1","currency_code":"EUR","description":"PRIMARY SHARE,","iban":"LU280019400644750000","financial_institution_name":"King Julian Bank","swift_code":"KIJBLULU","account_name":"My Personal Account","account_type":"CHECKING","parties":[{"contact_id":"AC12334543","role":"HOLDER","custom_role":"OTHER_ROLE"}],"update_at":"2021-04-13","open_date":"1969-05-28","balance":"257.87","available_balance":"10234.87","status":"ACTIVE","custom_type":"Other type","custom_status":"Other status","custom_fields":[{"name":"custom field 1","value":"custom value 1"}],"loan_number":"Loan number","interest_details":{"interest_rate":"interestRate","interest_rate_type":"VARIABLE","last_interest_paid":"lastInterestPaid","last_interest_paid_date":"2021-04-13","ytd_interest_paid":"ytdInterestPaid","previous_year_interest_paid":"previousYearInterestPaid"},"previous_year_taxes_paid":"previousYearTaxesPaid","last_statement_date":"2021-04-13","credit_limit":"creditLimit","statement_balance":"statementBalance","next_closing_date":"2021-04-13","periodic_frequency":"periodicFrequency","purchase_apr":"purchaseApr","cash_advance_apr":"cashAdvanceApr","balance_transfer_apr":"balanceTransferApr","term":"term","loan_start_date":"2021-5-11","maturity_date":"2021-5-11","loan_amount":"loanAmount","property_address":"propertyAddress","automatic_payment":true,"automatic_payment_date":"2021-5-11","monthly_loan_payment_details":{"monthly_loan_payment":"monthlyLoanPayment","principal_payment":"principalPayment","interest_payment":"interestPayment","monthly_escrow_payment":"monthlyEscrowPayment","fee":"fee"},"account_routing_number":"accountRoutingNumber","transfer_authorization":"INQUIRY","transfer_rules":{"transferIn":false,"transfer_out_own_accounts":false,"transfer_out_others":false,"transfer_out_external":false,"transfer_out_international":false,"withdrawals_by_check":false}}]},"total":1}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490000","message":"Bad request.","fields":[{"name":"skip","description":"skip parameter not in a valid range."},{"name":"limit","description":"limit parameter not in a valid range."}]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490001","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490002","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490003","message":"Resource not found."}}}}}}},"/fsi/contacts/{contact_id}/accounts/{account_id}/payoff":{"post":{"tags":["FSI Payoff"],"summary":"Calculate payoff","description":"Returns the payoff calculation for an FSI account based on a provided future date","security":[{"GA":["fsi-payoff:read"]}],"parameters":[{"in":"path","name":"contact_id","schema":{"type":"string","minLength":1,"maxLength":255},"required":true,"description":"The contact id"},{"in":"path","name":"account_id","schema":{"type":"string","minLength":1,"maxLength":255},"required":true,"description":"The account id"},{"in":"query","name":"interaction_id","schema":{"type":"string","minLength":0,"maxLength":255},"required":false,"description":"The interaction id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["payoff_date"],"properties":{"payoff_date":{"description":"The date for which the payoff must be calculated","type":"string","format":"date","minLength":0,"maxLength":10}}},"example":{"payoff_date":"2024-10-24"}}}},"responses":{"200":{"description":"The payoff calculation response.","content":{"application/json":{"schema":{"type":"object","required":["payoff_amount"],"properties":{"daily_per_diem":{"description":"The per diem value","type":"string"},"payoff_amount":{"description":"The payoff amount calculated by the core","type":"string"},"payoff_amount_details":{"type":"object","properties":{"principal_payment":{"description":"The principal payment of the payoff amount","type":"string"},"interest_payment":{"description":"The interest payment of the payoff amount","type":"string"},"monthly_escrow_payment":{"description":"The monthly escrow payment of the payoff amount","type":"string"},"fee":{"description":"The fee payment of the payoff amount","type":"string"}}},"custom_fields":{"description":"Custom fields associated with the entity.","type":"array","items":{"type":"object","required":["key"],"properties":{"key":{"type":"string","description":"custom field name","minLength":0,"maxLength":255},"value":{"type":"string","description":"custom field value","minLength":0,"maxLength":255}}}}}},"example":{"daily_per_diem":"250","payoff_amount":"2500.50","payoff_amount_details":{"principal_payment":"1500","interest_payment":"450.25","monthly_escrow_payment":"50","fee":"25"},"custom_fields":[{"key":"additional_info","value":"Some extra details about the payoff"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Default":{"value":{"code":"1490000","message":"Bad request."}},"Pagination":{"value":{"code":"1490000","message":"Bad request.","fields":[{"name":"skip","description":"skip parameter not in a valid range."},{"name":"limit","description":"limit parameter not in a valid range."}]}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490001","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490002","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490003","message":"Resource not found."}}}}}}},"/fsi/contacts":{"get":{"tags":["FSI Contacts"],"summary":"Returns one or more contacts matching the given criteria.","security":[{"GA":["fsi-contacts:read"]}],"parameters":[{"in":"query","name":"skip","description":"The number of elements to skip in contacts collection","schema":{"type":"integer","minimum":0,"maximum":2147483647,"default":0}},{"in":"query","name":"limit","description":"The maximum number of elements in contacts collection","schema":{"type":"integer","minimum":1,"maximum":500,"default":20}},{"in":"query","name":"member_id","description":"The contact member_id. Include only contacts whose member_id matches the criteria.","required":false,"schema":{"type":"string"}},{"in":"query","name":"first_name","description":"The contact first name. Include only contacts whose name matches the criteria.","required":false,"schema":{"type":"string"}},{"in":"query","name":"last_name","description":"The contact last name. Include only contacts whose name ends with the criteria.","required":false,"schema":{"type":"string"}},{"in":"query","name":"birthdate","description":"The contact birthdate. Include only contacts whose birthdate matches the criteria.","required":false,"schema":{"type":"string"}},{"in":"query","name":"phone_number","description":"The contact phone number. Include only contacts whose phone number (HOME, MOBILE or other) matches the criteria.","required":false,"schema":{"type":"string"}},{"in":"query","name":"internet_banking_login_id","description":"The contact internet banking login identifier. Include only contacts whose internet banking login identifier matches the criteria.","required":false,"schema":{"type":"string"}},{"in":"query","name":"account_number","description":"The number of an account. Include only contacts which contain an account whose number matches the criteria.","required":false,"schema":{"type":"string"}},{"in":"query","name":"card_number","description":"The number of a card. Include only contacts which contain a card whose number matches the criteria.","required":false,"schema":{"type":"string"}},{"in":"query","name":"card_number_partial","description":"The last digits of a card number. Include all the contacts which contain cards whose numbers end with the criteria.","required":false,"schema":{"type":"string"}},{"in":"query","name":"ssn","description":"The contact social security number. Include only contacts whose social security number matches the criteria.","required":false,"schema":{"type":"string"}},{"in":"query","name":"ssn_partial","description":"The last digits of a social security number. Include only contacts which have a social security number ending with the criteria.","required":false,"schema":{"type":"string"}},{"in":"query","name":"custom_fields","required":false,"description":"Query based on custom fields, please note that this field is a JSON string that needs to be escaped. For example {\"eag\":\"3322\"} -> %7B%22eag%22:%223322%22%7D","schema":{"type":"string"}},{"in":"query","name":"interaction_id","schema":{"type":"string"},"required":false,"description":"The interaction id"}],"responses":{"200":{"description":"The list of contacts.","content":{"application/json":{"schema":{"type":"object","description":"Offset based pagination for contacts","required":["_embedded","total"],"properties":{"total":{"description":"The total number of contacts in the collection.","type":"integer","minimum":0,"default":0},"_embedded":{"type":"object","required":["contacts"],"properties":{"contacts":{"description":"List of contacts","type":"array","items":{"type":"object","required":["id","member_id","name","contacts","addresses","_links"],"properties":{"id":{"type":"string","description":"The contact id from the extenal fsi institution\n(id which SHOULD BE USEED as the identified of the contact, to get its accounts, cards, payments and transactions).\n"},"member_id":{"type":"string","description":"An identifier of the contact in the extenal fsi institution,\nfor some cores it can be SOCIAL_SECURITY, or other contact property, or even equal to the id.\n(DO NOT USE this property as the contact identifier to get its accounts, cards, payments and transactions)\n"},"name":{"type":"string","description":"Contact name"},"contacts":{"type":"array","items":{"type":"object","required":["id","type","value","use","rank"],"properties":{"id":{"type":"string","description":"Identification for contact point"},"type":{"type":"string","description":"Define the type for this contact point","enum":["PHONE","EMAIL","SMS","OTHER"]},"value":{"type":"string","description":"The actual contact point details"},"use":{"type":"string","description":"Purpose of this contact point","enum":["HOME","WORK","MOBILE","TEMPORARY","OLD"]},"rank":{"description":"Specify preferred order of use (0 = highest)","type":"integer","minimum":0}}}},"addresses":{"type":"array","items":{"type":"object","required":["id","type","street","city","district","state","postal_code","country"],"properties":{"id":{"type":"string","description":"Identification for the address"},"type":{"type":"string","description":"Address type","enum":["POSTAL","PHYSICAL","BOTH"]},"street":{"type":"string","description":"Street name address (can be Street, Avenue, Square, etc.)"},"city":{"type":"string","description":"Name of city, town etc."},"district":{"type":"string","description":"District name (aka county)"},"state":{"type":"string","description":"Sub-unit of country (abbreviations ok)"},"postal_code":{"type":"string"},"country":{"type":"string","description":"Country (e.g. can be ISO 3166 2 or 3 letter code)"}}}},"id_document_number":{"type":"string","description":"Document number associated to a person"},"id_document_type":{"type":"string","enum":["SOCIAL_SECURITY","DRIVERS_LICENSE","PASSPORT","NATIONAL_ID","OTHER"]},"birth_date":{"type":"string","format":"date"},"vip_client":{"type":"boolean","description":"Indicates if the contact is sensitive and some of his data should be hidden from agents"},"custom_fields":{"type":"array","description":"Custom fields list. It allows the core the retrieve custom data for each FSI contact.","items":{"type":"object","required":["key"],"properties":{"key":{"type":"string","description":"custom field name"},"value":{"type":"string","description":"custom field value"}}},"example":[{"key":"Job","value":"Engineer"},{"key":"Nationality","value":"American"}]},"id_documents":{"description":"ID Documents associated to a person. The array is ordered as follows (from top to bottom), first SOCIAL_SECURITY, then DRIVERS_LICENSE, then PASSPORT, then NATIONAL_ID and finally OTHER.","type":"array","items":{"description":"ID Documents associated to a person","type":"object","required":["type"],"properties":{"number":{"type":"string","description":"Document number associated to a person"},"type":{"type":"string","enum":["SOCIAL_SECURITY","DRIVERS_LICENSE","PASSPORT","NATIONAL_ID","OTHER"]}}}},"membership_date":{"type":"string","format":"date","description":"Date on that client became a member/client"},"_links":{"description":"Self link item for HAL","properties":{"self":{"description":"Link of the current page","type":"object","properties":{"href":{"description":"Address of the resource","type":"string"}}}},"required":["self"],"type":"object"}}}},"redacted_fields":{"description":"list of fields in the response which are redacted. Each element is the full path access in the response of the redacted field.","type":"array","items":{"type":"string"}}}}}},"example":{"total":1,"_embedded":{"contacts":[{"id":"0120343","member_id":"AC12334543","name":"John Doe","contacts":[{"id":"123456","type":"PHONE","value":"9919552453","use":"HOME","rank":3}],"addresses":[{"id":"John's home address","address_type":"PHYSICAL","street":"1600 Pennsylvania Avenue NW","city":"Washington","district":"D.C.","state":"D.C.","postal_code":"DC 20500","country":"USA"}],"id_document_number":"AB123456","id_document_type":"PASSPORT","birth_date":"1974-12-14","custom_fields":[{"key":"Job","value":"Engineer"}],"id_documents":[{"number":"AB123456","type":"PASSPORT"},{"number":"123456789","type":"NATIONAL_ID"}],"_links":{"self":{"href":"https://api.talkdeskapp.com/fsi/contacts/0120343"}}}]},"redacted_fields":["_embedded.contacts.contact.member_id","_embedded.contacts.contact.id_document_number"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490000","message":"Bad request.","fields":[{"name":"skip","description":"skip parameter not in a valid range."},{"name":"limit","description":"limit parameter not in a valid range."}]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490001","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490002","message":"Required scopes are missing."}}}}}}},"/fsi/contacts/{contact_id}":{"get":{"tags":["FSI Contacts"],"summary":"Return contact information","description":"Retrieve the contact information for a specific contact ID.","security":[{"GA":["fsi-contacts:read"]}],"parameters":[{"in":"path","name":"contact_id","schema":{"type":"string","minLength":1,"maxLength":255},"required":true,"description":"The contact id"},{"in":"query","name":"interaction_id","schema":{"type":"string","minLength":0,"maxLength":255},"required":false,"description":"The interaction id"}],"responses":{"200":{"description":"The contact information","content":{"application/json":{"schema":{"type":"object","required":["id","member_id","name","contacts","addresses","_links"],"properties":{"redacted_fields":{"description":"list of fields in the response which are redacted. Each element is the full path access in the response of the redacted field.","type":"array","items":{"type":"string"}},"id":{"type":"string","description":"The contact id from the extenal fsi institution\n(id which SHOULD BE USEED as the identified of the contact, to get its accounts, cards, payments and transactions).\n"},"member_id":{"type":"string","description":"An identifier of the contact in the extenal fsi institution,\nfor some cores it can be SOCIAL_SECURITY, or other contact property, or even equal to the id.\n(DO NOT USE this property as the contact identifier to get its accounts, cards, payments and transactions)\n"},"name":{"type":"string","description":"Contact name"},"contacts":{"type":"array","items":{"type":"object","required":["id","type","value","use","rank"],"properties":{"id":{"type":"string","description":"Identification for contact point"},"type":{"type":"string","description":"Define the type for this contact point","enum":["PHONE","EMAIL","SMS","OTHER"]},"value":{"type":"string","description":"The actual contact point details"},"use":{"type":"string","description":"Purpose of this contact point","enum":["HOME","WORK","MOBILE","TEMPORARY","OLD"]},"rank":{"description":"Specify preferred order of use (0 = highest)","type":"integer","minimum":0}}}},"addresses":{"type":"array","items":{"type":"object","required":["id","type","street","city","district","state","postal_code","country"],"properties":{"id":{"type":"string","description":"Identification for the address"},"type":{"type":"string","description":"Address type","enum":["POSTAL","PHYSICAL","BOTH"]},"street":{"type":"string","description":"Street name address (can be Street, Avenue, Square, etc.)"},"city":{"type":"string","description":"Name of city, town etc."},"district":{"type":"string","description":"District name (aka county)"},"state":{"type":"string","description":"Sub-unit of country (abbreviations ok)"},"postal_code":{"type":"string"},"country":{"type":"string","description":"Country (e.g. can be ISO 3166 2 or 3 letter code)"}}}},"id_document_number":{"type":"string","description":"Document number associated to a person"},"id_document_type":{"type":"string","enum":["SOCIAL_SECURITY","DRIVERS_LICENSE","PASSPORT","NATIONAL_ID","OTHER"]},"birth_date":{"type":"string","format":"date"},"vip_client":{"type":"boolean","description":"Indicates if the contact is sensitive and some of his data should be hidden from agents"},"custom_fields":{"type":"array","description":"Custom fields list. It allows the core the retrieve custom data for each FSI contact.","items":{"type":"object","required":["key"],"properties":{"key":{"type":"string","description":"custom field name"},"value":{"type":"string","description":"custom field value"}}},"example":[{"key":"Job","value":"Engineer"},{"key":"Nationality","value":"American"}]},"id_documents":{"description":"ID Documents associated to a person. The array is ordered as follows (from top to bottom), first SOCIAL_SECURITY, then DRIVERS_LICENSE, then PASSPORT, then NATIONAL_ID and finally OTHER.","type":"array","items":{"description":"ID Documents associated to a person","type":"object","required":["type"],"properties":{"number":{"type":"string","description":"Document number associated to a person"},"type":{"type":"string","enum":["SOCIAL_SECURITY","DRIVERS_LICENSE","PASSPORT","NATIONAL_ID","OTHER"]}}}},"membership_date":{"type":"string","format":"date","description":"Date on that client became a member/client"},"_links":{"description":"Self link item for HAL","properties":{"self":{"description":"Link of the current page","type":"object","properties":{"href":{"description":"Address of the resource","type":"string"}}}},"required":["self"],"type":"object"}}},"examples":{"Person with one contact and two address":{"value":{"id":"0120343","member_id":"AC12334543","name":"John Doe","contacts":[{"id":"Personal Number","type":"PHONE","value":"1235 42352","use":"HOME","rank":1}],"addresses":[{"id":"My home","address_type":"PHYSICAL","street":"1600 Pennsylvania Avenue NW","city":"Washington","district":"D.C.","state":"D.C.","postal_code":"DC 20500","country":"USA"},{"id":"Office Address","address_type":"POSTAL","street":"Rua Campo Grande, 25","city":"Lisbon","district":"Lisbon","state":"LI","postal_code":"1600-036","country":"PRT"}],"id_document_number":"AB123456","id_document_type":"PASSPORT","id_documents":[{"number":"AB123456","type":"PASSPORT"},{"number":"987654321","type":"NATIONAL_ID"}],"birth_date":"1974-12-14","_links":{"self":{"href":"https://api.talkdeskapp.com/fsi/contacts/0120343"}},"redacted_fields":["member_id","id_document_number"]}},"Person with one contact and one address":{"value":{"id":"0120343","member_id":"AC12334543","name":"Mary Whom","contacts":[{"id":"Personal Number","type":"PHONE","value":"98765 42352","use":"HOME","rank":2}],"addresses":[{"id":"Office Address","address_type":"POSTAL","street":"Rua Campo Grande, 85","city":"Lisbon","district":"Lisbon","state":"LI","postal_code":"1600-036","country":"PRT"}],"id_document_number":"AB654321","id_document_type":"PASSPORT","birth_date":"1978-12-01","custom_fields":[{"key":"National","value":"American"}],"id_documents":[{"number":"AB654321","type":"PASSPORT"},{"number":"123456789","type":"NATIONAL_ID"}],"_links":{"self":{"href":"https://api.talkdeskapp.com/fsi/contacts/0120343"}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3444000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490001","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490002","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490003","message":"Resource not found."}}}}}}},"/fsi/contacts/{contact_id}/cards/{card_id}":{"get":{"tags":["FSI Cards"],"summary":"Returns card information","description":"The endpoint allows you to retrieve detailed information about a specific card associated with a contact.\nBy providing the unique contact ID and card ID as path parameters, this endpoint enables you to fetch the specific card's details based on its ID.\n","security":[{"GA":["fsi-cards:read"]}],"parameters":[{"in":"path","name":"contact_id","schema":{"type":"string","minLength":1,"maxLength":255},"required":true,"description":"The contact id"},{"in":"path","name":"card_id","schema":{"type":"string","minLength":1,"maxLength":255},"required":true,"description":"The card id"},{"in":"query","name":"interaction_id","schema":{"type":"string","minLength":0,"maxLength":255},"required":false,"description":"The interaction id"}],"responses":{"200":{"description":"The card information.","content":{"application/json":{"schema":{"type":"object","required":["id","card_number","card_type","expiration_at","holder_name","issuer","status","_links"],"properties":{"id":{"type":"string","description":"Identification for a card"},"card_name":{"type":"string","description":"Account owner name"},"card_number":{"type":"string","description":"A masked card number that can be displayed to the customer.","example":"XXXXXXXXXXXX4521","minLength":16,"maxLength":16},"card_type":{"type":"string","description":"Inform the card type","enum":["DEBIT","CREDIT","ATM"]},"activation_at":{"type":"string","description":"Card activation date","format":"date"},"expiration_at":{"type":"string","description":"Card expiration date","format":"date"},"inactive_date":{"type":"string","description":"Card inactivation date","format":"date"},"holder_name":{"type":"string","description":"The name printed in the card.","maxLength":30},"issuer":{"type":"string","description":"Card's issuer","example":"MASTER CARD"},"status":{"type":"string","description":"Card's current status","enum":["ACTIVE","CLOSED","INACTIVE","BLOCKED","LOST","STOLEN","CANCELED"]},"description":{"type":"string","description":"Card's description"},"custom_type":{"type":"string","description":"Card type customized by bank client"},"custom_status":{"type":"string","description":"Card status customized by bank client"},"custom_fields":{"description":"Custom fields associated with the entity.","type":"array","items":{"type":"object","required":["key"],"properties":{"key":{"type":"string","description":"custom field name","minLength":0,"maxLength":255},"value":{"type":"string","description":"custom field value","minLength":0,"maxLength":255}}}},"account_id":{"type":"string","description":"Account associated to the card"},"deactivation_note":{"type":"string","description":"It contains notes about the deactivation of card."},"_links":{"description":"HAL API self link","properties":{"self":{"description":"Link of the current page","type":"object","properties":{"href":{"description":"Address of the resource","type":"string"}}}},"required":["self"],"type":"object"}}},"examples":{"Example 1 (ACTIVE)":{"value":{"id":"card_td_id_123456","account_id":"accountId","card_name":"My Card","card_number":"XXXXXXXXXXXX4521","card_type":"DEBIT","activation_at":"2018-02-21","expiration_at":"2022-06-12","inactive_date":"2022-06-12","holder_name":"KING JULIAN","issuer":"MASTER CARD","status":"ACTIVE","description":"MC CONSUMER DEBIT","custom_fields":[{"key":"reward_points","value":"1500"},{"key":"vip_status","value":"gold"}],"_links":{"self":{"href":"https://api.talkdeskapp.com/fsi/contacts/0000058580/cards/card_td_id_123456"}}}},"Example 2 (INACTIVE)":{"value":{"id":"card_td_id_123452","account_id":"accountId","card_number":"XXXXXXXXXXXX4522","card_type":"CREDIT","expiration_at":"2022-06-12","holder_name":"KING JULIAN","issuer":"MASTER CARD","status":"INACTIVE","description":"MC CONSUMER REWARDS","custom_fields":[{"key":"reward_points","value":"3000"},{"key":"vip_status","value":"platinum"}],"custom_type":"Custom Credit","custom_status":"Custom Inactive","deactivation_note":"The owner of the card have lost it","_links":{"self":{"href":"https://api.talkdeskapp.com/fsi/contacts/0000058580/cards/card_td_id_123452"}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3444000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490001","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490002","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490003","message":"Resource not found."}}}}}}},"/fsi/contacts/{contact_id}/cards/{card_id}/deactivation":{"post":{"tags":["FSI Cards"],"summary":"Deactivate a card and give it a new status","description":"The endpoint allows you to deactivate a specific card associated with a contact.\nBy providing the unique contact ID and card ID as path parameters, this endpoint enables you to deactivate the card and render it inactive for further use.\n","security":[{"GA":["fsi-cards:write"]}],"parameters":[{"in":"path","name":"contact_id","schema":{"type":"string","minLength":1,"maxLength":255},"required":true,"description":"The contact id"},{"in":"path","name":"card_id","schema":{"type":"string","minLength":1,"maxLength":255},"required":true,"description":"The card id"},{"in":"query","name":"interaction_id","schema":{"type":"string","minLength":0,"maxLength":255},"required":false,"description":"The interaction id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["new_status"],"properties":{"reason_description":{"description":"The reason why the card is going to be deactivate","type":"string","minLength":0,"maxLength":255},"new_status":{"description":"The new status for this card","type":"string","enum":["LOST","STOLEN","CANCELED"],"minLength":0,"maxLength":255}}},"example":{"reason_description":"The client does not know where is the card","new_status":"LOST"}}}},"responses":{"200":{"description":"The card deactivation response.","content":{"application/json":{"schema":{"type":"object","properties":{"confirmation_code":{"description":"The confirmation code","type":"string"},"custom_fields":{"description":"Custom fields associated with the entity.","type":"array","items":{"type":"object","required":["key"],"properties":{"key":{"type":"string","description":"custom field name","minLength":0,"maxLength":255},"value":{"type":"string","description":"custom field value","minLength":0,"maxLength":255}}}}}},"example":{"confirmation_code":"confirmation_code123","custom_fields":[{"key":"reason_description","value":"The client does not know where is the card"},{"key":"new_status","value":"LOST"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Default":{"value":{"code":"1490000","message":"Bad request."}},"Pagination":{"value":{"code":"1490000","message":"Bad request.","fields":[{"name":"skip","description":"skip parameter not in a valid range."},{"name":"limit","description":"limit parameter not in a valid range."}]}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490001","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490002","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490003","message":"Resource not found."}}}}}}},"/fsi/contacts/{contact_id}/cards/{card_id}/activation":{"post":{"tags":["FSI Cards"],"summary":"Inform when a card needs to be activate","description":"The endpoint allows you to activate a specific card associated with a contact.\nBy providing the unique contact ID and card ID as path parameters, this endpoint enables you to activate the card and make it ready for use.\n","security":[{"GA":["fsi-cards:write"]}],"parameters":[{"in":"path","name":"contact_id","schema":{"type":"string","minLength":0,"maxLength":255},"required":true,"description":"The contact id"},{"in":"path","name":"card_id","schema":{"type":"string","minLength":0,"maxLength":255},"required":true,"description":"The card id"},{"in":"query","name":"interaction_id","schema":{"type":"string","minLength":0,"maxLength":255},"required":true,"description":"The interaction id"}],"responses":{"200":{"description":"The card activation response.","content":{"application/json":{"schema":{"type":"object","properties":{"confirmation_code":{"description":"The confirmation code","type":"string"},"custom_fields":{"description":"Custom fields associated with the entity.","type":"array","items":{"type":"object","required":["key"],"properties":{"key":{"type":"string","description":"custom field name","minLength":0,"maxLength":255},"value":{"type":"string","description":"custom field value","minLength":0,"maxLength":255}}}}}},"example":{"confirmation_code":"confirmation_code123","custom_fields":[{"key":"reason_description","value":"The client does not know where is the card"},{"key":"new_status","value":"LOST"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Default":{"value":{"code":"1490000","message":"Bad request."}},"Pagination":{"value":{"code":"1490000","message":"Bad request.","fields":[{"name":"skip","description":"skip parameter not in a valid range."},{"name":"limit","description":"limit parameter not in a valid range."}]}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490001","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490002","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490003","message":"Resource not found."}}}}}}},"/fsi/contacts/{contact_id}/cards":{"get":{"tags":["FSI Cards"],"summary":"Returns contact cards list","description":"The endpoint allows you to retrieve the list of cards associated with a specific contact.\nBy providing the unique contact ID as a path parameter, this endpoint enables you to fetch the card details linked to the contact, such as credit cards, debit cards, or other card types.\n","security":[{"GA":["fsi-cards:read"]}],"parameters":[{"in":"path","name":"contact_id","schema":{"type":"string"},"required":true,"description":"The contact id"},{"in":"query","name":"skip","description":"The number of elements to skip in cards collection","schema":{"type":"integer","minimum":0,"maximum":2147483647,"default":0}},{"in":"query","name":"limit","description":"The maximum number of elements in the cards collection","schema":{"type":"integer","minimum":1,"maximum":500,"default":20}},{"in":"query","name":"interaction_id","schema":{"type":"string"},"required":false,"description":"The interaction id"}],"responses":{"200":{"description":"The cards list.","content":{"application/json":{"schema":{"description":"List of cards","type":"object","required":["total","_embedded"],"properties":{"total":{"description":"The total number of cards in the collection","type":"integer","minimum":0,"default":0},"_embedded":{"type":"object","required":["cards"],"properties":{"cards":{"description":"List of cards in the current page","type":"array","items":{"type":"object","required":["id","card_number","card_type","expiration_at","holder_name","issuer","status","_links"],"properties":{"id":{"type":"string","description":"Identification for a card"},"card_name":{"type":"string","description":"Account owner name"},"card_number":{"type":"string","description":"A masked card number that can be displayed to the customer.","example":"XXXXXXXXXXXX4521","minLength":16,"maxLength":16},"card_type":{"type":"string","description":"Inform the card type","enum":["DEBIT","CREDIT","ATM"]},"activation_at":{"type":"string","description":"Card activation date","format":"date"},"expiration_at":{"type":"string","description":"Card expiration date","format":"date"},"inactive_date":{"type":"string","description":"Card inactivation date","format":"date"},"holder_name":{"type":"string","description":"The name printed in the card.","maxLength":30},"issuer":{"type":"string","description":"Card's issuer","example":"MASTER CARD"},"status":{"type":"string","description":"Card's current status","enum":["ACTIVE","CLOSED","INACTIVE","BLOCKED","LOST","STOLEN","CANCELED"]},"description":{"type":"string","description":"Card's description"},"custom_type":{"type":"string","description":"Card type customized by bank client"},"custom_status":{"type":"string","description":"Card status customized by bank client"},"custom_fields":{"description":"Custom fields associated with the entity.","type":"array","items":{"type":"object","required":["key"],"properties":{"key":{"type":"string","description":"custom field name","minLength":0,"maxLength":255},"value":{"type":"string","description":"custom field value","minLength":0,"maxLength":255}}}},"account_id":{"type":"string","description":"Account associated to the card"},"deactivation_note":{"type":"string","description":"It contains notes about the deactivation of card."},"_links":{"description":"HAL API self link","properties":{"self":{"description":"Link of the current page","type":"object","properties":{"href":{"description":"Address of the resource","type":"string"}}}},"required":["self"],"type":"object"}}}}}}}},"example":{"total":2,"_embedded":{"cards":[{"id":"card_td_id_123456","account_id":"accountId","card_name":"My Card","card_number":"XXXXXXXXXXXX4521","card_type":"DEBIT","activation_at":"2018-02-21","expiration_at":"2022-06-12","inactive_date":"2022-06-12","holder_name":"KING JULIAN","issuer":"MASTER CARD","status":"ACTIVE","description":"MC CONSUMER DEBIT","custom_fields":[{"key":"reward_points","value":"1500"},{"key":"vip_status","value":"gold"}],"_links":{"self":{"href":"https://api.talkdeskapp.com/fsi/contacts/0000058580/cards/card_td_id_123456"}}},{"id":"card_td_id_123452","account_id":"accountId","card_number":"XXXXXXXXXXXX4522","card_type":"CREDIT","expiration_at":"2022-06-12","holder_name":"KING JULIAN","issuer":"MASTER CARD","status":"INACTIVE","description":"MC CONSUMER REWARDS","custom_fields":[{"key":"reward_points","value":"3000"},{"key":"vip_status","value":"platinum"}],"custom_type":"Custom Credit","custom_status":"Custom Inactive","deactivation_note":"The owner of the card have lost it","_links":{"self":{"href":"https://api.talkdeskapp.com/fsi/contacts/0000058580/cards/card_td_id_123452"}}}]}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490000","message":"Bad request.","fields":[{"name":"skip","description":"skip parameter not in a valid range."},{"name":"limit","description":"limit parameter not in a valid range."}]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490001","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490002","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490003","message":"Resource not found."}}}}}}},"/fsi/contacts/{contact_id}/payments":{"get":{"tags":["FSI Payments"],"summary":"Returns account upcoming payments","description":"The endpoint allows you to retrieve the list of payments associated with a specific contact.\nBy providing the unique contact ID as a path parameter, this endpoint enables you to fetch both past and upcoming payment records for the contact.\n","security":[{"GA":["fsi-payments:read"]}],"parameters":[{"in":"path","name":"contact_id","schema":{"type":"string"},"required":true,"description":"The contact id"},{"in":"query","name":"skip","description":"The number of elements to skip in payments collection","schema":{"type":"integer","minimum":0,"maximum":2147483647,"default":0}},{"in":"query","name":"limit","description":"The maximum number of elements returned in payments collection","schema":{"type":"integer","minimum":1,"maximum":500,"default":20}},{"in":"query","name":"due_at_from","description":"Lower bound filter of due_at field","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"due_at_to","description":"Upper bound filter of due_at field","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"type","description":"Type filter","schema":{"x-filterable":true,"type":"string","enum":["PERSONAL_LOAN","MORTGAGE_LOAN","AUTO_LOAN","OTHER_LOAN","CREDITCARD_BALANCE","HOME_EQUITY_LOAN","BUSINESS_LOAN","STUDENT_LOAN","BUSINESS_CREDIT_CARD","STUDENT_CREDIT_CARD","PERSONAL_CREDIT_CARD","CREDIT_CARD"]}},{"in":"query","name":"status","description":"Status filter","schema":{"type":"string","enum":["OPEN","CLOSED","UNDEFINED","PENDING","PAID","PAST_DUE","UPCOMING"]}},{"in":"query","name":"account_id","description":"AccountId associated to the payments","schema":{"type":"string"}},{"in":"query","name":"interaction_id","schema":{"type":"string"},"required":false,"description":"The interaction id"}],"responses":{"200":{"description":"The payments list.","content":{"application/json":{"schema":{"type":"object","description":"Offset based pagination for payments","required":["_embedded","total"],"properties":{"total":{"description":"The total number of payments in collection","type":"integer","minimum":0,"default":0},"_embedded":{"type":"object","required":["payments"],"properties":{"payments":{"description":"List of payments in an account","type":"array","items":{"type":"object","required":["id","description","total_amount_due","currency","due_at","status","account_id","minimum_payment_due","type"],"properties":{"id":{"type":"string","description":"Identification for a single payment"},"description":{"type":"string","description":"Brief description for a payment"},"total_amount_due":{"type":"string","description":"Total loan amount due balance - amount due on monthly statement (for upcoming credit card payments this parameter is shown on UI as Remaining Statement Balance)"},"currency":{"type":"string","description":"The currency where the payment is due"},"due_at":{"type":"string","format":"date","description":"The date when the payment will be due"},"status":{"type":"string","enum":["OPEN","CLOSED","UNDEFINED","PENDING","PAID","PAST_DUE","UPCOMING"]},"account_id":{"type":"string","description":"Bank account"},"minimum_payment_due":{"type":"string","description":"Minimum Payment amount"},"due_fees_amount":{"type":"string","description":"Fees charged for a past due pending payment."},"type":{"type":"string","enum":["PERSONAL_LOAN","MORTGAGE_LOAN","AUTO_LOAN","OTHER_LOAN","CREDITCARD_BALANCE","HOME_EQUITY_LOAN","BUSINESS_LOAN","STUDENT_LOAN","BUSINESS_CREDIT_CARD","STUDENT_CREDIT_CARD","PERSONAL_CREDIT_CARD","CREDIT_CARD"]},"custom_type":{"type":"string","description":"Payment type customized by bank client"},"custom_status":{"type":"string","description":"Payment status customized by bank client"},"custom_fields":{"description":"Custom fields associated with the entity.","type":"array","items":{"type":"object","required":["key"],"properties":{"key":{"type":"string","description":"custom field name","minLength":0,"maxLength":255},"value":{"type":"string","description":"custom field value","minLength":0,"maxLength":255}}}},"amount_details":{"type":"object","properties":{"principal_payment":{"type":"string","description":"Principal payment (detail amount of total_amount_due)"},"interest_payment":{"type":"string","description":"Interest payment (detail amount of total_amount_due)"},"monthly_escrow_payment":{"type":"string","description":"Monthly escrow payment (detail amount of total_amount_due)"},"fee":{"type":"string","description":"Fee payment (detail amount of total_amount_due)"}}}}}}}}}},"example":{"total":2,"_embedded":{"payments":[{"id":"1","description":"Water bill April 21","total_amount_due":"2.56","currency":"EUR","due_at":"2022-03-23","status":"UNDEFINED","account_id":"4f1c72ef788f43c38631189741c78874","minimum_payment_due":"2.56","due_fees_amount":"0.10","type":"PERSONAL_LOAN","amount_details":{"principal_payment":"344.65","interest_payment":"0.00","monthly_escrow_payment":"0.00","fee":"0.00"}},{"id":"2","description":"Mobile bill Mar 21","total_amount_due":"15.85","currency":"EUR","due_at":"2023-03-23","status":"UNDEFINED","account_id":"37a5fc7e06fc46e6b33ed5a706db286d","minimum_payment_due":"10.00","due_fees_amount":"0.30","type":"CREDITCARD_BALANCE","custom_type":"Custom Credit Card Balance","custom_status":"Custom Undefined","custom_fields":[{"key":"reward_points","value":"1500"}],"amount_details":{"principal_payment":"344.65","interest_payment":"0.00","monthly_escrow_payment":"0.00","fee":"0.00"}}]}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490000","message":"Bad request.","fields":[{"name":"skip","description":"skip parameter not in a valid range."},{"name":"limit","description":"limit parameter not in a valid range."}]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490001","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490002","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490003","message":"Resource not found."}}}}}}},"/fsi/transfers/internal":{"post":{"tags":["FSI Transfers"],"summary":"Transfers between accounts","description":"Should do a transfer between the indicated members","security":[{"GA":["fsi-transfers:write"]}],"parameters":[{"in":"query","name":"interaction_id","schema":{"type":"string"},"required":true,"description":"The interaction id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["origin_member_id","destination_member_id","origin_account_number","destination_account_number","value"],"properties":{"origin_member_id":{"description":"The origin member id","type":"string"},"destination_member_id":{"description":"The destination member id","type":"string"},"origin_account_number":{"description":"The origin account number","type":"string"},"destination_account_number":{"description":"The destination account number","type":"string"},"value":{"description":"The transfer value","type":"number","format":"float"},"approval_person_number":{"type":"string","description":"The Approval Person Number is used to override exceptions"},"effective_date":{"type":"string","format":"date","description":"The effective date"},"description":{"description":"The transfer description","type":"string"}}},"example":{"origin_member_id":"12345","destination_member_id":"123","origin_account_number":"12345","destination_account_number":"123","value":1000.5,"effective_date":"2022-12-07","description":"Transfer to 123"}}}},"responses":{"200":{"description":"The transfer response.","content":{"application/json":{"schema":{"type":"object","properties":{"transaction_post_date":{"description":"The date on which funds are taken or added to an account.","type":"string","format":"date"},"confirmation_code":{"description":"The confirmation code","type":"string"},"custom_fields":{"description":"Custom fields associated with the entity.","type":"array","items":{"type":"object","required":["key"],"properties":{"key":{"type":"string","description":"custom field name","minLength":0,"maxLength":255},"value":{"type":"string","description":"custom field value","minLength":0,"maxLength":255}}}}}},"example":{"transaction_post_date":"2022-12-07","confirmation_code":"confirmation_code123","custom_fields":[{"key":"confirmation_code","value":"confirmation_code123"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Default":{"value":{"code":"1490000","message":"Bad request."}},"Pagination":{"value":{"code":"1490000","message":"Bad request.","fields":[{"name":"skip","description":"skip parameter not in a valid range."},{"name":"limit","description":"limit parameter not in a valid range."}]}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490001","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490002","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490003","message":"Resource not found."}}}}}}},"/fsi/transfers/external":{"post":{"tags":["FSI Transfers"],"summary":"Transfers between accounts","description":"Should do a transfer between the indicated members. Note here- Domestic transfers typically require both destination_account_number and destination_bank_routing_number, while international transfers use iban and swift. Although each field is technically optional, at least one valid combination must be provided to complete a transfer.","security":[{"GA":["fsi-transfers:write"]}],"parameters":[{"in":"query","name":"interaction_id","schema":{"type":"string"},"required":true,"description":"The interaction id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["origin_member_id","origin_account_number","value"],"properties":{"origin_member_id":{"description":"The origin member id","type":"string"},"origin_account_number":{"description":"The origin account number","type":"string"},"recipient_first_last_name":{"description":"First and last name of the transfer's recipient","type":"string"},"recipient_address":{"description":"Email address of the transfer's recipient","type":"string"},"destination_account_number":{"description":"The destination account number, required for domestic transfers","type":"string"},"destination_bank_routing_number":{"description":"The destination account routing number, required for domestic transfers","type":"string"},"iban":{"description":"The destination account IBAN, required for international transfers","type":"string"},"swift":{"description":"The destination account Swift code, required for international transfers","type":"string"},"value":{"description":"The transfer value","type":"number","format":"float"},"approval_person_number":{"type":"string","description":"The Approval Person Number is used to override exceptions"},"effective_date":{"type":"string","format":"date","description":"The effective date"},"description":{"description":"The transfer description","type":"string"}}},"example":{"origin_member_id":"123456","origin_account_number":"1234567890","recipient_first_last_name":"John Doe","recipient_address":"johndoe@example.com","destination_account_number":"0987654321","destination_bank_routing_number":"123456789","iban":"US82WEST12345698765432","swift":"TDTDUS12","value":1000,"approval_person_number":"789456","effective_date":"2023-04-22","description":"Payment for services rendered"}}}},"responses":{"200":{"description":"The transfer response.","content":{"application/json":{"schema":{"type":"object","properties":{"transaction_post_date":{"description":"The date on which funds are taken or added to an account.","type":"string","format":"date"},"confirmation_code":{"description":"The confirmation code","type":"string"},"custom_fields":{"description":"Custom fields associated with the entity.","type":"array","items":{"type":"object","required":["key"],"properties":{"key":{"type":"string","description":"custom field name","minLength":0,"maxLength":255},"value":{"type":"string","description":"custom field value","minLength":0,"maxLength":255}}}}}},"example":{"transaction_post_date":"2022-12-07","confirmation_code":"confirmation_code123","custom_fields":[{"key":"confirmation_code","value":"confirmation_code123"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Default":{"value":{"code":"1490000","message":"Bad request."}},"Pagination":{"value":{"code":"1490000","message":"Bad request.","fields":[{"name":"skip","description":"skip parameter not in a valid range."},{"name":"limit","description":"limit parameter not in a valid range."}]}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490001","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490002","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490003","message":"Resource not found."}}}}}}},"/fsi/transfers/international":{"post":{"tags":["FSI Transfers"],"summary":"Transfers between accounts","description":"Should do a transfer between the indicated members","security":[{"GA":["fsi-transfers:write"]}],"parameters":[{"in":"query","name":"interaction_id","schema":{"type":"string"},"required":true,"description":"The interaction id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["origin_member_id","origin_account_number","iban","swift","value"],"properties":{"origin_member_id":{"description":"The origin member id","type":"string"},"origin_account_number":{"description":"The origin account number","type":"string"},"recipient_first_last_name":{"description":"First and last name of the transfer's recipient","type":"string"},"recipient_address":{"description":"Email address of the transfer's recipient","type":"string"},"iban":{"description":"The destination account IBAN","type":"string"},"swift":{"description":"The destination account Swift code","type":"string"},"value":{"description":"The transfer value","type":"number","format":"float"},"approval_person_number":{"type":"string","description":"The Approval Person Number is used to override exceptions"},"effective_date":{"type":"string","format":"date","description":"The effective date"},"description":{"description":"The transfer description","type":"string"}}},"example":{"origin_member_id":"123456","origin_account_number":"1234567890","recipient_first_last_name":"John Doe","recipient_address":"johndoe@example.com","iban":"US82WEST12345698765432","swift":"TDTDUS12","value":1000,"approval_person_number":"789456","effective_date":"2023-04-22","description":"Payment for services rendered"}}}},"responses":{"200":{"description":"The transfer response.","content":{"application/json":{"schema":{"type":"object","properties":{"transaction_post_date":{"description":"The date on which funds are taken or added to an account.","type":"string","format":"date"},"confirmation_code":{"description":"The confirmation code","type":"string"},"custom_fields":{"description":"Custom fields associated with the entity.","type":"array","items":{"type":"object","required":["key"],"properties":{"key":{"type":"string","description":"custom field name","minLength":0,"maxLength":255},"value":{"type":"string","description":"custom field value","minLength":0,"maxLength":255}}}}}},"example":{"transaction_post_date":"2022-12-07","confirmation_code":"confirmation_code123","custom_fields":[{"key":"confirmation_code","value":"confirmation_code123"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Default":{"value":{"code":"1490000","message":"Bad request."}},"Pagination":{"value":{"code":"1490000","message":"Bad request.","fields":[{"name":"skip","description":"skip parameter not in a valid range."},{"name":"limit","description":"limit parameter not in a valid range."}]}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490001","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490002","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490003","message":"Resource not found."}}}}}}},"/fsi/stop/{contact_id}/payments":{"post":{"tags":["FSI Stop Payment"],"summary":"Enable users to cancel various types of payments, including personal checks, before they are processed.","description":"Cancel a payment before it’s been processed","security":[{"GA":["fsi-stop-payment:write"]}],"parameters":[{"in":"path","name":"contact_id","schema":{"type":"string"},"required":true,"description":"The contact id"},{"in":"query","name":"interaction_id","schema":{"type":"string"},"required":false,"description":"The interaction id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["account_id","check_currency_code_value","stop_type"],"properties":{"account_id":{"description":"account id","type":"string","maxLength":22},"account_type":{"description":"The account type","type":"string","maxLength":30},"member_id":{"description":"member id","type":"string","maxLength":22},"branch_id":{"description":"The branch id","type":"string","maxLength":30},"check_number":{"description":"The check number","type":"string","maxLength":22},"check_number_range":{"type":"object","properties":{"check_number_start":{"description":"The first check number of the sequence","type":"string","maxLength":22},"check_number_end":{"description":"The last check number of the sequence","type":"string","maxLength":22}}},"payee_name":{"description":"The payee name","type":"string","maxLength":25},"check_currency_code_type":{"description":"check currency code type","type":"string","maxLength":25},"check_currency_code_value":{"description":"check currency code value","type":"string","maxLength":25},"check_amount":{"description":"The check amount","type":"string","format":"float","maxLength":25},"check_amount_variance":{"description":"check amount variance","type":"string","format":"float","maxLength":25},"check_amount_range":{"type":"object","properties":{"low_amount":{"description":"The lowest check amount of the sequence digital string","type":"string","maxLength":25},"high_amount":{"description":"The highest check amount of the sequence digital string","type":"string","maxLength":25}}},"check_date":{"description":"Date on which the customer wrote the check","type":"string","maxLength":25},"stop_check_date":{"description":"Date on which the stop check request is initiated","type":"string","maxLength":25},"expiration_date":{"description":"Date after which stop check is inactive","type":"string","maxLength":25},"stop_type":{"description":"Stop payment scenario type","type":"string","enum":["INDIVIDUAL","SEQUENCE","ACH"]},"stop_check_reason":{"description":"Specifies the reason for the stop check","type":"string","enum":["Stolen Check,","Lost Check,","Lost or Stolen Check,","Incorrect Amount,","Change in Circumstances,","Payment Dispute,","Fraud Prevention,","Unexpected Changes,","Cancellation of Services,","Billing Disputes,","Fraudulent Transactions,","Change in Payment Terms,","Insufficient Funds,","Duplicate Payments,","Service Discontinuation,","Processing Errors,","Legal Issues,","Other"]},"fees":{"description":"Transaction fee for a stop check transaction digital string","type":"string","maxLength":25},"waive_fee":{"description":"waive fee for a stop check transaction","type":"boolean"},"match_check_number":{"description":"match check number for a stop check transaction","type":"boolean"},"ach":{"description":"ach for a stop check transaction","type":"boolean"},"ach_debit_credit":{"description":"ach debit credit number for a stop check transaction","type":"string","maxLength":30,"enum":["Debit","Credit"]},"card_signed":{"description":"sign card","type":"boolean"},"print_receipt_code":{"description":"print receipt code","type":"string","maxLength":25}}},"example":{"account_id":"0060211001","account_type":"DEBIT","branch_id":"000011000","check_number":"1001","check_number_range":{"check_number_start":"0000000601","check_number_end":"0000000602"},"payee_name":"TalkDesk","check_currency_code_type":"ISO4217-Alpha","check_currency_code_value":"USD","check_amount":"300","check_amount_variance":"200","check_amount_range":{"low_amount":"20","high_amount":"80"},"check_date":"2024-01-20","stop_check_date":"2024-01-25","expiration_date":"2024-07-25","stop_type":"SEQUENCE","stop_check_reason":"Incorrect amount","fees":"20","waive_fee":"false","match_check_number":"false","ach":"false","ach_debit_credit":"Debit"}}}},"responses":{"200":{"description":"The stop payment response.","content":{"application/json":{"schema":{"type":"object","required":["member_id","account_id"],"properties":{"member_id":{"description":"The member id","type":"string","maxLength":30},"account_id":{"description":"account id","type":"string","maxLength":22},"stop_check_status_code":{"description":"Status code for the stop check record","type":"string","maxLength":30},"stop_check_status_desc":{"description":"Brief information about the stop check status description","type":"string","maxLength":50},"effective_date":{"description":"Effective date and time when the stop check status is changed","type":"string","maxLength":30},"custom_fields":{"description":"Custom fields associated with the entity.","type":"array","items":{"type":"object","required":["key"],"properties":{"key":{"type":"string","description":"custom field name","minLength":0,"maxLength":255},"value":{"type":"string","description":"custom field value","minLength":0,"maxLength":255}}}}}},"example":{"member_id":"0000602110","account_id":"0060211001","stop_check_status_code":"Valid","stop_check_status_desc":"Success","effective_date":"2024-01-25","custom_fields":[{"key":"stop_check_status_code","value":"Valid"},{"key":"stop_check_status_desc","value":"Success"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Default":{"value":{"code":"1490000","message":"Bad request."}},"Pagination":{"value":{"code":"1490000","message":"Bad request.","fields":[{"name":"skip","description":"skip parameter not in a valid range."},{"name":"limit","description":"limit parameter not in a valid range."}]}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490001","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490002","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490003","message":"Resource not found."}}}}}}},"/fsi/travel/notifications":{"post":{"tags":["FSI Create Travel Notifications"],"summary":"Create a new endpoint for Travel Notifications with the necessary parameters for the different banking connectors","description":"Create a new endpoint for Travel Notifications","security":[{"GA":["fsi-travel-notification:write"]}],"parameters":[{"in":"query","name":"interaction_id","schema":{"type":"string","minLength":0,"maxLength":255},"required":false,"description":"The interaction id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["member_id","destination","departure_date","return_date","contact_number"],"properties":{"member_id":{"description":"The member id","type":"string","maxLength":22},"account_id":{"description":"The account id","type":"string","maxLength":22},"card_id":{"description":"The card id","type":"string","maxLength":30},"destination":{"description":"The country follows ISO 3166-1 alpha-3 code (e.g. USA), and state follows the ISO 3166-2 alpha-2 code (e.g. NY)","type":"string","maxLength":30},"departure_date":{"description":"The departure Date","type":"string","format":"date","maxLength":30},"return_date":{"description":"The return Date","type":"string","format":"date","maxLength":30},"contact_number":{"description":"The contact number","type":"string","maxLength":30}}},"example":{"member_id":"0001328560","account_id":"0060211001","card_id":"006751314","destination":"USA, CAN, FRA, NY","departure_date":"2024-04-10","return_date":"2024-04-16","contact_number":"1-786-495-5552"}}}},"responses":{"200":{"description":"The create travel notice response.","content":{"application/json":{"schema":{"type":"object","required":["itinerary_id"],"properties":{"itinerary_id":{"description":"unique identification number of a travel note record","type":"string","minLength":0,"maxLength":255},"custom_fields":{"description":"Custom fields associated with the entity.","type":"array","items":{"type":"object","required":["key"],"properties":{"key":{"type":"string","description":"custom field name","minLength":0,"maxLength":255},"value":{"type":"string","description":"custom field value","minLength":0,"maxLength":255}}}}}},"example":{"itineraryId":"604","custom_fields":[{"key":"itinerary_id","value":"604"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Default":{"value":{"code":"1490000","message":"Bad request."}},"Pagination":{"value":{"code":"1490000","message":"Bad request.","fields":[{"name":"skip","description":"skip parameter not in a valid range."},{"name":"limit","description":"limit parameter not in a valid range."}]}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490001","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490002","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490003","message":"Resource not found."}}}}}}},"/fsi/checks/{contact_id}/search":{"post":{"tags":["FSI Accounts"],"summary":"Returns check status","description":"The endpoint allows you to search status of a check by providing the unique account ID and check number as parameters\n","security":[{"GA":["fsi-checks:read"]}],"parameters":[{"in":"path","name":"contact_id","required":true,"schema":{"type":"string","minLength":0,"maxLength":255},"description":"The contact ID associated with the account"},{"in":"query","name":"interaction_id","schema":{"type":"string","minLength":0,"maxLength":255},"required":false,"description":"The interaction id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["account_id","check_number"],"properties":{"account_id":{"type":"string","description":"The account id of the check","maxLength":30},"account_type":{"type":"string","description":"The account type of the check","maxLength":30},"branch_id":{"maxLength":64,"type":"string","description":"The branch id of the check"},"check_number":{"maxLength":64,"type":"string","description":"The check number of the check"},"payee_name":{"type":"string","description":"The payee name of the check","maxLength":30},"check_amount":{"type":"string","format":"float","description":"The account amount of the check","maxLength":30}}},"example":{"account_id":"0060211001","account_type":"DEBIT","branch_id":"000000","check_number":"1234567890","payee_name":"payee_name","check_amount":"10.00"}}}},"responses":{"200":{"description":"Return the status of the check","content":{"application/json":{"schema":{"type":"object","required":["check_status"],"properties":{"account_id":{"type":"string","description":"The account id of the check"},"check_number":{"type":"string","description":"The check number"},"check_status":{"type":"string","description":"The check status","maxLength":30,"enum":["CLEARED","PENDING","VOIDED","STALE_DATED","STOP_PAYMENT","RETURNED","IN_PROCESS","REVERSED","OTHER","UNKNOWN"]},"custom_fields":{"description":"Custom fields associated with the entity.","type":"array","items":{"type":"object","required":["key"],"properties":{"key":{"type":"string","description":"custom field name","minLength":0,"maxLength":255},"value":{"type":"string","description":"custom field value","minLength":0,"maxLength":255}}}}}},"example":{"account_id":"0060211001","check_number":"1234567890","check_status":"CLEARED","custom_fields":[{"key":"check_status_reason","value":"Check cleared on 2024-06-01"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Default":{"value":{"code":"1490000","message":"Bad request."}},"Pagination":{"value":{"code":"1490000","message":"Bad request.","fields":[{"name":"skip","description":"skip parameter not in a valid range."},{"name":"limit","description":"limit parameter not in a valid range."}]}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490001","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490002","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490003","message":"Resource not found."}}}}}}},"/fsi/contacts/{contact_id}/cards/{card_id}/replaceCard":{"post":{"tags":["FSI Replace Card"],"summary":"request the issuance of a replacement card","description":"request the issuance of a replacement card","security":[{"GA":["fsi-cards:write"]}],"parameters":[{"in":"path","name":"contact_id","schema":{"type":"string","minLength":0,"maxLength":255},"required":true,"description":"The contact id"},{"in":"path","name":"card_id","schema":{"type":"string","minLength":0,"maxLength":255},"required":true,"description":"The card id"},{"in":"query","name":"interaction_id","schema":{"type":"string","minLength":0,"maxLength":255},"required":false,"description":"The interaction id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["account_id","address"],"properties":{"account_id":{"description":"account id","type":"string","maxLength":22},"address":{"description":"the address details","type":"object","properties":{"shipping_address":{"description":"the shipping address","type":"string","maxLength":100},"postal_code":{"description":"postal code","type":"string","maxLength":30},"city":{"description":"city","type":"string","maxLength":30},"state":{"description":"state","type":"string","maxLength":30},"country":{"description":"country","type":"string","maxLength":30}}}}},"example":{"account_id":"0000602110","address":{"shipping_address":"456 Main St","postal_code":"10001","city":"New York","state":"NY","country":"US"}}}}},"responses":{"200":{"description":"The stop payment response.","content":{"application/json":{"schema":{"type":"object","properties":{"expected_delivery_date":{"description":"The new card expected delivery date,format:yyyy-mm-dd","type":"string","maxLength":30},"custom_fields":{"description":"Custom fields associated with the entity.","type":"array","items":{"type":"object","required":["key"],"properties":{"key":{"type":"string","description":"custom field name","minLength":0,"maxLength":255},"value":{"type":"string","description":"custom field value","minLength":0,"maxLength":255}}}}}},"example":{"expected_delivery_date":"2024-07-11","custom_fields":[{"key":"expected_delivery_date","value":"2024-07-11"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Default":{"value":{"code":"1490000","message":"Bad request."}},"Pagination":{"value":{"code":"1490000","message":"Bad request.","fields":[{"name":"skip","description":"skip parameter not in a valid range."},{"name":"limit","description":"limit parameter not in a valid range."}]}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490001","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490002","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490003","message":"Resource not found."}}}}}}},"/fsi/contacts/{contact_id}/payments/ach":{"post":{"tags":["FSI Set ACH Transfer"],"summary":"Set up ACH transfers from their external bank accounts to their internal accounts or loans","description":"Set up ACH transfers from their external bank accounts to their internal accounts or loans","security":[{"GA":["fsi-set-ach-transfer:write"]}],"parameters":[{"in":"path","name":"contact_id","schema":{"type":"string"},"required":true,"description":"The contact id"},{"in":"query","name":"interaction_id","schema":{"type":"string"},"required":false,"description":"The interaction id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["transfer_type","source_account_number","target_account_number","currency","payment_amount","payment_type","payment_date"],"properties":{"transfer_type":{"description":"transfer type","type":"string","maxLength":22,"enum":["EXTERNAL","INTERNAL"]},"source_account_number":{"description":"source account number","type":"string","maxLength":30},"target_account_number":{"description":"target account number","type":"string","maxLength":30},"routing_number":{"description":"routing number","type":"string","maxLength":50},"direction":{"description":"transfer money direction","type":"string","maxLength":30,"enum":["IN","OUT"]},"currency":{"description":"currency","type":"string","maxLength":30},"payment_amount":{"description":"payment amount","type":"string","maxLength":30},"payment_type":{"description":"payment type","type":"string","maxLength":30,"enum":["ONCE","RECURRING"]},"payment_frequency":{"description":"payment frequency","type":"string","maxLength":30,"enum":["DAILY","WEEKLY","BIWEEKLY","MONTHLY","QUARTERLY","SEMIANNUALLY","ANNUALLY"]},"payment_date":{"description":"payment date","type":"string","maxLength":30},"waive_fee":{"description":"waive fee","type":"boolean"},"remark":{"description":"remark","type":"string","maxLength":100}}},"example":{"transfer_type":"EXTERNAL","source_account_number":"0060211001","target_account_number":"0060211002","routing_number":"111000024","direction":"IN","payment_amount":"10.00","currency":"USD","payment_type":"RECURRING","payment_frequency":"WEEKLY","payment_date":"2024-11-01","waive_fee":false,"remark":"this is ach payment"}}}},"responses":{"200":{"description":"The set ach transfer response.","content":{"application/json":{"schema":{"type":"object","properties":{"confirmation_code":{"description":"The confirmation Code","type":"string","maxLength":30}}},"example":{"confirmation_code":"successful request"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Default":{"value":{"code":"1490000","message":"Bad request."}},"Pagination":{"value":{"code":"1490000","message":"Bad request.","fields":[{"name":"skip","description":"skip parameter not in a valid range."},{"name":"limit","description":"limit parameter not in a valid range."}]}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490001","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490002","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490003","message":"Resource not found."}}}}}}},"/fsi/unlock/{contact_id}/pin/generate":{"post":{"tags":["FSI Unlock Account"],"summary":"Enable users to generate a temporary pin for unlocking account as first step.","description":"Generate a temporary pin and send it to customer's mobile phone","security":[{"GA":["fsi-unlock-account:write"]}],"parameters":[{"in":"path","name":"contact_id","schema":{"type":"string"},"required":true,"description":"The contact id"},{"in":"query","name":"interaction_id","schema":{"type":"string"},"required":false,"description":"The interaction id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["account_number","card_id","action"],"properties":{"account_number":{"description":"The account number","type":"string","maxLength":22},"card_id":{"description":"The card id","type":"string","maxLength":22},"action":{"description":"Operation to be performed. such as \"generate_temp_pin\" ,\"validation_temp_pin\"","type":"string","maxLength":30}}},"example":{"account_number":"0060211001","card_id":"006751314","action":"generate_temp_pin"}}}},"responses":{"200":{"description":"The generate temporary pin response.","content":{"application/json":{"schema":{"type":"object","required":["tem_pin","action_status"],"properties":{"tem_pin":{"description":"The temporary pin","type":"string","maxLength":22},"action_status":{"description":"The result of the action","type":"string","maxLength":30},"custom_fields":{"description":"Custom fields associated with the entity.","type":"array","items":{"type":"object","required":["key"],"properties":{"key":{"type":"string","description":"custom field name","minLength":0,"maxLength":255},"value":{"type":"string","description":"custom field value","minLength":0,"maxLength":255}}}}}},"example":{"tem_pin":"123456","action_status":"GENERATE_SUCCESS","custom_fields":[{"key":"tem_pin","value":"123456"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Default":{"value":{"code":"1490000","message":"Bad request."}},"Pagination":{"value":{"code":"1490000","message":"Bad request.","fields":[{"name":"skip","description":"skip parameter not in a valid range."},{"name":"limit","description":"limit parameter not in a valid range."}]}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490001","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490002","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490003","message":"Resource not found."}}}}}}},"/fsi/unlock/{contact_id}/pin/reset":{"post":{"tags":["FSI Unlock Account"],"summary":"Enable users to reset pin for unlocking account as second step.","description":"Verify temporary pin and reset pin","security":[{"GA":["fsi-unlock-account:write"]}],"parameters":[{"in":"path","name":"contact_id","schema":{"type":"string"},"required":true,"description":"The contact id"},{"in":"query","name":"interaction_id","schema":{"type":"string"},"required":false,"description":"The interaction id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["account_number","card_id","tem_pin","new_pin"],"properties":{"account_number":{"description":"The account number","type":"string","maxLength":22},"card_id":{"description":"The card id","type":"string","maxLength":30},"tem_pin":{"description":"The temporary pin has been sent to the client’s mobile number","type":"string","maxLength":22},"new_pin":{"description":"The new pin has been reset by the client","type":"string","maxLength":22}}},"example":{"account_number":"0060211001","card_id":"006751314","tem_pin":"123456","new_pin":"654321"}}}},"responses":{"200":{"description":"The generate temporary pin response.","content":{"application/json":{"schema":{"type":"object","required":["reset_status"],"properties":{"reset_status":{"description":"The status code for the result","type":"string","maxLength":30},"custom_fields":{"description":"Custom fields associated with the entity.","type":"array","items":{"type":"object","required":["key"],"properties":{"key":{"type":"string","description":"custom field name","minLength":0,"maxLength":255},"value":{"type":"string","description":"custom field value","minLength":0,"maxLength":255}}}}}},"example":{"reset_status":"RESET_SUCCESS","custom_fields":[{"key":"reset_status","value":"RESET_SUCCESS"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Default":{"value":{"code":"1490000","message":"Bad request."}},"Pagination":{"value":{"code":"1490000","message":"Bad request.","fields":[{"name":"skip","description":"skip parameter not in a valid range."},{"name":"limit","description":"limit parameter not in a valid range."}]}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490001","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490002","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490003","message":"Resource not found."}}}}}}},"/fsi/decrypt/{encrypt_key}/{encrypted_content}":{"get":{"tags":["FSI Accounts"],"summary":"The decryption based on AES algorithm","security":[{"GA":["fsi-decrypt:read"]}],"parameters":[{"name":"encrypt_key","in":"path","required":true,"description":"The encrypt key","schema":{"type":"string"}},{"name":"encrypted_content","in":"path","required":true,"description":"The encrypted content","schema":{"type":"string"}}],"responses":{"200":{"description":"The decrypted content","content":{"application/json":{"schema":{"type":"object","required":["decrypted_content"],"properties":{"decrypted_content":{"description":"The decrypted content","type":"string"}}},"example":{"decrypted_content":"The decrypted content"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490001","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490002","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490003","message":"Resource not found."}}}}}}},"/fsi/contacts/events/writeBack":{"post":{"tags":["FSI Write Data Back"],"summary":"Send any type of other information back to core system","description":"Send any type of other information back to core system","security":[{"GA":["fsi-write-back:write"]}],"parameters":[{"in":"query","name":"interaction_id","schema":{"type":"string"},"required":true,"description":"The interaction id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["event_name"],"properties":{"event_name":{"description":"event name","type":"string","maxLength":30},"event_date":{"description":"event date","type":"string","maxLength":30},"contact_id":{"description":"contact id","type":"string","maxLength":30},"interaction_id":{"description":"interaction id","type":"string","maxLength":50},"agent_id":{"description":"agent id","type":"string","maxLength":30},"industry":{"description":"industry","type":"string","maxLength":30},"additional_properties":{"type":"array","items":{"type":"object","properties":{"name":{"description":"name","type":"string","maxLength":30},"value":{"description":"value","type":"string","maxLength":30}}}}}},"example":{"event_name":"Write_Notes","event_date":"2024-10-30 12:00:00","contact_id":"0000602110","interaction_id":"8162246a58e64007afc96c06df86b59d","agent_id":"agt-125","industry":"fsi","additional_properties":[{"name":"note1","value":"this is note 1"}]}}}},"responses":{"200":{"description":"The set ach transfer response.","content":{"application/json":{"schema":{"type":"object","properties":{"event_id":{"description":"event id","type":"string","maxLength":30},"event_name":{"description":"event name","type":"string","maxLength":30},"additional_properties":{"type":"array","items":{"type":"object","properties":{"name":{"description":"name","type":"string","maxLength":30},"value":{"description":"value","type":"string","maxLength":30}}}}}},"example":{"event_id":"0098765","event_name":"op-01","additional_properties":[{"name":"note1","value":"this is note 1"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Default":{"value":{"code":"1490000","message":"Bad request."}},"Pagination":{"value":{"code":"1490000","message":"Bad request.","fields":[{"name":"skip","description":"skip parameter not in a valid range."},{"name":"limit","description":"limit parameter not in a valid range."}]}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490001","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490002","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490003","message":"Resource not found."}}}}}}},"/fsi/contacts/{contact_id}/cards/{card_id}/spendLimits":{"get":{"tags":["FSI Spend Limit"],"summary":"Used the card ID to query the daily limit of the card","description":"This is the interface for querying daily limits","security":[{"GA":["fsi-spend-limit:read"]}],"parameters":[{"in":"path","name":"contact_id","schema":{"type":"string","minLength":1,"maxLength":50},"required":true,"description":"The contact id"},{"in":"path","name":"card_id","schema":{"type":"string","minLength":1,"maxLength":50},"required":true,"description":"The card id"},{"in":"query","name":"interaction_id","schema":{"type":"string","minLength":1,"maxLength":50},"required":false,"description":"The interaction id"}],"responses":{"200":{"description":"The card information.","content":{"application/json":{"schema":{"type":"object","required":["card_id","spend_limit_controls"],"properties":{"id":{"description":"The primary id","type":"string","maxLength":22},"card_id":{"description":"The debit card id","type":"string","maxLength":22},"reason":{"description":"Reasons for modifying the daily limit of debit cards","type":"string","maxLength":500},"is_one_day_only":{"description":"Is it possible to only modify the limit for one day's time","type":"boolean"},"spend_limit_controls":{"type":"object","required":["maximum_authorizations_frequency"],"properties":{"maximum_authorizations_frequency":{"description":"Code that indicates the frequency for the maximum authorization parameters.","type":"string","maxLength":7},"maximum_atm_cash_authorizations_amount":{"maxLength":17,"description":"Maximum amount in monetary units and subunits of ATM cash authorizations allowed for this Embosser entity for the frequency defined in the FREQ field.","type":"string"},"maximum_atm_cash_authorizations_count":{"maximum":7,"minimum":1,"description":"Maximum number of ATM cash authorizations allowed for this Embosser entity for the frequency defined in the FREQ field.","type":"integer"},"maximum_single_atm_transaction_amount":{"maxLength":17,"description":"Maximum authorization amount in monetary units and subunits of a single ATM transaction allowed for this Embosser entity for the frequency defined in the FREQ field.","type":"string"},"maximum_otc_cash_authorizations_amount":{"maxLength":17,"description":"Maximum amount in monetary units and subunits of OTC cash authorizations allowed for this Embosser entity for the frequency defined in the FREQ field.","type":"string"},"maximum_otc_authorizations_count":{"maximum":7,"minimum":1,"description":"Maximum number of OTC authorizations allowed for this Embosser entity for the frequency defined in the FREQ field.","type":"integer"},"maximum_single_otc_cash_authorization_amount":{"maxLength":17,"description":"Maximum amount in monetary units and subunits of OTC authorizations allowed for this Embosser entity for the frequency defined in the FREQ field.","type":"string"},"maximum_retail_authorizations_amount":{"maxLength":17,"description":"Maximum amount in monetary units and subunits of retail authorizations allowed for this Embosser entity for the frequency defined in the FREQ field.","type":"string"},"maximum_retail_authorizations_count":{"maximum":7,"minimum":1,"description":"Maximum number of retail authorizations allowed for this Embosser entity for the frequency defined in the FREQ field.","type":"integer"},"maximum_single_retail_authorization_amount":{"maxLength":17,"description":"Maximum amount in monetary units and subunits of OTC authorizations allowed for this Embosser entity for the frequency defined in the FREQ field.","type":"string"}}},"custom_fields":{"description":"Custom fields associated with the entity.","type":"array","items":{"type":"object","required":["key"],"properties":{"key":{"type":"string","description":"custom field name"},"value":{"type":"string","description":"custom field value"}}}}},"example":{"id":"id","card_id":"Card Id","reason":"Reasons for modifying the daily limit of debit cards","is_one_day_only":false,"spend_limit_controls":{"maximum_authorizations_frequency":"1","maximum_atm_cash_authorizations_amount":"10000.00","maximum_atm_cash_authorizations_count":1,"maximum_single_atm_transaction_amount":"10000.00","maximum_otc_cash_authorizations_amount":"20000.00","maximum_otc_authorizations_count":1,"maximum_single_otc_cash_authorization_amount":"10000.00","maximum_retail_authorizations_amount":"10000.00","maximum_retail_authorizations_count":1,"maximum_single_retail_authorization_amount":"10000.00"},"custom_fields":[{"key":"sample_key","value":"sample_value"}]}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Default":{"value":{"code":"1490000","message":"Bad request."}},"Pagination":{"value":{"code":"1490000","message":"Bad request.","fields":[{"name":"skip","description":"skip parameter not in a valid range."},{"name":"limit","description":"limit parameter not in a valid range."}]}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490001","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490002","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490003","message":"Resource not found."}}}}}},"put":{"tags":["FSI Spend Limit"],"summary":"Modify daily limit.","description":"Modify daily limit","security":[{"GA":["fsi-spend-limit:write"]}],"parameters":[{"in":"path","name":"contact_id","schema":{"type":"string","minLength":1,"maxLength":50},"required":true,"description":"The contact id"},{"in":"path","name":"card_id","schema":{"type":"string","minLength":1,"maxLength":50},"required":true,"description":"The card id"},{"in":"query","name":"interaction_id","schema":{"type":"string","minLength":1,"maxLength":50},"required":false,"description":"The interaction id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["spend_limit_controls"],"properties":{"reason":{"description":"Reasons for modifying the daily limit of debit cards","type":"string","minLength":1,"maxLength":500},"is_one_day_only":{"description":"Is it possible to only modify the limit for one day's time","type":"boolean"},"spend_limit_controls":{"type":"object","description":"Spend limit controls","required":["maximum_authorizations_frequency"],"properties":{"maximum_authorizations_frequency":{"description":"Code that indicates the frequency for the maximum authorization parameters.","type":"string","maxLength":7},"maximum_atm_cash_authorizations_amount":{"maxLength":17,"description":"Maximum amount in monetary units and subunits of ATM cash authorizations allowed for this Embosser entity for the frequency defined in the FREQ field.","type":"string"},"maximum_atm_cash_authorizations_count":{"maximum":7,"minimum":1,"description":"Maximum number of ATM cash authorizations allowed for this Embosser entity for the frequency defined in the FREQ field.","type":"integer"},"maximum_single_atm_transaction_amount":{"maxLength":17,"description":"Maximum authorization amount in monetary units and subunits of a single ATM transaction allowed for this Embosser entity for the frequency defined in the FREQ field.","type":"string"},"maximum_otc_cash_authorizations_amount":{"maxLength":17,"description":"Maximum amount in monetary units and subunits of OTC cash authorizations allowed for this Embosser entity for the frequency defined in the FREQ field.","type":"string"},"maximum_otc_authorizations_count":{"maximum":7,"minimum":1,"description":"Maximum number of OTC authorizations allowed for this Embosser entity for the frequency defined in the FREQ field.","type":"integer"},"maximum_single_otc_cash_authorization_amount":{"maxLength":17,"description":"Maximum amount in monetary units and subunits of OTC authorizations allowed for this Embosser entity for the frequency defined in the FREQ field.","type":"string"},"maximum_retail_authorizations_amount":{"maxLength":17,"description":"Maximum amount in monetary units and subunits of retail authorizations allowed for this Embosser entity for the frequency defined in the FREQ field.","type":"string"},"maximum_retail_authorizations_count":{"maximum":7,"minimum":1,"description":"Maximum number of retail authorizations allowed for this Embosser entity for the frequency defined in the FREQ field.","type":"integer"},"maximum_single_retail_authorization_amount":{"maxLength":17,"description":"Maximum amount in monetary units and subunits of OTC authorizations allowed for this Embosser entity for the frequency defined in the FREQ field.","type":"string"}}}},"example":{"card_id":"Card Id","reason":"Reasons for modifying the daily limit of debit cards","is_one_day_only":false,"spend_limit_controls":{"maximum_authorizations_frequency":"1","maximum_atm_cash_authorizations_amount":"10000.00","maximum_atm_cash_authorizations_count":1,"maximum_single_atm_transaction_amount":"10000.00","maximum_otc_cash_authorizations_amount":"20000.00","maximum_otc_authorizations_count":1,"maximum_single_otc_cash_authorization_amount":"10000.00","maximum_retail_authorizations_amount":"10000.00","maximum_retail_authorizations_count":1,"maximum_single_retail_authorization_amount":"10000.00"}}}}}},"responses":{"200":{"description":"The stop payment response.","content":{"application/json":{"schema":{"type":"object","required":["card_id","spend_limit_controls"],"properties":{"id":{"description":"The primary id","type":"string","maxLength":22},"card_id":{"description":"The debit card id","type":"string","maxLength":22},"reason":{"description":"Reasons for modifying the daily limit of debit cards","type":"string","maxLength":500},"is_one_day_only":{"description":"Is it possible to only modify the limit for one day's time","type":"boolean"},"spend_limit_controls":{"type":"object","required":["maximum_authorizations_frequency"],"properties":{"maximum_authorizations_frequency":{"description":"Code that indicates the frequency for the maximum authorization parameters.","type":"string","maxLength":7},"maximum_atm_cash_authorizations_amount":{"maxLength":17,"description":"Maximum amount in monetary units and subunits of ATM cash authorizations allowed for this Embosser entity for the frequency defined in the FREQ field.","type":"string"},"maximum_atm_cash_authorizations_count":{"maximum":7,"minimum":1,"description":"Maximum number of ATM cash authorizations allowed for this Embosser entity for the frequency defined in the FREQ field.","type":"integer"},"maximum_single_atm_transaction_amount":{"maxLength":17,"description":"Maximum authorization amount in monetary units and subunits of a single ATM transaction allowed for this Embosser entity for the frequency defined in the FREQ field.","type":"string"},"maximum_otc_cash_authorizations_amount":{"maxLength":17,"description":"Maximum amount in monetary units and subunits of OTC cash authorizations allowed for this Embosser entity for the frequency defined in the FREQ field.","type":"string"},"maximum_otc_authorizations_count":{"maximum":7,"minimum":1,"description":"Maximum number of OTC authorizations allowed for this Embosser entity for the frequency defined in the FREQ field.","type":"integer"},"maximum_single_otc_cash_authorization_amount":{"maxLength":17,"description":"Maximum amount in monetary units and subunits of OTC authorizations allowed for this Embosser entity for the frequency defined in the FREQ field.","type":"string"},"maximum_retail_authorizations_amount":{"maxLength":17,"description":"Maximum amount in monetary units and subunits of retail authorizations allowed for this Embosser entity for the frequency defined in the FREQ field.","type":"string"},"maximum_retail_authorizations_count":{"maximum":7,"minimum":1,"description":"Maximum number of retail authorizations allowed for this Embosser entity for the frequency defined in the FREQ field.","type":"integer"},"maximum_single_retail_authorization_amount":{"maxLength":17,"description":"Maximum amount in monetary units and subunits of OTC authorizations allowed for this Embosser entity for the frequency defined in the FREQ field.","type":"string"}}},"custom_fields":{"description":"Custom fields associated with the entity.","type":"array","items":{"type":"object","required":["key"],"properties":{"key":{"type":"string","description":"custom field name"},"value":{"type":"string","description":"custom field value"}}}}},"example":{"id":"id","card_id":"Card Id","reason":"Reasons for modifying the daily limit of debit cards","is_one_day_only":false,"spend_limit_controls":{"maximum_authorizations_frequency":"1","maximum_atm_cash_authorizations_amount":"10000.00","maximum_atm_cash_authorizations_count":1,"maximum_single_atm_transaction_amount":"10000.00","maximum_otc_cash_authorizations_amount":"20000.00","maximum_otc_authorizations_count":1,"maximum_single_otc_cash_authorization_amount":"10000.00","maximum_retail_authorizations_amount":"10000.00","maximum_retail_authorizations_count":1,"maximum_single_retail_authorization_amount":"10000.00"},"custom_fields":[{"key":"sample_key","value":"sample_value"}]}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Default":{"value":{"code":"1490000","message":"Bad request."}},"Pagination":{"value":{"code":"1490000","message":"Bad request.","fields":[{"name":"skip","description":"skip parameter not in a valid range."},{"name":"limit","description":"limit parameter not in a valid range."}]}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490001","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490002","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490003","message":"Resource not found."}}}}}}},"/automated-notifications/account":{"get":{"tags":["Automated Notifications"],"summary":"Get Account configuration","description":"Retrieves an Account configuration.","operationId":"getAccountConfiguration","security":[{"GA":["automated-notifications-management:read"]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","required":["id","account_rules","_links"],"properties":{"id":{"type":"string","description":"The id of the Account.","minLength":1},"account_rules":{"type":"array","items":{"type":"object","required":["event_type","rules"],"properties":{"event_type":{"type":"string","description":"The event type of the account rule.","minLength":1},"rules":{"type":"array","items":{"type":"object","required":["id","name","action_type","action_data","trigger_on","discard_out_of_available_interval","include_conversation_history"],"properties":{"id":{"type":"string","description":"The id of the Rule.","minLength":1},"name":{"type":"string","description":"The name of the Rule.","minLength":1},"action_type":{"type":"string","description":"The action type triggered by this Rule.","minLength":1,"enum":["STUDIO_FLOW_TRIGGER","NO_AUTH_HTTP_TRIGGER"]},"action_data":{"anyOf":[{"type":"object","description":"The data for STUDIO_FLOW_TRIGGER actions.","required":["url","flow_group_id"],"properties":{"url":{"type":"string","description":"The URL to be used when triggering the studio flow.","minLength":1,"format":"uri"},"flow_group_id":{"type":"string","description":"The id of the flow group.","minLength":1}}},{"type":"object","description":"The data for NO_AUTH_HTTP_TRIGGER actions.","required":["url"],"properties":{"url":{"type":"string","description":"The URL to be used when triggering the HTTP request.","minLength":1,"format":"uri"}}}]},"trigger_on":{"type":"string","description":"The trigger type the rule should be triggered on.","minLength":1,"enum":["PRIMARY_EVENT_DATE","SECONDARY_EVENT_DATE"]},"trigger_on_offset":{"type":"object","description":"The time interval. This interval refers to a time offset composed of a time-unit type and value (e.g. type=HOUR, value=2 refers to two hour past a certain date).","required":["type","value"],"properties":{"type":{"type":"string","description":"The type of time interval.","minLength":1,"enum":["HOUR","DAY","WEEK"]},"value":{"type":"number","description":"The value relative to the interval's type. This value can also be negative.","format":"int32"}}},"recurrence":{"type":"object","description":"The recurrency configuration of an event.","required":["periodicity","stop_on"],"properties":{"periodicity":{"type":"object","description":"The time interval. This interval refers to a time offset composed of a time-unit type and value (e.g. type=HOUR, value=2 refers to two hour past a certain date).","required":["type","value"],"properties":{"type":{"type":"string","description":"The type of time interval.","minLength":1,"enum":["HOUR","DAY","WEEK"]},"value":{"type":"number","description":"The value relative to the interval's type. This value can also be negative.","format":"int32"}}},"stop_on":{"type":"string","description":"The trigger type that will stop the event recurrency.","minLength":1,"enum":["FIXED_NUMBER","PRIMARY_EVENT_DATE","SECONDARY_EVENT_DATE"]},"stop_date":{"type":"object","description":"The time interval. This interval refers to a time offset composed of a time-unit type and value (e.g. type=HOUR, value=2 refers to two hour past a certain date).","required":["type","value"],"properties":{"type":{"type":"string","description":"The type of time interval.","minLength":1,"enum":["HOUR","DAY","WEEK"]},"value":{"type":"number","description":"The value relative to the interval's type. This value can also be negative.","format":"int32"}}},"occurrences":{"type":"number","description":"The number of times an event must occur if the stop on property is set to a FIXED_NUMBER.","format":"int32"}}},"discard_out_of_available_interval":{"type":"boolean","description":"Should discard event notifications out of available interval."},"include_conversation_history":{"type":"boolean","description":"Include the conversation history in the Rule."},"escalate_touchpoint_id":{"type":"string","description":"The Touchpoint id for escalation."},"calendar_preferences":{"type":"array","items":{"type":"object","description":"The calendar week day configuration for a certain date interval.","required":["week_days"],"properties":{"week_days":{"type":"array","items":{"type":"string","description":"The week day.","minLength":1,"enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"start_at":{"type":"string","description":"The start date.","minLength":1,"format":"date-time"},"end_at":{"type":"string","description":"The end date.","minLength":1,"format":"date-time"}}}},"topic_ids":{"type":"array","items":{"type":"string","description":"The Topic id.","minLength":1}}}}}}}},"_links":{"type":"object","properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string","format":"uri","minLength":1}}}}}}},"example":{"id":"50193472069b406001g8fa95","account_rules":[{"event_type":"appointment_booked","rules":[{"id":"700fca3d-848e-4af7-bc74-3c0a1193510b","name":"triggered_on_primary_event_date_for_3_consecutive_days","action_type":"STUDIO_FLOW_TRIGGER","action_data":{"url":"https://api.example.com/flows/60bece631304ae6f04abc3fb/interactions"},"trigger_on":"PRIMARY_EVENT_DATE","recurrence":{"periodicity":{"type":"DAY","value":1},"stop_on":"FIXED_NUMBER","occurrences":3},"discard_out_of_available_interval":true,"include_conversation_history":false,"escalate_touchpoint_id":"10e23013-f723-462a-a29c-4822e7065524"}]}],"_links":{"self":{"href":"https://api.example.com/automated-notifications/account"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1414010","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1414030","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1414040","message":"Resource not found."}}}}}},"delete":{"tags":["Automated Notifications"],"summary":"Delete Account configuration","description":"Deletes an Account configuration.","operationId":"deleteAccountConfiguration","security":[{"GA":["automated-notifications-management:write"]}],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1414010","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1414030","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1414040","message":"Resource not found."}}}}}}},"/automated-notifications/event-types":{"get":{"tags":["Automated Notifications"],"summary":"Get Event Types","description":"Retrieve list of event types","operationId":"getEventTypes","security":[{"GA":["automated-notifications-management:read"]}],"parameters":[{"name":"skip","in":"query","description":"The start index to fetch the event types.","required":false,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":2147483647,"default":0,"example":0}},{"name":"limit","in":"query","description":"The total amount of event types to be fetched.","required":false,"schema":{"type":"integer","format":"int32","minimum":1,"maximum":100,"default":50,"example":50}},{"name":"ids","in":"query","description":"Filter by event type 'id'","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"List of event types","content":{"application/json":{"schema":{"type":"object","required":["_embedded","total"],"properties":{"_embedded":{"type":"object","required":["event-types"],"properties":{"event-types":{"type":"array","items":{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","minLength":1,"description":"The id of the event type."},"name":{"type":"string","minLength":1,"description":"The name of the event type."},"updated_at":{"type":"string","format":"date-time","description":"The update date."}}}}}},"total":{"type":"integer","format":"int32"}}},"example":{"_embedded":{"event-types":[{"id":"event_type_1","name":"Name 1","updated_at":"2022-01-19T14:00:00.000Z"},{"id":"event_type_2","name":"Name 2","updated_at":"2022-01-19T15:00:00.000Z"}]},"total":2}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1414000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1414010","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1414030","message":"Required scopes are missing."}}}}}},"post":{"tags":["Automated Notifications"],"summary":"Create a new event type","operationId":"createEventType","security":[{"GA":["automated-notifications-management:write"]}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","minLength":1,"description":"The id of the event type."},"name":{"type":"string","minLength":1,"description":"The name of the event type."},"updated_at":{"type":"string","format":"date-time","description":"The update date."}}},"examples":{"Create event type":{"value":{"id":"event_type_1","name":"Name 1","updated_at":"2022-01-19T15:00:00.000Z"}}}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","minLength":1,"description":"The id of the event type."},"name":{"type":"string","minLength":1,"description":"The name of the event type."},"updated_at":{"type":"string","format":"date-time","description":"The update date."}}},"example":{"id":"event_type_1","name":"Name 1","updated_at":"2022-01-19T15:00:00.000Z"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1414010","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1414030","message":"Required scopes are missing."}}}}}}},"/automated-notifications/event-types/{id}":{"get":{"tags":["Automated Notifications"],"summary":"Get Event Type by id","description":"Retrieve the event type","operationId":"getEventType","security":[{"GA":["automated-notifications-management:read"]}],"parameters":[{"name":"id","in":"path","description":"The id of the event type.","required":true,"schema":{"type":"string","x-filterable":true,"minLength":1,"example":"book_appointment"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","minLength":1,"description":"The id of the event type."},"name":{"type":"string","minLength":1,"description":"The name of the event type."},"updated_at":{"type":"string","format":"date-time","description":"The update date."}}},"example":{"id":"event_type_1","name":"Name 1","updated_at":"2022-01-19T15:00:00.000Z"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1414010","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1414030","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1414040","message":"Resource not found."}}}}}},"put":{"tags":["Automated Notifications"],"summary":"Update a event type","operationId":"updateEventType","security":[{"GA":["automated-notifications-management:write"]}],"parameters":[{"name":"id","in":"path","description":"The id of the event type.","required":true,"schema":{"type":"string","minLength":1,"example":"book_appointment"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","minLength":1,"description":"The id of the event type."},"name":{"type":"string","minLength":1,"description":"The name of the event type."},"updated_at":{"type":"string","format":"date-time","description":"The update date."}}},"examples":{"Create event type":{"value":{"id":"event_type_1","name":"Name 1","updated_at":"2022-01-19T15:00:00.000Z"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","minLength":1,"description":"The id of the event type."},"name":{"type":"string","minLength":1,"description":"The name of the event type."},"updated_at":{"type":"string","format":"date-time","description":"The update date."}}},"example":{"id":"event_type_1","name":"Name 1","updated_at":"2022-01-19T15:00:00.000Z"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1414010","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1414030","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1414040","message":"Resource not found."}}}}}},"delete":{"tags":["Automated Notifications"],"summary":"Delete a event type","operationId":"deleteEventType","security":[{"GA":["automated-notifications-management:write"]}],"parameters":[{"name":"id","in":"path","description":"The id of the event type.","required":true,"schema":{"type":"string","minLength":1,"example":"book_appointment"}}],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1414010","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1414030","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1414040","message":"Resource not found."}}}}}}},"/automated-notifications/rules":{"put":{"tags":["Automated Notifications"],"summary":"Create or update Rule","description":"Creates or updates a Rule.","operationId":"upsertRule","security":[{"GA":["automated-notifications-management:write"]}],"parameters":[{"name":"event_type","in":"query","description":"The value of the event type to match with Events.","required":true,"schema":{"type":"string","minLength":1,"example":"appointment_booked"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["name","action_type","action_data","trigger_on","discard_out_of_available_interval","include_conversation_history"],"properties":{"id":{"type":"string","description":"The id of the Rule.","minLength":1},"name":{"type":"string","description":"The name of the Rule.","minLength":1},"action_type":{"type":"string","description":"The action type triggered by this Rule.","minLength":1,"enum":["STUDIO_FLOW_TRIGGER","NO_AUTH_HTTP_TRIGGER"]},"action_data":{"anyOf":[{"type":"object","description":"The data for STUDIO_FLOW_TRIGGER actions.","required":["url","flow_group_id"],"properties":{"url":{"type":"string","description":"The URL to be used when triggering the studio flow.","minLength":1,"format":"uri"},"flow_group_id":{"type":"string","description":"The id of the flow group.","minLength":1}}},{"type":"object","description":"The data for NO_AUTH_HTTP_TRIGGER actions.","required":["url"],"properties":{"url":{"type":"string","description":"The URL to be used when triggering the HTTP request.","minLength":1,"format":"uri"}}}]},"trigger_on":{"type":"string","description":"The trigger type the rule should be triggered on.","minLength":1,"enum":["PRIMARY_EVENT_DATE","SECONDARY_EVENT_DATE"]},"trigger_on_offset":{"type":"object","description":"The time interval. This interval refers to a time offset composed of a time-unit type and value (e.g. type=HOUR, value=2 refers to two hour past a certain date).","required":["type","value"],"properties":{"type":{"type":"string","description":"The type of time interval.","minLength":1,"enum":["HOUR","DAY","WEEK"]},"value":{"type":"number","description":"The value relative to the interval's type. This value can also be negative.","format":"int32"}}},"recurrence":{"type":"object","description":"The recurrency configuration of an event.","required":["periodicity","stop_on"],"properties":{"periodicity":{"type":"object","description":"The time interval. This interval refers to a time offset composed of a time-unit type and value (e.g. type=HOUR, value=2 refers to two hour past a certain date).","required":["type","value"],"properties":{"type":{"type":"string","description":"The type of time interval.","minLength":1,"enum":["HOUR","DAY","WEEK"]},"value":{"type":"number","description":"The value relative to the interval's type. This value can also be negative.","format":"int32"}}},"stop_on":{"type":"string","description":"The trigger type that will stop the event recurrency.","minLength":1,"enum":["FIXED_NUMBER","PRIMARY_EVENT_DATE","SECONDARY_EVENT_DATE"]},"stop_date":{"type":"object","description":"The time interval. This interval refers to a time offset composed of a time-unit type and value (e.g. type=HOUR, value=2 refers to two hour past a certain date).","required":["type","value"],"properties":{"type":{"type":"string","description":"The type of time interval.","minLength":1,"enum":["HOUR","DAY","WEEK"]},"value":{"type":"number","description":"The value relative to the interval's type. This value can also be negative.","format":"int32"}}},"occurrences":{"type":"number","description":"The number of times an event must occur if the stop on property is set to a FIXED_NUMBER.","format":"int32"}}},"discard_out_of_available_interval":{"type":"boolean","description":"Should discard event notifications out of available interval."},"include_conversation_history":{"type":"boolean","description":"Include the conversation history in the Rule."},"escalate_touchpoint_id":{"type":"string","description":"The Touchpoint id for escalation."},"calendar_preferences":{"type":"array","items":{"type":"object","description":"The calendar week day configuration for a certain date interval.","required":["week_days"],"properties":{"week_days":{"type":"array","items":{"type":"string","description":"The week day.","minLength":1,"enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"start_at":{"type":"string","description":"The start date.","minLength":1,"format":"date-time"},"end_at":{"type":"string","description":"The end date.","minLength":1,"format":"date-time"}}}},"topic_ids":{"type":"array","items":{"type":"string","description":"The Topic id.","minLength":1}}}},"examples":{"Create Rule":{"value":{"name":"triggered_on_primary_event_date_for_3_consecutive_days","action_type":"STUDIO_FLOW_TRIGGER","action_data":{"url":"https://api.example.com/flows/60bece631304ae6f04abc3fb/interactions","flow_group_id":"123456789"},"trigger_on":"PRIMARY_EVENT_DATE","recurrence":{"periodicity":{"type":"DAY","value":1},"stop_on":"FIXED_NUMBER","occurrences":3},"discard_out_of_available_interval":true,"include_conversation_history":false,"escalate_touchpoint_id":"10e23013-f723-462a-a29c-4822e7065524"}},"Update Rule":{"value":{"id":"700fca3d-848e-4af7-bc74-3c0a1193510b","name":"triggered_on_primary_event_date_for_3_consecutive_days","action_type":"STUDIO_FLOW_TRIGGER","action_data":{"url":"https://api.example.com/flows/60bece631304ae6f04abc3fb/interactions"},"trigger_on":"PRIMARY_EVENT_DATE","recurrence":{"periodicity":{"type":"DAY","value":1},"stop_on":"FIXED_NUMBER","occurrences":3},"discard_out_of_available_interval":true,"include_conversation_history":false,"escalate_touchpoint_id":"10e23013-f723-462a-a29c-4822e7065524"}}}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","required":["id","name","action_type","action_data","trigger_on","discard_out_of_available_interval","include_conversation_history"],"properties":{"id":{"type":"string","description":"The id of the Rule.","minLength":1},"name":{"type":"string","description":"The name of the Rule.","minLength":1},"action_type":{"type":"string","description":"The action type triggered by this Rule.","minLength":1,"enum":["STUDIO_FLOW_TRIGGER","NO_AUTH_HTTP_TRIGGER"]},"action_data":{"anyOf":[{"type":"object","description":"The data for STUDIO_FLOW_TRIGGER actions.","required":["url","flow_group_id"],"properties":{"url":{"type":"string","description":"The URL to be used when triggering the studio flow.","minLength":1,"format":"uri"},"flow_group_id":{"type":"string","description":"The id of the flow group.","minLength":1}}},{"type":"object","description":"The data for NO_AUTH_HTTP_TRIGGER actions.","required":["url"],"properties":{"url":{"type":"string","description":"The URL to be used when triggering the HTTP request.","minLength":1,"format":"uri"}}}]},"trigger_on":{"type":"string","description":"The trigger type the rule should be triggered on.","minLength":1,"enum":["PRIMARY_EVENT_DATE","SECONDARY_EVENT_DATE"]},"trigger_on_offset":{"type":"object","description":"The time interval. This interval refers to a time offset composed of a time-unit type and value (e.g. type=HOUR, value=2 refers to two hour past a certain date).","required":["type","value"],"properties":{"type":{"type":"string","description":"The type of time interval.","minLength":1,"enum":["HOUR","DAY","WEEK"]},"value":{"type":"number","description":"The value relative to the interval's type. This value can also be negative.","format":"int32"}}},"recurrence":{"type":"object","description":"The recurrency configuration of an event.","required":["periodicity","stop_on"],"properties":{"periodicity":{"type":"object","description":"The time interval. This interval refers to a time offset composed of a time-unit type and value (e.g. type=HOUR, value=2 refers to two hour past a certain date).","required":["type","value"],"properties":{"type":{"type":"string","description":"The type of time interval.","minLength":1,"enum":["HOUR","DAY","WEEK"]},"value":{"type":"number","description":"The value relative to the interval's type. This value can also be negative.","format":"int32"}}},"stop_on":{"type":"string","description":"The trigger type that will stop the event recurrency.","minLength":1,"enum":["FIXED_NUMBER","PRIMARY_EVENT_DATE","SECONDARY_EVENT_DATE"]},"stop_date":{"type":"object","description":"The time interval. This interval refers to a time offset composed of a time-unit type and value (e.g. type=HOUR, value=2 refers to two hour past a certain date).","required":["type","value"],"properties":{"type":{"type":"string","description":"The type of time interval.","minLength":1,"enum":["HOUR","DAY","WEEK"]},"value":{"type":"number","description":"The value relative to the interval's type. This value can also be negative.","format":"int32"}}},"occurrences":{"type":"number","description":"The number of times an event must occur if the stop on property is set to a FIXED_NUMBER.","format":"int32"}}},"discard_out_of_available_interval":{"type":"boolean","description":"Should discard event notifications out of available interval."},"include_conversation_history":{"type":"boolean","description":"Include the conversation history in the Rule."},"escalate_touchpoint_id":{"type":"string","description":"The Touchpoint id for escalation."},"calendar_preferences":{"type":"array","items":{"type":"object","description":"The calendar week day configuration for a certain date interval.","required":["week_days"],"properties":{"week_days":{"type":"array","items":{"type":"string","description":"The week day.","minLength":1,"enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"start_at":{"type":"string","description":"The start date.","minLength":1,"format":"date-time"},"end_at":{"type":"string","description":"The end date.","minLength":1,"format":"date-time"}}}},"topic_ids":{"type":"array","items":{"type":"string","description":"The Topic id.","minLength":1}}}},"example":{"id":"700fca3d-848e-4af7-bc74-3c0a1193510b","name":"triggered_on_primary_event_date_for_3_consecutive_days","action_type":"STUDIO_FLOW_TRIGGER","action_data":{"url":"https://api.example.com/flows/60bece631304ae6f04abc3fb/interactions"},"trigger_on":"PRIMARY_EVENT_DATE","recurrence":{"periodicity":{"type":"DAY","value":1},"stop_on":"FIXED_NUMBER","occurrences":3},"discard_out_of_available_interval":true,"include_conversation_history":false,"escalate_touchpoint_id":"10e23013-f723-462a-a29c-4822e7065524"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","required":["id","name","action_type","action_data","trigger_on","discard_out_of_available_interval","include_conversation_history"],"properties":{"id":{"type":"string","description":"The id of the Rule.","minLength":1},"name":{"type":"string","description":"The name of the Rule.","minLength":1},"action_type":{"type":"string","description":"The action type triggered by this Rule.","minLength":1,"enum":["STUDIO_FLOW_TRIGGER","NO_AUTH_HTTP_TRIGGER"]},"action_data":{"anyOf":[{"type":"object","description":"The data for STUDIO_FLOW_TRIGGER actions.","required":["url","flow_group_id"],"properties":{"url":{"type":"string","description":"The URL to be used when triggering the studio flow.","minLength":1,"format":"uri"},"flow_group_id":{"type":"string","description":"The id of the flow group.","minLength":1}}},{"type":"object","description":"The data for NO_AUTH_HTTP_TRIGGER actions.","required":["url"],"properties":{"url":{"type":"string","description":"The URL to be used when triggering the HTTP request.","minLength":1,"format":"uri"}}}]},"trigger_on":{"type":"string","description":"The trigger type the rule should be triggered on.","minLength":1,"enum":["PRIMARY_EVENT_DATE","SECONDARY_EVENT_DATE"]},"trigger_on_offset":{"type":"object","description":"The time interval. This interval refers to a time offset composed of a time-unit type and value (e.g. type=HOUR, value=2 refers to two hour past a certain date).","required":["type","value"],"properties":{"type":{"type":"string","description":"The type of time interval.","minLength":1,"enum":["HOUR","DAY","WEEK"]},"value":{"type":"number","description":"The value relative to the interval's type. This value can also be negative.","format":"int32"}}},"recurrence":{"type":"object","description":"The recurrency configuration of an event.","required":["periodicity","stop_on"],"properties":{"periodicity":{"type":"object","description":"The time interval. This interval refers to a time offset composed of a time-unit type and value (e.g. type=HOUR, value=2 refers to two hour past a certain date).","required":["type","value"],"properties":{"type":{"type":"string","description":"The type of time interval.","minLength":1,"enum":["HOUR","DAY","WEEK"]},"value":{"type":"number","description":"The value relative to the interval's type. This value can also be negative.","format":"int32"}}},"stop_on":{"type":"string","description":"The trigger type that will stop the event recurrency.","minLength":1,"enum":["FIXED_NUMBER","PRIMARY_EVENT_DATE","SECONDARY_EVENT_DATE"]},"stop_date":{"type":"object","description":"The time interval. This interval refers to a time offset composed of a time-unit type and value (e.g. type=HOUR, value=2 refers to two hour past a certain date).","required":["type","value"],"properties":{"type":{"type":"string","description":"The type of time interval.","minLength":1,"enum":["HOUR","DAY","WEEK"]},"value":{"type":"number","description":"The value relative to the interval's type. This value can also be negative.","format":"int32"}}},"occurrences":{"type":"number","description":"The number of times an event must occur if the stop on property is set to a FIXED_NUMBER.","format":"int32"}}},"discard_out_of_available_interval":{"type":"boolean","description":"Should discard event notifications out of available interval."},"include_conversation_history":{"type":"boolean","description":"Include the conversation history in the Rule."},"escalate_touchpoint_id":{"type":"string","description":"The Touchpoint id for escalation."},"calendar_preferences":{"type":"array","items":{"type":"object","description":"The calendar week day configuration for a certain date interval.","required":["week_days"],"properties":{"week_days":{"type":"array","items":{"type":"string","description":"The week day.","minLength":1,"enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"start_at":{"type":"string","description":"The start date.","minLength":1,"format":"date-time"},"end_at":{"type":"string","description":"The end date.","minLength":1,"format":"date-time"}}}},"topic_ids":{"type":"array","items":{"type":"string","description":"The Topic id.","minLength":1}}}},"example":{"id":"700fca3d-848e-4af7-bc74-3c0a1193510b","name":"triggered_on_primary_event_date_for_3_consecutive_days","action_type":"STUDIO_FLOW_TRIGGER","action_data":{"url":"https://api.example.com/flows/60bece631304ae6f04abc3fb/interactions"},"trigger_on":"PRIMARY_EVENT_DATE","recurrence":{"periodicity":{"type":"DAY","value":1},"stop_on":"FIXED_NUMBER","occurrences":3},"discard_out_of_available_interval":true,"include_conversation_history":false,"escalate_touchpoint_id":"10e23013-f723-462a-a29c-4822e7065524"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1414000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1414010","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1414030","message":"Required scopes are missing."}}}}}}},"/automated-notifications/rules/{rule_id}":{"get":{"tags":["Automated Notifications"],"summary":"Get rule by id","operationId":"getRule","security":[{"GA":["automated-notifications-management:read"]}],"parameters":[{"name":"rule_id","in":"path","description":"The id of the rule.","required":true,"schema":{"type":"string","x-filterable":true,"minLength":1,"example":"82ba9989-f98a-4aa5-8388-d75138629a76"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","required":["id","name","action_type","action_data","trigger_on","discard_out_of_available_interval","include_conversation_history","event_type"],"properties":{"id":{"type":"string","description":"The id of the Rule.","minLength":1},"name":{"type":"string","description":"The name of the Rule.","minLength":1},"action_type":{"type":"string","description":"The action type triggered by this Rule.","minLength":1,"enum":["STUDIO_FLOW_TRIGGER","NO_AUTH_HTTP_TRIGGER"]},"action_data":{"anyOf":[{"type":"object","description":"The data for STUDIO_FLOW_TRIGGER actions.","required":["url","flow_group_id"],"properties":{"url":{"type":"string","description":"The URL to be used when triggering the studio flow.","minLength":1,"format":"uri"},"flow_group_id":{"type":"string","description":"The id of the flow group.","minLength":1}}},{"type":"object","description":"The data for NO_AUTH_HTTP_TRIGGER actions.","required":["url"],"properties":{"url":{"type":"string","description":"The URL to be used when triggering the HTTP request.","minLength":1,"format":"uri"}}}]},"trigger_on":{"type":"string","description":"The trigger type the rule should be triggered on.","minLength":1,"enum":["PRIMARY_EVENT_DATE","SECONDARY_EVENT_DATE"]},"trigger_on_offset":{"type":"object","description":"The time interval. This interval refers to a time offset composed of a time-unit type and value (e.g. type=HOUR, value=2 refers to two hour past a certain date).","required":["type","value"],"properties":{"type":{"type":"string","description":"The type of time interval.","minLength":1,"enum":["HOUR","DAY","WEEK"]},"value":{"type":"number","description":"The value relative to the interval's type. This value can also be negative.","format":"int32"}}},"recurrence":{"type":"object","description":"The recurrency configuration of an event.","required":["periodicity","stop_on"],"properties":{"periodicity":{"type":"object","description":"The time interval. This interval refers to a time offset composed of a time-unit type and value (e.g. type=HOUR, value=2 refers to two hour past a certain date).","required":["type","value"],"properties":{"type":{"type":"string","description":"The type of time interval.","minLength":1,"enum":["HOUR","DAY","WEEK"]},"value":{"type":"number","description":"The value relative to the interval's type. This value can also be negative.","format":"int32"}}},"stop_on":{"type":"string","description":"The trigger type that will stop the event recurrency.","minLength":1,"enum":["FIXED_NUMBER","PRIMARY_EVENT_DATE","SECONDARY_EVENT_DATE"]},"stop_date":{"type":"object","description":"The time interval. This interval refers to a time offset composed of a time-unit type and value (e.g. type=HOUR, value=2 refers to two hour past a certain date).","required":["type","value"],"properties":{"type":{"type":"string","description":"The type of time interval.","minLength":1,"enum":["HOUR","DAY","WEEK"]},"value":{"type":"number","description":"The value relative to the interval's type. This value can also be negative.","format":"int32"}}},"occurrences":{"type":"number","description":"The number of times an event must occur if the stop on property is set to a FIXED_NUMBER.","format":"int32"}}},"discard_out_of_available_interval":{"type":"boolean","description":"Should discard event notifications out of available interval."},"include_conversation_history":{"type":"boolean","description":"Include the conversation history in the Rule."},"escalate_touchpoint_id":{"type":"string","description":"The Touchpoint id for escalation."},"calendar_preferences":{"type":"array","items":{"type":"object","description":"The calendar week day configuration for a certain date interval.","required":["week_days"],"properties":{"week_days":{"type":"array","items":{"type":"string","description":"The week day.","minLength":1,"enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"start_at":{"type":"string","description":"The start date.","minLength":1,"format":"date-time"},"end_at":{"type":"string","description":"The end date.","minLength":1,"format":"date-time"}}}},"topic_ids":{"type":"array","items":{"type":"string","description":"The Topic id.","minLength":1}},"created_date":{"type":"string","description":"The date when the Rule was created.","minLength":1,"format":"date-time"},"updated_date":{"type":"string","description":"The date when the Rule was updated.","minLength":1,"format":"date-time"},"event_type":{"description":"The event type of the rule.","type":"object","required":["id","name"],"properties":{"id":{"type":"string","minLength":1,"description":"The id of the event type."},"name":{"type":"string","minLength":1,"description":"The name of the event type."},"updated_at":{"type":"string","format":"date-time","description":"The update date."}}}}},"example":{"id":"700fca3d-848e-4af7-bc74-3c0a1193510b","name":"triggered_on_primary_event_date_for_3_consecutive_days","action_type":"STUDIO_FLOW_TRIGGER","action_data":{"url":"https://api.example.com/flows/60bece631304ae6f04abc3fb/interactions"},"trigger_on":"PRIMARY_EVENT_DATE","recurrence":{"periodicity":{"type":"DAY","value":1},"stop_on":"FIXED_NUMBER","occurrences":3},"discard_out_of_available_interval":true,"include_conversation_history":false,"escalate_touchpoint_id":"10e23013-f723-462a-a29c-4822e7065524","created_date":"2022-01-19T15:00:00.000Z","updated_date":"2022-01-20T15:00:00.000Z","event_type":{"id":"event_type_1","name":"Name 1","updated_at":"2022-01-18T15:00:00.000Z"}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1414010","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1414030","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1414040","message":"Resource not found."}}}}}},"delete":{"tags":["Automated Notifications"],"summary":"Delete Rule by id","description":"Deletes a Rule by id.","operationId":"deleteRule","security":[{"GA":["automated-notifications-management:write"]}],"parameters":[{"name":"rule_id","description":"The rule id.","in":"path","required":true,"schema":{"type":"string","minLength":1}}],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1414010","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1414030","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1414040","message":"Resource not found."}}}}}}},"/automated-notifications/events":{"get":{"tags":["Automated Notifications"],"summary":"Get Events","description":"Retrieves a list of Events. It can retrieve all the account's Events or by external id and/or by publisher name.","operationId":"getEvents","security":[{"GA":["automated-notifications:read"]}],"parameters":[{"name":"publisher_name","in":"query","description":"The name of the publisher that published the Event.","required":false,"schema":{"type":"string","x-filterable":true,"minLength":1,"example":"publisher_name"}},{"name":"external_id","in":"query","description":"The external id of the Event.","required":false,"schema":{"type":"string","x-filterable":true,"minLength":1,"example":"appointment_id_01"}},{"name":"page","in":"query","description":"The page to fetch.","required":false,"schema":{"type":"integer","format":"int32","minimum":1,"maximum":2147483647,"default":1,"example":1}},{"name":"per_page","in":"query","description":"The amount of Events to be shown per page.","required":false,"schema":{"type":"integer","format":"int32","minimum":1,"maximum":100,"default":50,"example":50}}],"responses":{"200":{"description":"List of Events","content":{"application/json":{"schema":{"type":"object","required":["_embedded","count","_links"],"properties":{"_embedded":{"type":"object","required":["events"],"properties":{"events":{"type":"array","items":{"required":["id","type","source","publisher_name","time_zone","primary_date","contacts","_links"],"type":"object","properties":{"id":{"description":"The id of the Event.","type":"string","minLength":1},"external_id":{"description":"The external id of the Event.","type":"string","minLength":1},"correlation_id":{"description":"The id used to correlate multiple Events.","type":"string","minLength":1},"publisher_name":{"description":"The name of the Event's publisher.","type":"string","minLength":1},"type":{"description":"The type of the Event.","type":"string","minLength":1},"source":{"description":"The source of the Event.","type":"string","minLength":1},"time_zone":{"description":"The timezone offset of the Event. It is used for example with the Rule's calendar preferences.","type":"string","minLength":1},"primary_date":{"description":"A date in UTC to use to schedule the notifications. The primary date is required.","type":"string","format":"date-time","minLength":1},"secondary_date":{"description":"A secondary date in UTC to use to schedule the notifications (can be used for example to represent the end date). It is not required.","type":"string","format":"date-time","minLength":1},"contacts":{"description":"The list of Contacts associated with this Event.","type":"array","items":{"required":["name","preferred_channel","channels"],"type":"object","properties":{"name":{"description":"The name of the Contact.","type":"string","minLength":1,"example":"John Doe"},"preferred_channel":{"description":"The preferred channel to use when sending notifications.","type":"string","minLength":1,"example":"email"},"channels":{"description":"The list of channels of the Contact.","type":"array","items":{"required":["type","uri"],"type":"object","properties":{"type":{"description":"The type of channel.","type":"string","minLength":1,"enum":["EMAIL","SMS","VOICE"]},"uri":{"description":"The channel uri (for instance email address or phone number).","type":"string","minLength":1,"example":"mailto:john.doe@talkdesk.com"}}},"minItems":1}}},"minItems":1},"data":{"description":"Data with specific properties of the Event.","type":"object","additionalProperties":{}},"_links":{"type":"object","properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string","format":"uri","minLength":1}}}}}}}}}},"count":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string","format":"uri","minLength":1}}},"next":{"type":"object","required":["href"],"properties":{"href":{"type":"string","format":"uri","minLength":1}}},"prev":{"type":"object","required":["href"],"properties":{"href":{"type":"string","format":"uri","minLength":1}}}}}}},"example":{"_embedded":{"events":[{"id":"82ba9989-f98a-4aa5-8388-d75138629a76","external_id":"appointment_id_01","type":"appointment_booked","source":"ehr_epic","publisher_name":"ehr_epic","time_zone":"+00:00","primary_date":"2021-02-22T11:00:00.000Z","secondary_date":"2021-02-22T11:30:00.000Z","contacts":[{"name":"John Doe","preferred_channel":"email","channels":[{"type":"EMAIL","uri":"mailto:john.doe@talkdesk.com"}]}],"data":{"assigned_doctor":"Jane Doe"},"_links":{"self":{"href":"https://api.example.com/automated-notifications/events/82ba9989-f98a-4aa5-8388-d75138629a76"}}}]},"count":1,"total":3,"_links":{"self":{"href":"https://api.example.com/automated-notifications/events?publisher_name=ehr_epic&external_id=appointment_id_01&page=2&per_page=1"},"next":{"href":"https://api.example.com/automated-notifications/events?publisher_name=ehr_epic&external_id=appointment_id_01&page=3&per_page=1"},"prev":{"href":"https://api.example.com/automated-notifications/events?publisher_name=ehr_epic&external_id=appointment_id_01&page=1&per_page=1"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1414000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1414010","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1414030","message":"Required scopes are missing."}}}}}},"post":{"tags":["Automated Notifications"],"summary":"Create Event","description":"Creates an Event and publishes an addedEvent.","operationId":"addEvent","security":[{"GA":["automated-notifications:write"]}],"parameters":[{"name":"publisher_name","in":"query","description":"The name of the publisher.","required":true,"schema":{"type":"string","minLength":1,"example":"ehr_epic"}}],"requestBody":{"description":"The Event to be created.","content":{"application/json":{"schema":{"required":["type","source","primary_date","time_zone","contacts"],"type":"object","properties":{"external_id":{"description":"The external id of the Event.","type":"string","minLength":1},"correlation_id":{"description":"The id used to correlate multiple Events.","type":"string","minLength":1},"type":{"description":"The type of the Event.","type":"string","minLength":1},"source":{"description":"The source of the Event.","type":"string","minLength":1},"time_zone":{"description":"The timezone offset of the Event. It is used for example with the Rule's calendar preferences.","type":"string","minLength":1},"primary_date":{"description":"A date in UTC to use to schedule the notifications. The primary date is required.","type":"string","format":"date-time","minLength":1},"secondary_date":{"description":"A secondary date in UTC to use to schedule the notifications (can be used for example to represent the end date). It is not required.","type":"string","format":"date-time","minLength":1},"contacts":{"description":"The list of Contacts associated with the Event.","type":"array","items":{"required":["name","preferred_channel","channels"],"type":"object","properties":{"name":{"description":"The name of the Contact.","type":"string","minLength":1,"example":"John Doe"},"preferred_channel":{"description":"The preferred channel to use when sending notifications.","type":"string","minLength":1,"example":"email"},"channels":{"description":"The list of channels of the Contact.","type":"array","items":{"required":["type","uri"],"type":"object","properties":{"type":{"description":"The type of channel.","type":"string","minLength":1,"enum":["EMAIL","SMS","VOICE"]},"uri":{"description":"The channel uri (for instance email address or phone number).","type":"string","minLength":1,"example":"mailto:john.doe@talkdesk.com"}}},"minItems":1}}},"minItems":1},"data":{"description":"Data with specific properties of the Event.","type":"object","additionalProperties":{}}}},"example":{"type":"appointment_booked","source":"ehr_epic","time_zone":"+00:00","primary_date":"2021-02-22T11:00:00.000Z","secondary_date":"2021-02-22T11:30:00.000Z","contacts":[{"name":"John Doe","preferred_channel":"email","channels":[{"type":"EMAIL","uri":"mailto:john.doe@talkdesk.com"}]}],"data":{"assigned_doctor":"Jane Doe"}}}},"required":true},"responses":{"201":{"description":"Event created","content":{"application/json":{"schema":{"required":["id","type","source","publisher_name","time_zone","primary_date","contacts","_links"],"type":"object","properties":{"id":{"description":"The id of the Event.","type":"string","minLength":1},"external_id":{"description":"The external id of the Event.","type":"string","minLength":1},"correlation_id":{"description":"The id used to correlate multiple Events.","type":"string","minLength":1},"publisher_name":{"description":"The name of the Event's publisher.","type":"string","minLength":1},"type":{"description":"The type of the Event.","type":"string","minLength":1},"source":{"description":"The source of the Event.","type":"string","minLength":1},"time_zone":{"description":"The timezone offset of the Event. It is used for example with the Rule's calendar preferences.","type":"string","minLength":1},"primary_date":{"description":"A date in UTC to use to schedule the notifications. The primary date is required.","type":"string","format":"date-time","minLength":1},"secondary_date":{"description":"A secondary date in UTC to use to schedule the notifications (can be used for example to represent the end date). It is not required.","type":"string","format":"date-time","minLength":1},"contacts":{"description":"The list of Contacts associated with this Event.","type":"array","items":{"required":["name","preferred_channel","channels"],"type":"object","properties":{"name":{"description":"The name of the Contact.","type":"string","minLength":1,"example":"John Doe"},"preferred_channel":{"description":"The preferred channel to use when sending notifications.","type":"string","minLength":1,"example":"email"},"channels":{"description":"The list of channels of the Contact.","type":"array","items":{"required":["type","uri"],"type":"object","properties":{"type":{"description":"The type of channel.","type":"string","minLength":1,"enum":["EMAIL","SMS","VOICE"]},"uri":{"description":"The channel uri (for instance email address or phone number).","type":"string","minLength":1,"example":"mailto:john.doe@talkdesk.com"}}},"minItems":1}}},"minItems":1},"data":{"description":"Data with specific properties of the Event.","type":"object","additionalProperties":{}},"_links":{"type":"object","properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string","format":"uri","minLength":1}}}}}}},"example":{"id":"82ba9989-f98a-4aa5-8388-d75138629a76","type":"appointment_booked","source":"ehr_epic","publisher_name":"ehr_epic","time_zone":"+00:00","primary_date":"2021-02-22T11:00:00.000Z","secondary_date":"2021-02-22T11:30:00.000Z","contacts":[{"name":"John Doe","preferred_channel":"email","channels":[{"type":"EMAIL","uri":"mailto:john.doe@talkdesk.com"}]}],"data":{"assigned_doctor":"Jane Doe"},"_links":{"self":{"href":"https://api.example.com/automated-notifications/events/82ba9989-f98a-4aa5-8388-d75138629a76"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1414000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1414010","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1414030","message":"Required scopes are missing."}}}}}}},"/automated-notifications/events/{event_id}":{"get":{"tags":["Automated Notifications"],"summary":"Get Event by id","description":"Retrieves an Event by id.","operationId":"getEvent","security":[{"GA":["automated-notifications:read"]}],"parameters":[{"name":"event_id","in":"path","description":"The id of the Event.","required":true,"schema":{"type":"string","x-filterable":true,"minLength":1,"example":"82ba9989-f98a-4aa5-8388-d75138629a76"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"required":["id","type","source","publisher_name","time_zone","primary_date","contacts","_links"],"type":"object","properties":{"id":{"description":"The id of the Event.","type":"string","minLength":1},"external_id":{"description":"The external id of the Event.","type":"string","minLength":1},"correlation_id":{"description":"The id used to correlate multiple Events.","type":"string","minLength":1},"publisher_name":{"description":"The name of the Event's publisher.","type":"string","minLength":1},"type":{"description":"The type of the Event.","type":"string","minLength":1},"source":{"description":"The source of the Event.","type":"string","minLength":1},"time_zone":{"description":"The timezone offset of the Event. It is used for example with the Rule's calendar preferences.","type":"string","minLength":1},"primary_date":{"description":"A date in UTC to use to schedule the notifications. The primary date is required.","type":"string","format":"date-time","minLength":1},"secondary_date":{"description":"A secondary date in UTC to use to schedule the notifications (can be used for example to represent the end date). It is not required.","type":"string","format":"date-time","minLength":1},"contacts":{"description":"The list of Contacts associated with this Event.","type":"array","items":{"required":["name","preferred_channel","channels"],"type":"object","properties":{"name":{"description":"The name of the Contact.","type":"string","minLength":1,"example":"John Doe"},"preferred_channel":{"description":"The preferred channel to use when sending notifications.","type":"string","minLength":1,"example":"email"},"channels":{"description":"The list of channels of the Contact.","type":"array","items":{"required":["type","uri"],"type":"object","properties":{"type":{"description":"The type of channel.","type":"string","minLength":1,"enum":["EMAIL","SMS","VOICE"]},"uri":{"description":"The channel uri (for instance email address or phone number).","type":"string","minLength":1,"example":"mailto:john.doe@talkdesk.com"}}},"minItems":1}}},"minItems":1},"data":{"description":"Data with specific properties of the Event.","type":"object","additionalProperties":{}},"_links":{"type":"object","properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string","format":"uri","minLength":1}}}}}}},"example":{"id":"82ba9989-f98a-4aa5-8388-d75138629a76","type":"appointment_booked","source":"ehr_epic","publisher_name":"ehr_epic","time_zone":"+00:00","primary_date":"2021-02-22T11:00:00.000Z","secondary_date":"2021-02-22T11:30:00.000Z","contacts":[{"name":"John Doe","preferred_channel":"email","channels":[{"type":"EMAIL","uri":"mailto:john.doe@talkdesk.com"}]}],"data":{"assigned_doctor":"Jane Doe"},"_links":{"self":{"href":"https://api.example.com/automated-notifications/events/82ba9989-f98a-4aa5-8388-d75138629a76"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1414010","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1414030","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1414040","message":"Resource not found."}}}}}},"delete":{"tags":["Automated Notifications"],"summary":"Delete Event by id","description":"Deletes an event by id and publishes a deletedEvent.","operationId":"deleteEvent","security":[{"GA":["automated-notifications:write"]}],"parameters":[{"name":"event_id","in":"path","description":"The id of the Event.","required":true,"schema":{"type":"string","minLength":1,"example":"82ba9989-f98a-4aa5-8388-d75138629a76"}},{"name":"publisher_name","in":"query","description":"The name of the publisher.","required":true,"schema":{"type":"string","minLength":1,"example":"ehr_epic"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1414000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1414010","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1414030","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1414040","message":"Resource not found."}}}}}}},"/automated-notifications/events/external-id/{external_id}":{"delete":{"tags":["Automated Notifications"],"summary":"Delete Events by external id","description":"Deletes the account's Events by external id and publishes deletedEvents.","operationId":"deleteEvents","security":[{"GA":["automated-notifications:write"]}],"parameters":[{"name":"external_id","in":"path","description":"The external id of the Event.","required":true,"schema":{"type":"string","minLength":1,"example":"appointment_id_01"}},{"name":"publisher_name","in":"query","description":"The name of the publisher.","required":true,"schema":{"type":"string","minLength":1,"example":"ehr_epic"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1414000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1414010","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1414030","message":"Required scopes are missing."}}}}}}},"/automated-notifications/topics":{"get":{"tags":["Automated Notifications"],"summary":"Get Topics","description":"Retrieves a list of the account's Topics.","operationId":"getTopics","security":[{"GA":["automated-notifications-management:read"]}],"parameters":[{"name":"include_deleted","in":"query","description":"Set this value a true to include the deleted Topics in the list.","required":false,"schema":{"type":"boolean","x-filterable":true,"minLength":1,"example":true}},{"name":"page","in":"query","description":"The page to fetch.","required":false,"schema":{"type":"integer","format":"int32","minimum":1,"maximum":2147483647,"default":1,"example":1}},{"name":"per_page","in":"query","description":"The amount of Topics to be shown per page.","required":false,"schema":{"type":"integer","format":"int32","minimum":1,"maximum":100,"default":50,"example":50}}],"responses":{"200":{"description":"List of the account's Topics","content":{"application/json":{"schema":{"type":"object","required":["_embedded","count","_links"],"properties":{"_embedded":{"type":"object","required":["topics"],"properties":{"topics":{"type":"array","items":{"type":"object","required":["id","name","requires_opt_in","_links"],"properties":{"id":{"type":"string","minLength":1,"description":"The id of the Topic."},"name":{"type":"string","minLength":1,"description":"The name of the Topic."},"requires_opt_in":{"type":"boolean","description":"True if the Topic requires opt-in to be subscribed."},"_links":{"type":"object","properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string","format":"uri","minLength":1}}}}}}}}}},"count":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string","format":"uri","minLength":1}}},"next":{"type":"object","required":["href"],"properties":{"href":{"type":"string","format":"uri","minLength":1}}},"prev":{"type":"object","required":["href"],"properties":{"href":{"type":"string","format":"uri","minLength":1}}}}}}},"example":{"_embedded":{"topics":[{"id":"8d59cec0-058c-4114-a585-439f7822d530","name":"Marketing","requires_opt_in":true,"_links":{"self":{"href":"https://api.example.com/automated-notifications/topics/8d59cec0-058c-4114-a585-439f7822d530"}}},{"id":"45cd9989-f98a-4aa5-8388-d75138629b97","name":"Appointment","requires_opt_in":false,"_links":{"self":{"href":"https://api.example.com/automated-notifications/topics/45cd9989-f98a-4aa5-8388-d75138629b97"}}}]},"count":2,"total":10,"_links":{"self":{"href":"https://api.example.com/automated-notifications/topics?include_deleted=false&page=2&per_page=2"},"next":{"href":"https://api.example.com/automated-notifications/topics?include_deleted=false&page=3&per_page=2"},"prev":{"href":"https://api.example.com/automated-notifications/topics?include_deleted=false&page=1&per_page=2"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1414000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1414010","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1414030","message":"Required scopes are missing."}}}}}},"post":{"tags":["Automated Notifications"],"summary":"Create Topic","description":"Creates a Topic.","operationId":"addTopic","security":[{"GA":["automated-notifications-management:write"]}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["name","requires_opt_in"],"properties":{"name":{"type":"string","minLength":1,"description":"The name of the Topic."},"requires_opt_in":{"type":"boolean","description":"True if the Topic requires opt-in to be subscribed."}}},"example":{"name":"Marketing","requires_opt_in":true}}},"required":true},"responses":{"201":{"description":"Topic created","content":{"application/json":{"schema":{"type":"object","required":["id","name","requires_opt_in","_links"],"properties":{"id":{"type":"string","minLength":1,"description":"The id of the Topic."},"name":{"type":"string","minLength":1,"description":"The name of the Topic."},"requires_opt_in":{"type":"boolean","description":"True if the Topic requires opt-in to be subscribed."},"_links":{"type":"object","properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string","format":"uri","minLength":1}}}}}}},"example":{"id":"8d59cec0-058c-4114-a585-439f7822d530","name":"Marketing","requires_opt_in":true,"_links":{"self":{"href":"https://api.example.com/automated-notifications/topics/8d59cec0-058c-4114-a585-439f7822d530"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1414000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1414010","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1414030","message":"Required scopes are missing."}}}}}}},"/automated-notifications/topics/{topic_id}":{"get":{"tags":["Automated Notifications"],"summary":"Get Topic by id","description":"Retrieves a Topic by id.","operationId":"getTopic","security":[{"GA":["automated-notifications-management:read"]}],"parameters":[{"name":"topic_id","in":"path","description":"The id of the Topic.","required":true,"schema":{"type":"string","minLength":1,"example":"8d59cec0-058c-4114-a585-439f7822d530"}},{"name":"include_deleted","in":"query","description":"Set this value a true to include a deleted Topic.","required":false,"schema":{"type":"boolean","x-filterable":true,"minLength":1,"example":true}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","required":["id","name","requires_opt_in","_links"],"properties":{"id":{"type":"string","minLength":1,"description":"The id of the Topic."},"name":{"type":"string","minLength":1,"description":"The name of the Topic."},"requires_opt_in":{"type":"boolean","description":"True if the Topic requires opt-in to be subscribed."},"_links":{"type":"object","properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string","format":"uri","minLength":1}}}}}}},"example":{"id":"8d59cec0-058c-4114-a585-439f7822d530","name":"Marketing","requires_opt_in":true,"_links":{"self":{"href":"https://api.example.com/automated-notifications/topics/8d59cec0-058c-4114-a585-439f7822d530"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1414000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1414010","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1414030","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1414040","message":"Resource not found."}}}}}},"delete":{"tags":["Automated Notifications"],"summary":"Delete Topic by id","description":"Deletes a Topic by id.","operationId":"deleteTopic","security":[{"GA":["automated-notifications-management:write"]}],"parameters":[{"name":"topic_id","in":"path","description":"The id of the Topic.","required":true,"schema":{"type":"string","minLength":1,"example":"45cd9989-f98a-4aa5-8388-d75138629b97"}}],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1414010","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1414030","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1414040","message":"Resource not found."}}}}}}},"/automated-notifications/subscriptions":{"get":{"tags":["Automated Notifications"],"summary":"Get Subscriptions","description":"Retrieve list of subscriptions associated with a topic/channel","operationId":"getAutomatedNotificationsSubscriptions","security":[{"GA":["automated-notifications-subscriptions:read"]}],"parameters":[{"name":"topic_id","in":"query","description":"The id of the topic that where subscriptions is triggered.","required":false,"schema":{"type":"string","x-filterable":true,"minLength":1,"example":"82ba9989-f98a-4aa5-8388-d75138629a76"}},{"name":"channel_type","in":"query","description":"The channel type (SMS, EMAIL)","required":false,"schema":{"type":"string","x-filterable":true,"minLength":1,"example":"SMS"}},{"name":"channel_uri","in":"query","description":"The channel uri","required":false,"schema":{"type":"string","x-filterable":true,"minLength":1,"example":"+15319996577"}},{"name":"page","in":"query","description":"Page to fetch.","required":false,"schema":{"type":"integer","format":"int32","minimum":1,"maximum":2147483647,"default":1,"example":1}},{"name":"per_page","in":"query","description":"Amount of subscriptions to be shown per page.","required":false,"schema":{"type":"integer","format":"int32","minimum":1,"maximum":100,"default":50,"example":50}}],"responses":{"200":{"description":"List of subscriptions associated with the event","content":{"application/json":{"schema":{"type":"object","required":["_embedded","count","_links"],"properties":{"_embedded":{"type":"object","required":["subscriptions"],"properties":{"subscriptions":{"type":"array","items":{"type":"object","required":["id","topic_id","channel","opt_in","_links"],"properties":{"id":{"type":"string","minLength":1,"description":"The id of the subscription."},"topic_id":{"type":"string","minLength":1,"description":"The id of the topic to subscribe/unsubscribe."},"channel":{"required":["type","uri"],"type":"object","properties":{"type":{"description":"The type of channel.","type":"string","minLength":1,"enum":["EMAIL","SMS","VOICE"]},"uri":{"description":"The channel uri (for instance email address or phone number).","type":"string","minLength":1,"example":"mailto:john.doe@talkdesk.com"}}},"opt_in":{"type":"boolean","description":"The status of the subscription."},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string","format":"uri","minLength":1}}}}}}}}}},"count":{"type":"integer","format":"int32"},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string","format":"uri","minLength":1}}},"next":{"type":"object","required":["href"],"properties":{"href":{"type":"string","format":"uri","minLength":1}}},"prev":{"type":"object","required":["href"],"properties":{"href":{"type":"string","format":"uri","minLength":1}}}}}}},"example":{"_embedded":{"subscriptions":[{"id":"82ba9989-f98a-4aa5-8388-d75138629a76","topic_id":"700fca3d-848e-4af7-bc74-3c0a1193510b","channel":{"type":"SMS","uri":"+15319996577"},"opt_in":true,"_links":{"self":{"href":"https://api.example.com/automated-notifications/subscriptions/82ba9989-f98a-4aa5-8388-d75138629a76"}}}]},"count":1,"_links":{"self":{"href":"https://api.example.com/automated-notifications/subscriptions?topic_id=700fca3d-848e-4af7-bc74-3c0a1193510b&page=2&per_page=1"},"next":{"href":"https://api.example.com/automated-notifications/subscriptions?topic_id=700fca3d-848e-4af7-bc74-3c0a1193510b&page=3&per_page=1"},"prev":{"href":"https://api.example.com/automated-notifications/subscriptions?topic_id=700fca3d-848e-4af7-bc74-3c0a1193510b&page=1&per_page=1"}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1414000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1414010","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1414030","message":"Required scopes are missing."}}}}}},"put":{"tags":["Automated Notifications"],"summary":"Subscribe or unsubscribe a topic or create a new subscription(subscribe)","operationId":"upsertSubscription","security":[{"GA":["automated-notifications-subscriptions:write"]}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["topic_id","channel","opt_in"],"properties":{"topic_id":{"type":"string","minLength":1,"description":"The id of the topic to subscribe/unsubscribe."},"channel":{"required":["type","uri"],"type":"object","properties":{"type":{"description":"The type of channel.","type":"string","minLength":1,"enum":["EMAIL","SMS","VOICE"]},"uri":{"description":"The channel uri (for instance email address or phone number).","type":"string","minLength":1,"example":"mailto:john.doe@talkdesk.com"}}},"opt_in":{"type":"boolean","description":"The status of the subscription."}}},"examples":{"Update Subscription":{"value":{"topic_id":"3f01025e-f9cd-11eb-9a03-0242ac130003","channel":{"type":"SMS","uri":"+15319996577"},"opt_in":true}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","required":["id","topic_id","channel","opt_in","_links"],"properties":{"id":{"type":"string","minLength":1,"description":"The id of the subscription."},"topic_id":{"type":"string","minLength":1,"description":"The id of the topic to subscribe/unsubscribe."},"channel":{"required":["type","uri"],"type":"object","properties":{"type":{"description":"The type of channel.","type":"string","minLength":1,"enum":["EMAIL","SMS","VOICE"]},"uri":{"description":"The channel uri (for instance email address or phone number).","type":"string","minLength":1,"example":"mailto:john.doe@talkdesk.com"}}},"opt_in":{"type":"boolean","description":"The status of the subscription."},"_links":{"type":"object","properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string","format":"uri","minLength":1}}}}}}},"example":{"id":"82ba9989-f98a-4aa5-8388-d75138629a76","topic_id":"700fca3d-848e-4af7-bc74-3c0a1193510b","channel":{"type":"SMS","uri":"+15319996577"},"opt_in":true,"_links":{"self":{"href":"https://api.example.com/automated-notifications/subscriptions/82ba9989-f98a-4aa5-8388-d75138629a76"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1414010","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1414030","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1414040","message":"Resource not found."}}}}}}},"/automated-notifications/subscriptions/{subscription_id}":{"get":{"tags":["Automated Notifications"],"summary":"Get a subsbscription by id","operationId":"automatedNotificationsGetSubscription","security":[{"GA":["automated-notifications-subscriptions:read"]}],"parameters":[{"name":"subscription_id","in":"path","description":"The id of the subscription.","required":true,"schema":{"type":"string","x-filterable":true,"minLength":1,"example":"82ba9989-f98a-4aa5-8388-d75138629a76"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","required":["id","topic_id","channel","opt_in","_links"],"properties":{"id":{"type":"string","minLength":1,"description":"The id of the subscription."},"topic_id":{"type":"string","minLength":1,"description":"The id of the topic to subscribe/unsubscribe."},"channel":{"required":["type","uri"],"type":"object","properties":{"type":{"description":"The type of channel.","type":"string","minLength":1,"enum":["EMAIL","SMS","VOICE"]},"uri":{"description":"The channel uri (for instance email address or phone number).","type":"string","minLength":1,"example":"mailto:john.doe@talkdesk.com"}}},"opt_in":{"type":"boolean","description":"The status of the subscription."},"_links":{"type":"object","properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string","format":"uri","minLength":1}}}}}}},"example":{"id":"82ba9989-f98a-4aa5-8388-d75138629a76","topic_id":"700fca3d-848e-4af7-bc74-3c0a1193510b","channel":{"type":"SMS","uri":"+15319996577"},"opt_in":true,"_links":{"self":{"href":"https://api.example.com/automated-notifications/subscriptions/82ba9989-f98a-4aa5-8388-d75138629a76"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1414010","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1414030","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1414040","message":"Resource not found."}}}}}}},"/automated-notifications/subscriptions/opt-ins":{"post":{"tags":["Automated Notifications"],"summary":"Check opt-in status with topic ids and channel.","description":"Check opt in status.","operationId":"checkOptInStatus","security":[{"GA":["automated-notifications-subscriptions:read"]}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["topic_ids","channel"],"properties":{"topic_ids":{"type":"array","minLength":1,"description":"The list of topic ids."},"channel":{"required":["type","uri"],"type":"object","properties":{"type":{"description":"The type of channel.","type":"string","minLength":1,"enum":["EMAIL","SMS","VOICE"]},"uri":{"description":"The channel uri (for instance email address or phone number).","type":"string","minLength":1,"example":"mailto:john.doe@talkdesk.com"}}}}},"examples":{"Check Opt in status":{"value":{"topic_ids":["3f01025e-f9cd-11eb-9a03-0242ac130003"],"channel":{"type":"SMS","uri":"+15319996577"}}}}}},"required":true},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"object","required":["opt_in"],"properties":{"opt_in":{"type":"boolean","description":"The opt in status to a specific channel/topic."}}},"example":{"opt_in":true}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1414010","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1414030","message":"Required scopes are missing."}}}}}}},"/automated-notifications/interactions":{"get":{"tags":["Automated Notifications"],"summary":"Search Interactions","description":"Retrieves a list of the Automated Notifications Interactions searched by query parameters.","operationId":"searchAutomatedNotificationsInteractions","security":[{"GA":["automated-notifications-interactions:read"]}],"parameters":[{"name":"event_id","in":"query","description":"The Automated Notifications event ID.","required":false,"schema":{"type":"string","minLength":1,"example":"12dac642-97f1-11ed-a8fc-0242ac120002"}},{"name":"rule_id","in":"query","description":"The Automated Notifications rule ID.","required":false,"schema":{"type":"string","minLength":1,"example":"3ae23418-97f1-11ed-a8fc-0242ac120002"}},{"name":"external_id","in":"query","description":"The external flow ID.","required":false,"schema":{"type":"string","minLength":1,"example":"5793d170-97f1-11ed-a8fc-0242ac120002"}},{"name":"external_type_id","in":"query","description":"The external flow ID type.","required":false,"schema":{"type":"string","minLength":1,"example":"STUDIO"}},{"name":"escalation_id","in":"query","description":"The Interactions escalation ID.","required":false,"schema":{"type":"string","minLength":1,"example":"757b204e-97f1-11ed-a8fc-0242ac120002"}},{"name":"escalation_state","in":"query","description":"The Interactions escalation state.","required":false,"schema":{"type":"string","minLength":1,"example":"CONVERSATION_STARTED"}},{"name":"contact_id","in":"query","description":"The contact id, talkdesk contact api id with whom the messages are being exchanged.","required":false,"schema":{"type":"string","minLength":1,"example":"3cc8b080-97f2-11ed-a8fc-0242ac120002"}},{"name":"channel_type","in":"query","description":"The Interactions channel type (SMS, EMAIL).","required":false,"schema":{"type":"string","minLength":1,"example":"SMS"}},{"name":"an_channel_uri","in":"query","description":"The automated-notifications interaction channel uri, the talkdesk phone number for outbound messages.","required":false,"schema":{"type":"string","minLength":1,"example":"+351911111111"}},{"name":"contact_channel_uri","in":"query","description":"The contact phone number for inbound messages.","required":false,"schema":{"type":"string","minLength":1,"example":"+351910000000"}},{"name":"state","in":"query","description":"Automated notification interaction state. The initial state, when the interaction starts, is 'OPEN'.","required":false,"schema":{"type":"string","minLength":1,"example":"ESCALATED"}},{"name":"start_date","in":"query","description":"Automated notification interaction start date.","required":false,"schema":{"type":"string","minLength":1,"example":"2021-09-14T12:16:50.078Z"}},{"name":"end_date","in":"query","description":"Automated notification interaction end date.","required":false,"schema":{"type":"string","minLength":1,"example":"2021-09-14T12:16:50.078Z"}},{"name":"last_updated","in":"query","description":"Automated notification interaction last updated date.","required":false,"schema":{"type":"string","minLength":1,"example":"2021-09-14T12:16:50.078Z"}},{"name":"skip","in":"query","description":"The start index to fetch the members.","required":false,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":2147483647,"default":0,"example":0}},{"name":"limit","in":"query","description":"The total amount of members to be fetched.","required":false,"schema":{"type":"integer","format":"int32","minimum":1,"maximum":100,"default":50,"example":50}},{"name":"order_by","in":"query","description":"The sort mechanism.","required":false,"schema":{"type":"string","default":"startDate:asc","minimum":1,"maximum":50,"x-sorting_default_order":"asc","example":"startDate:asc,externalId:desc","x-sorting_fields":["id","accountId","anEventId","ruleId","externalId","externalIdType","escalationId","escalationState","contactId","channelType","anChannelUri","contactChannelUri","startDate","endDate","state","lastUpdated"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","required":["_embedded","total"],"properties":{"_embedded":{"type":"object","required":["interactions"],"properties":{"interactions":{"type":"array","items":{"type":"object","required":["id","account_id","an_event_id","rule_id","external_id","external_type_id","state"],"properties":{"id":{"type":"string","description":"automated notifications interaction id"},"account_id":{"type":"string","description":"account id that owns this interaction resource"},"an_event_id":{"type":"string","description":"Automated Notification Event id"},"rule_id":{"type":"string","description":"Automated Notification Rule id"},"external_id":{"type":"string","description":"Studio interaction id","minLength":5},"external_type_id":{"type":"string","description":"Type of the interaction external id","minLength":1,"enum":["STUDIO"]},"escalation_id":{"type":"string","description":"DCE call escalation id, when the automated notifications interaction starts is null"},"escalation_state":{"type":"string","description":"DCE conversation state. The initial state is null","minLength":1,"enum":["CONVERSATION_STARTED","CONVERSATION_ENDED"]},"contact_id":{"type":"string","description":"contact id, talkdesk contact api id with whom the messages are being exchanged"},"channel_type":{"type":"string","description":"automated-notifications interaction channel type, for example SMS, EMAIL"},"an_channel_uri":{"type":"string","description":"automated-notifications interaction channel uri, the talkdesk phone number for outbound messages"},"contact_channel_uri":{"type":"string","description":"the contact phone number"},"state":{"type":"string","description":"Automated notification interaction state. The initial state, when the interaction starts, is 'OPEN'","minLength":1,"enum":["OPEN","ESCALATED","CLOSED"]},"start_date":{"type":"string","format":"datetime","description":"utc date time when the automated notification interaction was been started"},"end_date":{"type":"string","format":"datetime","description":"utc date time when the automated notification interaction was been closed or abandoned"},"last_updated":{"type":"string","format":"datetime","description":"utc date time when the automated notification was updated"},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","description":"An URI pointing to this resource"}}}}}}}}}},"total":{"type":"integer","format":"int32"}}},"example":{"_embedded":{"interactions":[{"id":"6346a6885b5c7f14b96d5144","account_id":"f45bc770-97f0-11ed-a8fc-0242ac120002","an_event_id":"12dac642-97f1-11ed-a8fc-0242ac120002","rule_id":"3ae23418-97f1-11ed-a8fc-0242ac120002","external_id":"5793d170-97f1-11ed-a8fc-0242ac120002","external_type_id":"STUDIO","escalation_id":"757b204e-97f1-11ed-a8fc-0242ac120002","escalation_state":"CONVERSATION_STARTED","contact_id":"3cc8b080-97f2-11ed-a8fc-0242ac120002","channel_type":"SMS","an_channel_uri":"+351911111111","contact_channel_uri":"+351910000000","state":"ESCALATED","start_date":"2021-09-14T12:16:50.078Z","end_date":"2021-09-14T13:16:50.078Z","last_updated":"2021-09-14T13:16:50.078Z"}]},"total":1}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3314000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3314010","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3314030","message":"Required scopes are missing."}}}}}}},"/fsi/contacts/{contact_id}/accounts/{account_id}/transactions":{"get":{"tags":["FSI Transactions"],"summary":"Returns account transactions","description":"The endpoint allows you to retrieve the transactions associated with a specific account belonging to a contact.\nBy providing the unique contact ID and account ID as path parameters, this endpoint enables you to fetch the transaction history of a particular account linked to a contact.\n","security":[{"GA":["fsi-transactions:read"]}],"parameters":[{"in":"path","name":"contact_id","schema":{"type":"string","minLength":3},"required":true,"description":"The contact id"},{"in":"path","name":"account_id","schema":{"type":"string","minLength":3},"required":true,"description":"The account id"},{"in":"query","name":"skip","description":"The number of elements to skip in transactions collection","schema":{"type":"integer","minimum":0,"maximum":2147483647,"default":0}},{"in":"query","name":"limit","description":"The maximum number of elements returned in transactions collection","schema":{"type":"integer","minimum":10,"default":20,"maximum":500}},{"in":"query","name":"type","description":"Type of transactions","required":false,"schema":{"type":"string","enum":["UNDEFINED","CREDIT_CARD","PAYMENT","WITHDRAWAL","DEFAULT","TRANSFER","ADD_ON","DEPOSIT","PURCHASE","CHECK","OTHER","LOAN_PAYMENTS","FEE","CHARGE"]}},{"in":"query","name":"interaction_id","schema":{"type":"string"},"required":false,"description":"The interaction id"}],"responses":{"200":{"description":"The transactions list.","content":{"application/json":{"schema":{"type":"object","required":["total","_embedded"],"properties":{"total":{"description":"The total number of transactions in the collection","type":"integer","minimum":0,"default":0},"_embedded":{"type":"object","required":["transactions"],"properties":{"transactions":{"description":"List of account's transactions","type":"array","items":{"type":"object","required":["id","description","value","value_at","status","type","flow"],"properties":{"id":{"type":"string","description":"Transaction's id"},"description":{"type":"string","description":"Brief description for a transaction"},"value":{"type":"object","description":"A tuple with value and currency","required":["value","currency"],"properties":{"value":{"type":"string","description":"A value associated with a currency"},"currency":{"type":"string","description":"Use currency code ISO 4217","minLength":3,"maxLength":3}}},"booked_at":{"type":"string","format":"date","description":"Transaction's book date (post date)"},"value_at":{"type":"string","format":"date","description":"Transaction's value date (effective date)"},"status":{"type":"string","enum":["UNDEFINED","PENDING","BOOKED","POSTED"]},"type":{"type":"string","enum":["UNDEFINED","CREDIT_CARD","PAYMENT","WITHDRAWAL","DEFAULT","TRANSFER","ADD_ON","DEPOSIT","PURCHASE","CHECK","OTHER","LOAN_PAYMENTS","FEE","CHARGE"]},"flow":{"type":"string","description":"Transaction's flow - either a debit or a credit in an account","enum":["CREDIT","DEBIT"]},"custom_type":{"type":"string","description":"Transaction type customized by bank client"},"custom_status":{"type":"string","description":"Transaction status customized by bank client"},"custom_fields":{"description":"Custom fields associated with the entity.","type":"array","items":{"type":"object","required":["key"],"properties":{"key":{"type":"string","description":"custom field name","minLength":0,"maxLength":255},"value":{"type":"string","description":"custom field value","minLength":0,"maxLength":255}}}},"value_details":{"type":"object","properties":{"principal_payment":{"type":"string","description":"Principal payment (detail amount of value)"},"interest_payment":{"type":"string","description":"Interest payment (detail amount of value)"},"monthly_escrow_payment":{"type":"string","description":"Monthly escrow payment (detail amount of value)"},"fee":{"type":"string","description":"Fee payment (detail amount of value)"}}},"total_principal_balance":{"type":"string","description":"Total principal balance"},"check_number":{"type":"string","description":"Check number"}}}}}}}},"example":{"total":40,"_embedded":{"transactions":[{"id":"123456","flow":"CREDIT","description":"TD Salary","value":{"value":"87.54","currency":"BRL"},"booked_at":"2021-02-12","value_at":"2021-04-14","status":"BOOKED","type":"PAYMENT","custom_fields":[{"key":"payroll_id","value":"987654321"}]},{"id":"123457","flow":"DEBIT","description":"Withdrawal - ATM Saint John St","value":{"value":"100","currency":"EUR"},"booked_at":"2021-03-13","value_at":"2021-03-13","status":"PENDING","type":"WITHDRAWAL","custom_fields":[{"key":"atm_id","value":"ATM56789"}],"custom_type":"Custom Withdrawal","custom_status":"Custom Pending","check_number":"123456789"}]}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490000","message":"Bad request.","fields":[{"name":"skip","description":"skip parameter not in a valid range."},{"name":"limit","description":"limit parameter not in a valid range."}]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490001","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490002","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1490003","message":"Resource not found."}}}}}}},"/fsi-workspace/contacts/synchronizations-from-core":{"post":{"tags":["FSI Workspace"],"summary":"Update Talkdesk contact found by phone number or contact id with the Fsi member information.","description":"Update the Talkdesk contact information fields with the information of the FSI member.\nTo get the Talkdesk contact it is required to provided one of the query parameters: contact_id or phone_number.\nWhen is provided the contact_id the Talkdesk contact to update will be found by the contact_id.\nWhen is provided the phone_number the Talkdesk contact to update will be found if only one match of the **phone number** exists in the contact Api.\nThe update process will only occur only if a Talkdesk contact is retrieved and exists one Fsi member with identifier equals to **member_id**.\nThe Talkdesk contact information that may be updated will be:\n - Name\n - Address\n - Email\n - Phone numbers\n","operationId":"fsi_workspace_contacts__update_talkdesk_Contact","security":[{"GA":["fsi-workspace-contact-synchronization:write"]}],"parameters":[{"name":"phone_number","in":"query","required":false,"schema":{"type":"string","example":"+351922222222","minLength":1,"maxLength":16}},{"name":"contact_id","in":"query","required":false,"schema":{"type":"string","example":"000f6d4a62533a000e023638"}},{"name":"member_id","in":"query","required":true,"schema":{"type":"string","example":"abcde1234","minLength":1,"maxLength":64}},{"name":"interaction_id","in":"query","required":false,"schema":{"type":"string","example":"000f6d4a62533a000e023638","minLength":1,"maxLength":64},"description":"The interaction id"}],"responses":{"200":{"description":"Contact successfully updated"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1654000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1654010","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1654030","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1654040","message":"Resource not found."}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1654220","message":"An unprocessable entity error."}}}}}}},"/healthcare/patients/{patient_id}/coverages":{"get":{"tags":["HLS Providers"],"summary":"Search a patient's coverage","description":"Search a certain coverage of a given patient.","operationId":"searchPatientCoverages","security":[{"GA":["hls-coverage:read"]}],"parameters":[{"name":"patient_id","in":"path","required":true,"schema":{"type":"string","example":"enh2Q1c0oNRtWzXZrnG4tKw3"}},{"name":"page","in":"query","description":"The page number to request. Starts at 1, defaults to 1 when not provided.","required":false,"schema":{"default":1,"minimum":1,"maximum":50,"type":"integer"}},{"name":"per_page","in":"query","description":"The maximum number of items per page. Defaults to 50 when not provided.","required":false,"schema":{"default":50,"minimum":1,"maximum":50,"type":"integer"}},{"name":"count","in":"query","description":"When per_page is too big, this count value will limit the number of items returned on current page. The count value can't be bigger than per_page.","required":false,"schema":{"default":5,"minimum":1,"maximum":50,"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","description":"HAL paginated response containing patient coverages","properties":{"total":{"type":"integer","format":"int64","description":"Total number of coverages across all pages","example":4},"count":{"type":"integer","format":"int64","description":"Number of items returned in the current page","example":4},"page":{"type":"integer","format":"int64","description":"Current page number (starts at 1)","example":1},"per_page":{"type":"integer","format":"int64","description":"Maximum number of items per page","example":50},"total_pages":{"type":"integer","format":"int64","description":"Total number of pages available","example":1},"_embedded":{"type":"object","properties":{"coverages":{"type":"array","items":{"allOf":[{"type":"object","description":"Base definition containing common fields for a patient's insurance coverage.","properties":{"id":{"type":"string","description":"The unique identifier for the insurance coverage.","example":"coverage-id-1"},"plan_id":{"type":"string","description":"The unique identifier for the insurance plan type (e.g., Gold-PPO-1233), distinct from the coverage ID.","example":"Gold-PPO-1233"},"plan_name":{"type":"string","description":"The name of the insurance plan.","example":"Gold PPO"},"subscribe":{"type":"string","format":"date","description":"The effective start date of the coverage (yyyy-MM-dd).","example":"2024-01-01"},"unsubscribe":{"type":"string","format":"date","description":"The end date of the coverage, if available (yyyy-MM-dd).","example":"2030-01-01"},"plan_status":{"type":"string","description":"Operational status of an insurance coverage plan. ACTIVE = currently effective; INACTIVE = not currently active (expired, terminated, or not yet effective).","enum":["ACTIVE","INACTIVE"]},"priority":{"type":"string","description":"Priority of a patient's coverage relative to other active plans. PRIMARY = first payer; SECONDARY = second payer; TERTIARY = third payer; ... up to DENARY = tenth payer.","enum":["PRIMARY","SECONDARY","TERTIARY","QUATERNARY","QUINARY","SENARY","SEPTENARY","OCTONARY","NONARY","DENARY"]}},"required":["id","plan_id","plan_name","plan_status"]}],"description":"Lightweight view of a patient's insurance coverage, suitable for listings."}}}}},"required":["_embedded"]},"example":{"total":4,"count":4,"page":1,"per_page":50,"total_pages":1,"_embedded":{"coverages":[{"id":"coverage-id-1","plan_name":"Gold PPO","subscribe":"2024-01-01","unsubscribe":"2030-01-01","plan_status":"ACTIVE","priority":"PRIMARY"}]}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Generic Bad Request":{"value":{"code":"1484000","message":"Bad request."}},"Upstream Bad Request":{"value":{"code":"1484001","message":"Bad Request in upstream."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"1484010","message":"Invalid JWT token."}},"No Upstream":{"value":{"code":"1484012","message":"No upstream selected."}},"Upstream Unauthorized":{"value":{"code":"1484014","message":"Unauthorized in upstream."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Missing Scopes":{"value":{"code":"1484030","message":"Required scopes are missing."}},"Account Forbidden":{"value":{"code":"1484031","message":"Account does not have access."}},"Upstream Forbidden":{"value":{"code":"1484032","message":"Forbidden in upstream."}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Not Found":{"value":{"code":"1484040","message":"Resource not found."}},"Upstream Not Found":{"value":{"code":"1484041","message":"Not Found in upstream."}}}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484050","message":"Method not allowed."}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484150","message":"Unsupported Media Type"}}}}}}},"/healthcare/patients/{patient_id}/coverages/{coverage_id}":{"get":{"tags":["HLS Providers"],"summary":"Get a patient's coverage details","description":"Retrieves detailed information about a specific insurance coverage for a patient.","operationId":"getPatientCoverageDetails","security":[{"GA":["hls-coverage:read"]}],"parameters":[{"name":"patient_id","in":"path","required":true,"description":"Unique identifier of the patient whose coverage is being fetched.","schema":{"type":"string","example":"enh2Q1c0oNRtWzXZrnG4tKw3"}},{"name":"coverage_id","in":"path","required":true,"description":"Unique identifier of the coverage to retrieve.","schema":{"type":"string","example":123456789}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"type":"object","description":"Base definition containing common fields for a patient's insurance coverage.","properties":{"id":{"type":"string","description":"The unique identifier for the insurance coverage.","example":"coverage-id-1"},"plan_id":{"type":"string","description":"The unique identifier for the insurance plan type (e.g., Gold-PPO-1233), distinct from the coverage ID.","example":"Gold-PPO-1233"},"plan_name":{"type":"string","description":"The name of the insurance plan.","example":"Gold PPO"},"subscribe":{"type":"string","format":"date","description":"The effective start date of the coverage (yyyy-MM-dd).","example":"2024-01-01"},"unsubscribe":{"type":"string","format":"date","description":"The end date of the coverage, if available (yyyy-MM-dd).","example":"2030-01-01"},"plan_status":{"type":"string","description":"Operational status of an insurance coverage plan. ACTIVE = currently effective; INACTIVE = not currently active (expired, terminated, or not yet effective).","enum":["ACTIVE","INACTIVE"]},"priority":{"type":"string","description":"Priority of a patient's coverage relative to other active plans. PRIMARY = first payer; SECONDARY = second payer; TERTIARY = third payer; ... up to DENARY = tenth payer.","enum":["PRIMARY","SECONDARY","TERTIARY","QUATERNARY","QUINARY","SENARY","SEPTENARY","OCTONARY","NONARY","DENARY"]}},"required":["id","plan_id","plan_name","plan_status"]},{"type":"object","description":"Full insurance coverage details for a patient.","properties":{"plan_type":{"type":"string","description":"Describes how the health insurance is funded and administered. e.g. medicare, medicaid, chip.","example":"medicare"},"relationship":{"type":"string","description":"The relationship of the patient to the insured individual (e.g., Self, Spouse, Child).","example":"Self"},"network_type":{"type":"string","description":"Applicable for public and private plans - tells how the plan works, the rules about which doctors and hospitals one can use. e.g. HMO, PPO.","example":"HMO"},"payor":{"description":"The insurance payor or provider.","type":"object","properties":{"name":{"type":"string","description":"Official or display name of the payor.","example":"Example Insurance Co."},"addresses":{"description":"List of postal addresses for the payor, if available.","type":"array","items":{"type":"object","description":"Postal address for a payor or contact.","properties":{"street":{"type":"string","description":"Street line(s) of the address.","example":"123 Main St, Suite 200"},"city":{"type":"string","description":"City or locality.","example":"San Francisco"},"state":{"type":"string","description":"State or province of the address.","example":"CA"},"postal_code":{"type":"string","description":"Postal or ZIP code of the address.","example":"94105"},"country":{"type":"string","description":"Country of the address.","example":"USA"}},"required":["street","city","state","postal_code","country"]}},"contacts":{"description":"List of contact points, such as phone numbers, emails, or URLs.","type":"array","items":{"type":"object","description":"Contact point for a payor or organization.","properties":{"system":{"type":"string","description":"The type of contact point (e.g., phone, email, url).","example":"phone"},"value":{"type":"string","description":"The actual contact detail (e.g., phone number, email address, URL).","example":"+1-800-555-1234"}},"required":["system","value"]}}},"required":["name"]},"copay_information":{"type":"array","description":"A structured array containing copay or coinsurance details for covered benefits.","items":{"type":"object","description":"Copay or coinsurance information for a particular benefit","properties":{"benefit":{"type":"string","description":"Name of the covered service or benefit","example":"General Consultation"},"cost_type":{"type":"string","description":"The type of cost (e.g., “Copay”, “Deductible”, “Coinsurance”).","example":"Coinsurance"},"amount":{"type":"object","description":"Represents either a monetary amount (with currency) or a percentage value","properties":{"type":{"type":"string","description":"Discriminator indicating if an amount represents money or a percentage","enum":["MONEY","PERCENTAGE"]},"amount":{"type":"number","format":"double","description":"Monetary amount when type is MONEY","example":20},"currency":{"type":"string","description":"ISO 4217 currency code required when type is MONEY","example":"USD"},"percent":{"type":"number","format":"double","minimum":0,"maximum":100,"description":"Percentage value when type is PERCENTAGE (0..100)","example":20}},"required":["type"]}},"required":["amount"]}}}}]},"example":{"id":"coverage-id-123","plan_name":"Plan Name Example","subscribe":"2024-09-29","unsubscribe":"2026-09-29","plan_status":"ACTIVE","plan_type":"medicare","network_type":"HMO","priority":"PRIMARY","relationship":"Self","payor":{"name":"Example Insurance Co.","addresses":[{"street":"123 Main St, Suite 200","city":"San Francisco","state":"CA","postal_code":"94105","country":"USA"}],"contacts":[{"system":"phone","value":"+1-800-555-1234"},{"system":"email","value":"contact@example.com"}]},"copay_information":[{"benefit":"General Consultation","cost_type":"Coinsurance","amount":{"type":"MONEY","amount":20,"currency":"USD"}},{"benefit":"Specialist Consultation","cost_type":"Copay","amount":{"type":"MONEY","amount":40,"currency":"USD"}},{"benefit":"Coinsurance","cost_type":"Deductible","amount":{"type":"PERCENTAGE","percent":20}}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Generic Bad Request":{"value":{"code":"1484000","message":"Bad request."}},"Upstream Bad Request":{"value":{"code":"1484001","message":"Bad Request in upstream."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"1484010","message":"Invalid JWT token."}},"No Upstream":{"value":{"code":"1484012","message":"No upstream selected."}},"Upstream Unauthorized":{"value":{"code":"1484014","message":"Unauthorized in upstream."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Missing Scopes":{"value":{"code":"1484030","message":"Required scopes are missing."}},"Account Forbidden":{"value":{"code":"1484031","message":"Account does not have access."}},"Upstream Forbidden":{"value":{"code":"1484032","message":"Forbidden in upstream."}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Not Found":{"value":{"code":"1484040","message":"Resource not found."}},"Upstream Not Found":{"value":{"code":"1484041","message":"Not Found in upstream."}}}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484050","message":"Method not allowed."}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484150","message":"Unsupported Media Type"}}}}}}},"/healthcare/appointments":{"post":{"tags":["HLS Providers"],"summary":"Schedule appointments","description":"Schedule the appointment passed on body on the interaction using interactionId.","operationId":"scheduleAppointment","security":[{"GA":["hls-appointment:write"]}],"parameters":[{"name":"interaction_id","in":"query","required":true,"description":"Required interaction Id","schema":{"type":"string","example":"abc","minLength":1,"maxLength":2147483647}},{"name":"notes","in":"query","required":false,"description":"Notes of the scheduling appointment","schema":{"type":"string","example":"I have a problem","minLength":1,"maxLength":2147483647}},{"name":"notes_prefix","in":"query","description":"Prefix to add to appointment notes","schema":{"type":"string","example":"abc","minLength":1,"maxLength":2147483647}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The id of the available slot from the external system.","type":"string","minLength":1,"maxLength":2147483647},"service_type_id":{"description":"The id of the specialization / area of expertise for the available slot.","type":"string","minLength":1,"maxLength":2147483647},"start_date":{"description":"The time at which the appointment starts for the available slot in UTC.","type":"string","format":"date-time","minLength":1,"maxLength":2147483647},"end_date":{"description":"The time at which the appointment ends for the available slot in UTC.","type":"string","format":"date-time","minLength":1,"maxLength":2147483647},"provider_id":{"description":"The id of the provider for the available slot.","type":"string","minLength":1,"maxLength":2147483647},"location_id":{"description":"The id of the service location / department for a provider for the available slot.","type":"string","minLength":1,"maxLength":2147483647},"time_zone_id":{"description":"The zone id of this available slot.","type":"string","minLength":1,"maxLength":2147483647},"sub_location":{"description":"The sub-location (department) for the available slot.","type":"string","minLength":1,"maxLength":2147483647}}},"example":{"id":"6d3ab56c1786281ee1622e02ad17ba80","service_type_id":"123","start_date":"2022-12-21T21:15:00Z","end_date":"2022-12-21T22:15:00Z","provider_id":"E1000","location_id":"10501101","time_zone_id":"America/Chicago","sub_location":"Cardiology"}}}},"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Generic Bad Request":{"value":{"code":"1484000","message":"Bad request."}},"Upstream Bad Request":{"value":{"code":"1484001","message":"Bad Request in upstream."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"1484010","message":"Invalid JWT token."}},"No Upstream":{"value":{"code":"1484012","message":"No upstream selected."}},"Upstream Unauthorized":{"value":{"code":"1484014","message":"Unauthorized in upstream."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Missing Scopes":{"value":{"code":"1484030","message":"Required scopes are missing."}},"Account Forbidden":{"value":{"code":"1484031","message":"Account does not have access."}},"Upstream Forbidden":{"value":{"code":"1484032","message":"Forbidden in upstream."}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Not Found":{"value":{"code":"1484040","message":"Resource not found."}},"Upstream Not Found":{"value":{"code":"1484041","message":"Not Found in upstream."}}}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484050","message":"Method not allowed."}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484150","message":"Unsupported Media Type"}}}}}},"get":{"tags":["HLS Providers"],"summary":"Get future appointments","description":"Get a list of future appointments connected via an interactionId.","operationId":"getFutureAppointments","security":[{"GA":["hls-appointment:read"]}],"parameters":[{"name":"interaction_id","in":"query","required":true,"description":"Interaction ID","schema":{"type":"string","example":"abc","minLength":1,"maxLength":2147483647}},{"name":"start_date","in":"query","description":"The initial date from which the appointments should retrieved","required":false,"example":"2022-01-17T11:00:00.000Z","schema":{"type":"string","format":"date-time","minLength":10,"maxLength":24}},{"name":"end_date","in":"query","description":"The final date up until which the appointments should retrieved","required":false,"example":"2022-01-22T11:00:00.000Z","schema":{"type":"string","format":"date-time","minLength":10,"maxLength":24}},{"name":"max_days","in":"query","required":false,"description":"Quantity of days to look up in the future to fetch the appointments","schema":{"type":"integer","example":1,"minimum":1,"maximum":2000,"default":30}},{"name":"timezone","in":"query","required":false,"description":"Timezone from this interaction and must respect this format `America/Chicago`.","schema":{"type":"string","example":"America/Chicago"}},{"name":"cancelable_only","in":"query","required":false,"description":"Boolean to fetch only future appointments that are cancelable","schema":{"type":"boolean","example":false}},{"name":"status","in":"query","required":false,"description":"List of the desired appointment statuses, comma-separated (e.g. 'booked,noshow')","schema":{"type":"string","enum":["proposed","pending","booked","arrived","fulfilled","cancelled","noshow","entered-in-error","checked-in","waitlist"],"example":"booked","minLength":1,"maxLength":200}},{"name":"category","in":"query","required":false,"description":"Appointment category","schema":{"type":"string","enum":["APPOINTMENT","SURGERY"],"example":"APPOINTMENT","minLength":1,"maxLength":100}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","example":1,"minimum":1,"maximum":2147483647,"default":1}},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","example":5,"minimum":1,"maximum":50,"default":5}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","required":["count","total","page","per_page","total_pages","_links","_embedded"],"properties":{"count":{"type":"integer","description":"The number of results in the current page"},"total":{"type":"integer","description":"The total of results"},"page":{"type":"integer","description":"The current page"},"per_page":{"type":"integer","description":"The number of results per page"},"total_pages":{"type":"integer","description":"The total number of result pages"},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string"}}}}},"_embedded":{"type":"object","description":"List of future appointments in current page","required":["future_appointments"],"properties":{"future_appointments":{"type":"array","items":{"type":"object","required":["id","has_service_type_id"],"properties":{"id":{"description":"Future appointment identifier","type":"string"},"service_type":{"description":"Future appointment service type name","type":"string"},"service_type_id":{"description":"Future appointment service type identifier","type":"string"},"status":{"description":"Future appointment status","type":"string"},"date_time":{"description":"Future appointment date/time representation","type":"string"},"date":{"description":"Future appointment date representation","type":"string"},"time":{"description":"Future appointment time of day representation","type":"string"},"timezone":{"description":"Future appointment timezone definition","type":"string"},"provider":{"description":"Future appointment provider name","type":"string"},"provider_id":{"description":"Future appointment provider identifier","type":"string"},"speciality":{"description":"Medical speciality the future appointment refers to","type":"string"},"address":{"description":"Address of the future appointment","type":"string"},"location":{"description":"Location of the medical center where the future appointment takes place","type":"string"},"location_id":{"description":"Future appointment location identifier","type":"string"},"has_service_type_id":{"description":"True if the service type ID is available in the future appointment details","type":"boolean"},"patient_instructions":{"description":"Instructions the patient shall follow in preparation for the future appointment","type":"string"},"cancellable":{"description":"True if the appointment can be cancelled","type":"boolean"},"cancelled":{"description":"True if the appointment has had a cancel request registered","type":"boolean"},"confirmed":{"description":"True if the appointment has been confirmed","type":"boolean"},"category":{"description":"The category of the appointment","type":"string"},"comment":{"description":"Comment on the appointment","type":"string"},"appointment_dat_type_id":{"description":"the contact ID whose contact type is DAT","type":"string"},"sub_location":{"description":"Specific department, clinic, or area within the facility where the appointment occurs.","type":"string"},"sub_location_id":{"description":"System identifier for the sub-location within the facility, used to disambiguate departments/areas under the same location.","type":"string"}}}}}}}},"example":{"count":1,"total":1,"page":1,"per_page":5,"total_pages":1,"_links":{"self":{"href":"https://api.talkdesk.com/healthcare/appointments?interaction_id=a1b980cc981f"}},"_embedded":{"future_appointments":[{"id":"a1b980cc981f","service_type":"Office Visit","service_type_id":"123","status":"Confirmed","date_time":"2021-06-22T01:30:00Z","date":"2021-06-22","time":"01:30:00","timezone":"Europe/Paris","provider":"Family Medicine Physician, MD","provider_id":"9971","speciality":"Family Medicine","address":"123 Anywhere Street, VERONA, WI, 53593-9179","location":"EMC Family Medicine","location_id":"6564","has_service_type_id":true,"patient_instructions":"Bring eligibility papers and analysis results","cancellable":false,"cancelled":false,"confirmed":false,"category":"APPOINTMENT","comment":"Updated at 2023-01-21","appointment_dat_type_id":"12345","sub_location":"Pediatrics","sub_location_id":"67890"}]}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Generic Bad Request":{"value":{"code":"1484000","message":"Bad request."}},"Upstream Bad Request":{"value":{"code":"1484001","message":"Bad Request in upstream."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"1484010","message":"Invalid JWT token."}},"No Upstream":{"value":{"code":"1484012","message":"No upstream selected."}},"Upstream Unauthorized":{"value":{"code":"1484014","message":"Unauthorized in upstream."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Missing Scopes":{"value":{"code":"1484030","message":"Required scopes are missing."}},"Account Forbidden":{"value":{"code":"1484031","message":"Account does not have access."}},"Upstream Forbidden":{"value":{"code":"1484032","message":"Forbidden in upstream."}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Not Found":{"value":{"code":"1484040","message":"Resource not found."}},"Upstream Not Found":{"value":{"code":"1484041","message":"Not Found in upstream."}}}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484050","message":"Method not allowed."}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484150","message":"Unsupported Media Type"}}}}}}},"/healthcare/appointments/{appointment_id}":{"delete":{"tags":["HLS Providers"],"summary":"Cancel appointments","description":"Cancel the appointment via appointmentId and patientId of interactionId.","operationId":"cancelAppointment","security":[{"GA":["hls-appointment:write"]}],"parameters":[{"name":"appointment_id","in":"path","required":true,"description":"Required appointment Id","schema":{"type":"string","example":"aptBFS0Cxxxxxxxxxx"}},{"name":"interaction_id","in":"query","required":true,"description":"Required interaction Id","schema":{"type":"string","example":"abc","minLength":1,"maxLength":2147483647}},{"name":"agent_id","in":"query","required":false,"description":"Talkdesk agent ID related to this interaction","schema":{"type":"string","example":"617bc5d698cec24b2e3c16eb","minLength":1,"maxLength":2147483647}},{"name":"reason","in":"query","required":false,"description":"Cancelled Appointment reason","schema":{"type":"string","example":"cancel appointment","minLength":1,"maxLength":2147483647}},{"name":"comment","in":"query","required":false,"schema":{"description":"Cancelled Appointment comment","type":"string","example":"comment","minLength":1,"maxLength":2147483647}}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Generic Bad Request":{"value":{"code":"1484000","message":"Bad request."}},"Upstream Bad Request":{"value":{"code":"1484001","message":"Bad Request in upstream."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"1484010","message":"Invalid JWT token."}},"No Upstream":{"value":{"code":"1484012","message":"No upstream selected."}},"Upstream Unauthorized":{"value":{"code":"1484014","message":"Unauthorized in upstream."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Missing Scopes":{"value":{"code":"1484030","message":"Required scopes are missing."}},"Account Forbidden":{"value":{"code":"1484031","message":"Account does not have access."}},"Upstream Forbidden":{"value":{"code":"1484032","message":"Forbidden in upstream."}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Not Found":{"value":{"code":"1484040","message":"Resource not found."}},"Upstream Not Found":{"value":{"code":"1484041","message":"Not Found in upstream."}}}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484050","message":"Method not allowed."}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484150","message":"Unsupported Media Type"}}}}}}},"/healthcare/accounts/{account_id}/hl7/{message_type}":{"post":{"tags":["HLS Providers"],"summary":"Send HL7 Events.","description":"Endpoint for the healthcare providers to send raw HL7 events.","operationId":"sendHL7Events","security":[{"GA":["hls-hl7-events:write"]}],"parameters":[{"name":"account_id","in":"path","required":true,"description":"account ID","schema":{"type":"string","example":"a1b2c3","minLength":1,"maxLength":2147483647}},{"name":"message_type","in":"path","required":true,"description":"hl7 message type","schema":{"type":"string","example":"adt","minLength":1,"maxLength":2147483647}}],"requestBody":{"description":"The request body should be a valid hl7 message","content":{"application/json":{"schema":{"type":"string","nullable":false,"description":"The HL7 message, it should be a raw string.","minLength":1,"maxLength":2147483647},"example":"MSH|^~\\&|ADT1|MCM|FINGER|MCM|198808181126|SECURITY|ADT^A01|MSG00001|P|2.3.1"}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"type":"string","nullable":false,"description":"The HL7 message, it should be a raw string.","minLength":1,"maxLength":2147483647},"example":"MSH|^~\\&|ADT1|MCM|FINGER|MCM|198808181126|SECURITY|ADT^A01|MSG00001|P|2.3.1"}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Generic Bad Request":{"value":{"code":"1484000","message":"Bad request."}},"Upstream Bad Request":{"value":{"code":"1484001","message":"Bad Request in upstream."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"1484010","message":"Invalid JWT token."}},"No Upstream":{"value":{"code":"1484012","message":"No upstream selected."}},"Upstream Unauthorized":{"value":{"code":"1484014","message":"Unauthorized in upstream."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Missing Scopes":{"value":{"code":"1484030","message":"Required scopes are missing."}},"Account Forbidden":{"value":{"code":"1484031","message":"Account does not have access."}},"Upstream Forbidden":{"value":{"code":"1484032","message":"Forbidden in upstream."}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Not Found":{"value":{"code":"1484040","message":"Resource not found."}},"Upstream Not Found":{"value":{"code":"1484041","message":"Not Found in upstream."}}}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484050","message":"Method not allowed."}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484150","message":"Unsupported Media Type"}}}}}}},"/healthcare/available-appointments-va":{"get":{"tags":["HLS Providers"],"summary":"Search provider availability slots for VA returning a ProviderAvailabilityVA object","description":"Search provider available appointment slots using interactionId returning one ProviderAvailabilityVA object only. If the search finds multiple slots a ProviderAvailabilityVA object is returned with its remaining property pointing to the number of results found (not considering the one returned) and the closest slot. If no slots are found then the remaining property returns -1.","operationId":"providerAvailableAppointmentsVA","security":[{"GA":["hls-provider:read"]}],"parameters":[{"name":"interaction_id","in":"query","required":true,"description":"Required interaction Id","schema":{"type":"string","example":"abc","minLength":1,"maxLength":2147483647}},{"name":"provider_id","in":"query","required":true,"description":"Healthcare provider identification","schema":{"type":"string","example":"E1000","minLength":1,"maxLength":2147483647}},{"name":"service_type_id","in":"query","required":true,"description":"Healthcare service type identification","schema":{"type":"string","example":"1004","minLength":1,"maxLength":2147483647}},{"name":"location_id","in":"query","required":true,"description":"Healthcare location identification","schema":{"type":"string","example":"10501101","minLength":1,"maxLength":2147483647}},{"name":"count","in":"query","description":"Number of slots to fetch","schema":{"minimum":1,"maximum":50,"default":1,"type":"integer"},"example":10},{"name":"max_days","in":"query","description":"Number of days to consider","schema":{"minimum":1,"maximum":30,"default":30,"type":"integer"},"example":10},{"name":"preferred_time","in":"query","required":false,"description":"Preferred slot time","schema":{"type":"string","example":"MORNING","enum":["MORNING","AFTERNOON","AM","PM"]}},{"name":"preferred_week_day","in":"query","required":false,"description":"Preferred slot week day","schema":{"type":"string","example":"MONDAY","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]}},{"name":"preferred_month","in":"query","required":false,"description":"Preferred slot month","schema":{"type":"string","example":"JANUARY","enum":["JANUARY","FEBRUARY","MARCH","APRIL","MAY","JUNE","JULY","AUGUST","SEPTEMBER","OCTOBER","NOVEMBER","DECEMBER"]}},{"name":"timezone","in":"query","required":false,"description":"Timezone from this interaction and must respect this format `America/Chicago`.","schema":{"type":"string","example":"America/Chicago","minLength":1,"maxLength":2147483647}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"remaining":{"description":"Number of other slots found","type":"integer"},"date":{"description":"Date of the slot (readable)","type":"string"},"time":{"description":"Time of the slot (readable)","type":"string"},"timezone":{"description":"Timezone of the slot (readable)","type":"string"},"time_preferences_flag":{"description":"Flag that signals if slot search was done with time preferences, and if slot matches time choices","type":"string"},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string"}}}}}}},"example":{"remaining":1,"date":"January 26 2022","time":"6:30 PM","timezone":"America/Chicago","time_preferences_flag":"false","_links":{"self":{"href":"https://api.talkdesk.com/healthcare/available-appointments-va?interaction_id=123&count=3&max_days=30"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Generic Bad Request":{"value":{"code":"1484000","message":"Bad request."}},"Upstream Bad Request":{"value":{"code":"1484001","message":"Bad Request in upstream."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"1484010","message":"Invalid JWT token."}},"No Upstream":{"value":{"code":"1484012","message":"No upstream selected."}},"Upstream Unauthorized":{"value":{"code":"1484014","message":"Unauthorized in upstream."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Missing Scopes":{"value":{"code":"1484030","message":"Required scopes are missing."}},"Account Forbidden":{"value":{"code":"1484031","message":"Account does not have access."}},"Upstream Forbidden":{"value":{"code":"1484032","message":"Forbidden in upstream."}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Not Found":{"value":{"code":"1484040","message":"Resource not found."}},"Upstream Not Found":{"value":{"code":"1484041","message":"Not Found in upstream."}}}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484050","message":"Method not allowed."}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484150","message":"Unsupported Media Type"}}}}}}},"/healthcare/available-slots":{"get":{"tags":["HLS Providers"],"summary":"Search provider availability slots returning a list of ProviderSlot objects. Deprecated, please use `/healthcare/available-provider-slots` instead.","description":"[Deprecated, please use `/healthcare/available-provider-slots` instead.] Search provider available appointment slots returning a HalPaginatedResource. If the search finds multiple slots a ProviderSlot list is returned within the _embedded property of HalPaginatedResource; each ProviderSlot represents one available slot for the executed search. If no slots are found then the _embedded property of HalPaginatedResource returns an empty list.","operationId":"providerAvailableSlots","security":[{"GA":["hls-provider:read"]}],"parameters":[{"name":"provider_id","in":"query","required":true,"description":"Healthcare provider identification","schema":{"type":"string","minLength":0,"maxLength":1000,"example":"E1000"}},{"name":"service_type_id","in":"query","required":true,"description":"Healthcare service type identification","schema":{"type":"string","minLength":0,"maxLength":1000,"example":"1004"}},{"name":"location_id","in":"query","required":true,"description":"Healthcare location identification","schema":{"type":"string","minLength":0,"maxLength":1000,"example":"10501101"}},{"name":"interaction_id","in":"query","description":"The ID of the interaction.","required":false,"example":"b4379742769e4bb4927644fa15126c64","schema":{"type":"string","minLength":1}},{"name":"page","in":"query","description":"The page number to request. Starts at 1, defaults to 1 when not provided.","required":false,"schema":{"default":1,"minimum":1,"maximum":50,"type":"integer"}},{"name":"per_page","in":"query","description":"The maximum amount of items per page. Defaults to 5 when not provided.","required":false,"schema":{"default":5,"minimum":1,"maximum":50,"type":"integer"}},{"name":"count","in":"query","description":"Number of slots to fetch","schema":{"minimum":1,"maximum":50,"default":5,"type":"integer"},"example":10},{"name":"start_date","in":"query","description":"The date from which the available slots should be considered as a viable option according to the client’s schedule.","required":false,"example":"2022-01-17T11:00:00.000Z","schema":{"type":"string","format":"date-time","minLength":1}},{"name":"end_date","in":"query","description":"The date until which the available slots should be considered as a viable option according to the client’s schedule.","required":false,"example":"2022-01-22T11:00:00.000Z","schema":{"type":"string","format":"date-time","minLength":1}},{"name":"max_days","in":"query","required":false,"description":"Quantity of days to look up in the future to fetch the appointments","schema":{"type":"integer","example":1,"minimum":1,"maximum":2000,"default":30}},{"name":"timezone","in":"query","required":false,"description":"Timezone from this interaction and must respect this format `America/Chicago`.","schema":{"type":"string","example":"America/Chicago"}},{"name":"preferred_time","in":"query","required":false,"description":"Preferred slot time","schema":{"type":"string","minLength":0,"maxLength":1000,"example":"MORNING","enum":["MORNING","AFTERNOON","AM","PM"]}},{"name":"preferred_week_day","in":"query","required":false,"description":"Preferred slot week day","schema":{"type":"string","minLength":0,"maxLength":1000,"example":"MONDAY","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]}},{"name":"preferred_month","in":"query","required":false,"description":"Preferred slot month","schema":{"type":"string","minLength":0,"maxLength":1000,"example":"JANUARY","enum":["JANUARY","FEBRUARY","MARCH","APRIL","MAY","JUNE","JULY","AUGUST","SEPTEMBER","OCTOBER","NOVEMBER","DECEMBER"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","required":["count","total","page","per_page","total_pages","_embedded","_links"],"properties":{"count":{"type":"integer","description":"The number of results in the current page"},"total":{"type":"integer","description":"The total of results"},"page":{"type":"integer","description":"The current page"},"per_page":{"type":"integer","description":"The number of results per page"},"total_pages":{"type":"integer","description":"The total number of result pages"},"_embedded":{"type":"object","description":"List of possible slots for patients in current page","required":["provider_slots"],"properties":{"provider_slots":{"type":"array","items":{"type":"object","description":"Object that stores information relative to an available slot.","required":["date","time","time_preferences_flag"],"properties":{"id":{"description":"ID of the slot","type":"string","minLength":0,"maxLength":50},"date":{"description":"Date of the slot (readable)","type":"string","minLength":0,"maxLength":50},"time":{"description":"Time of the slot (readable)","type":"string","minLength":0,"maxLength":50},"time_preferences_flag":{"description":"Flag that signals if slot search was done with time preferences, and if slot matches time choices","type":"string","minLength":0,"maxLength":15},"service_type_id":{"description":"Slot service type identifier","type":"string","minLength":0,"maxLength":50},"location_id":{"description":"Slot location identifier","type":"string","minLength":0,"maxLength":50},"provider_id":{"description":"Slot provider identifier","type":"string","minLength":0,"maxLength":50},"time_zone_id":{"description":"The zone id of this available slot.","type":"string","minLength":0,"maxLength":50}}}}}},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}},"next":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}},"prev":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}},"first":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}},"last":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}}}}}},"example":{"count":1,"total":1,"page":1,"per_page":5,"total_pages":1,"_embedded":{"provider_slots":[{"id":"9234abc923ff70","date":"June 30 2022","time":"6:30 PM","time_preferences_flag":"false","service_type_id":"12345a","location_id":"cabe8b8b8","provider_id":"fafe1cc239","time_zone_id":"+02:00"}]},"_links":{"self":{"href":"http://api-docs.talkdesk.org/healthcare/available-slots"},"next":{"href":"http://api-docs.talkdesk.org/healthcare/available-slots?page=2"},"first":{"href":"http://api-docs.talkdesk.org/healthcare/available-slots"},"last":{"href":"http://api-docs.talkdesk.org/healthcare/available-slots?page=5"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Generic Bad Request":{"value":{"code":"1484000","message":"Bad request."}},"Upstream Bad Request":{"value":{"code":"1484001","message":"Bad Request in upstream."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"1484010","message":"Invalid JWT token."}},"No Upstream":{"value":{"code":"1484012","message":"No upstream selected."}},"Upstream Unauthorized":{"value":{"code":"1484014","message":"Unauthorized in upstream."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Missing Scopes":{"value":{"code":"1484030","message":"Required scopes are missing."}},"Account Forbidden":{"value":{"code":"1484031","message":"Account does not have access."}},"Upstream Forbidden":{"value":{"code":"1484032","message":"Forbidden in upstream."}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Not Found":{"value":{"code":"1484040","message":"Resource not found."}},"Upstream Not Found":{"value":{"code":"1484041","message":"Not Found in upstream."}}}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484050","message":"Method not allowed."}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484150","message":"Unsupported Media Type"}}}}}}},"/healthcare/available-provider-slots":{"get":{"tags":["HLS Providers"],"summary":"Search provider availability slots returning a list of ProviderSlot objects.","description":"Search provider available appointment slots returning a HalPaginatedResource. If the search finds multiple slots a ProviderSlot list is returned within the _embedded property of HalPaginatedResource; each ProviderSlot represents one available slot for the executed search. If no slots are found then the _embedded property of HalPaginatedResource returns an empty list.","operationId":"getProviderAvailableSlots","security":[{"GA":["hls-provider:read"]}],"parameters":[{"name":"provider_id","in":"query","required":true,"description":"Healthcare provider identification","schema":{"type":"string","minLength":0,"maxLength":1000,"example":"E1000"}},{"name":"provider_ids","in":"query","description":"The id(s) of the providers, comma separated - GetOpenSlots2019.","required":false,"example":"provider_id_1,provider_id_2","schema":{"type":"string","minLength":1,"maxLength":2147483647}},{"name":"service_type_id","in":"query","required":true,"description":"Healthcare service type identification","schema":{"type":"string","minLength":0,"maxLength":1000,"example":"1004"}},{"name":"location_id","in":"query","required":true,"description":"Healthcare location identification","schema":{"type":"string","minLength":0,"maxLength":1000,"example":"10501101"}},{"name":"interaction_id","in":"query","description":"The ID of the interaction.","required":false,"example":"b4379742769e4bb4927644fa15126c64","schema":{"type":"string","minLength":1}},{"name":"page","in":"query","description":"The page number to request. Starts at 1, defaults to 1 when not provided.","required":false,"schema":{"default":1,"minimum":1,"maximum":50,"type":"integer"}},{"name":"per_page","in":"query","description":"The maximum amount of items per page. Defaults to 5 when not provided.","required":false,"schema":{"default":5,"minimum":1,"maximum":50,"type":"integer"}},{"name":"count","in":"query","description":"When per_page is too big, this count value will limit the number of slots returned on current page. The count value can't be bigger than per_page value.","required":false,"schema":{"default":5,"minimum":1,"maximum":50,"type":"integer"}},{"name":"start_date","in":"query","description":"The date from which the available slots should be considered as a viable option according to the client’s schedule. The default value is current date. If any preferred_* parameters is set, then the actual start_date will be set according to the preferred_* conditions.","required":false,"example":"2022-01-17T11:00:00.000Z","schema":{"type":"string","format":"date-time","minLength":1}},{"name":"end_date","in":"query","description":"The date until which the available slots should be considered as a viable option according to the client’s schedule. The default value is current date plus `max_days` value.","required":false,"example":"2022-01-22T11:00:00.000Z","schema":{"type":"string","format":"date-time","minLength":1}},{"name":"max_days","in":"query","required":false,"description":"Quantity of days to look up in the future to fetch the appointments","schema":{"type":"integer","example":1,"minimum":1,"maximum":2000,"default":30}},{"name":"timezone","in":"query","required":false,"description":"Timezone from this interaction and must respect this format `America/Chicago`.","schema":{"type":"string","example":"America/Chicago"}},{"name":"preferred_time","in":"query","required":false,"description":"Preferred slot time, if slot time meet this value, then the response field `time_preferences_flag` value value will be `true`.","schema":{"type":"string","minLength":0,"maxLength":1000,"example":"MORNING","enum":["MORNING","AFTERNOON","AM","PM"]}},{"name":"preferred_week_day","in":"query","required":false,"description":"Preferred slot week day, if slot date meet this value, then the response field `time_preferences_flag` value value will be `true`.","schema":{"type":"string","minLength":0,"maxLength":1000,"example":"MONDAY","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]}},{"name":"preferred_month","in":"query","required":false,"description":"Preferred slot month, if slot date meet this value, then the response field `time_preferences_flag` value value will be `true`.","schema":{"type":"string","minLength":0,"maxLength":1000,"example":"JANUARY","enum":["JANUARY","FEBRUARY","MARCH","APRIL","MAY","JUNE","JULY","AUGUST","SEPTEMBER","OCTOBER","NOVEMBER","DECEMBER"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","required":["count","total","page","per_page","total_pages","_embedded","_links"],"properties":{"count":{"type":"integer","description":"The number of results in the current page"},"total":{"type":"integer","description":"The total of results"},"page":{"type":"integer","description":"The current page"},"per_page":{"type":"integer","description":"The number of results per page"},"total_pages":{"type":"integer","description":"The total number of result pages"},"_embedded":{"type":"object","description":"List of possible slots for patients in current page","required":["provider_slots"],"properties":{"provider_slots":{"type":"array","items":{"type":"object","description":"Object that stores information relative to an available slot.","required":["date","time","time_preferences_flag"],"properties":{"id":{"description":"ID of the slot","type":"string","minLength":0,"maxLength":50},"date":{"description":"Date of the slot (readable)","type":"string","minLength":0,"maxLength":50},"time":{"description":"Time of the slot (readable)","type":"string","minLength":0,"maxLength":50},"time_preferences_flag":{"description":"Flag that signals if slot search was done with time preferences, and if slot matches time choices","type":"string","minLength":0,"maxLength":15},"service_type_id":{"description":"Slot service type identifier","type":"string","minLength":0,"maxLength":50},"location_id":{"description":"Slot location identifier","type":"string","minLength":0,"maxLength":50},"provider_id":{"description":"Slot provider identifier","type":"string","minLength":0,"maxLength":50},"time_zone_id":{"description":"The zone id of this available slot.","type":"string","minLength":0,"maxLength":50}}}}}},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}},"next":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}},"prev":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}},"first":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}},"last":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}}}}}},"example":{"count":1,"total":1,"page":1,"per_page":5,"total_pages":1,"_embedded":{"provider_slots":[{"id":"9234abc923ff70","date":"June 30 2022","time":"6:30 PM","time_preferences_flag":"false","service_type_id":"12345a","location_id":"cabe8b8b8","provider_id":"fafe1cc239","time_zone_id":"+02:00"}]},"_links":{"self":{"href":"http://api-docs.talkdesk.org/healthcare/available-slots"},"next":{"href":"http://api-docs.talkdesk.org/healthcare/available-slots?page=2"},"first":{"href":"http://api-docs.talkdesk.org/healthcare/available-slots"},"last":{"href":"http://api-docs.talkdesk.org/healthcare/available-slots?page=5"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Generic Bad Request":{"value":{"code":"1484000","message":"Bad request."}},"Upstream Bad Request":{"value":{"code":"1484001","message":"Bad Request in upstream."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"1484010","message":"Invalid JWT token."}},"No Upstream":{"value":{"code":"1484012","message":"No upstream selected."}},"Upstream Unauthorized":{"value":{"code":"1484014","message":"Unauthorized in upstream."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Missing Scopes":{"value":{"code":"1484030","message":"Required scopes are missing."}},"Account Forbidden":{"value":{"code":"1484031","message":"Account does not have access."}},"Upstream Forbidden":{"value":{"code":"1484032","message":"Forbidden in upstream."}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Not Found":{"value":{"code":"1484040","message":"Resource not found."}},"Upstream Not Found":{"value":{"code":"1484041","message":"Not Found in upstream."}}}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484050","message":"Method not allowed."}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484150","message":"Unsupported Media Type"}}}}}}},"/healthcare/balances":{"get":{"tags":["HLS Providers"],"summary":"Get the balance of a patient","description":"Get the balance of a patient connected via an interactionId.","operationId":"getBalances","security":[{"GA":["hls-balance:read"]}],"parameters":[{"name":"interaction_id","in":"query","required":true,"description":"Interaction ID","schema":{"type":"string","example":"abc","minLength":1,"maxLength":2147483647}},{"name":"statement_id","in":"query","required":false,"description":"This query parameter is required on Cerner integrations.","schema":{"type":"string","example":"123123123","minLength":1,"maxLength":2147483647}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","required":["total_balance"],"properties":{"id":{"type":"string","description":"The operation identifier.","example":"fae7bb59-e312-4752-8ea8-dbeea32a714a"},"total_balance":{"type":"number","description":"The total balance","example":3324.5},"accounts":{"type":"array","items":{"type":"object","required":["account_balance"],"properties":{"account_id":{"type":"string","description":"The account id"},"account_balance":{"type":"number","description":"The account balance"},"billing_system":{"type":"string","description":"The billing system"}}}}}},"example":{"id":"fae7bb59-e312-4752-8ea8-dbeea32a714a","total_balance":3324.5,"accounts":[{"account_id":"1058","account_balance":3324.5,"billing_system":"PB/HB"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Generic Bad Request":{"value":{"code":"1484000","message":"Bad request."}},"Upstream Bad Request":{"value":{"code":"1484001","message":"Bad Request in upstream."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"1484010","message":"Invalid JWT token."}},"No Upstream":{"value":{"code":"1484012","message":"No upstream selected."}},"Upstream Unauthorized":{"value":{"code":"1484014","message":"Unauthorized in upstream."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Missing Scopes":{"value":{"code":"1484030","message":"Required scopes are missing."}},"Account Forbidden":{"value":{"code":"1484031","message":"Account does not have access."}},"Upstream Forbidden":{"value":{"code":"1484032","message":"Forbidden in upstream."}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Not Found":{"value":{"code":"1484040","message":"Resource not found."}},"Upstream Not Found":{"value":{"code":"1484041","message":"Not Found in upstream."}}}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484050","message":"Method not allowed."}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484150","message":"Unsupported Media Type"}}}}}}},"/healthcare/suggest-providers-va":{"get":{"tags":["HLS Providers"],"summary":"Search suggest provider returning a list of Provider's names","description":"Search suggest provider returning a HalPaginatedResource. If the search finds multiple providers a ProviderVoiceVA list is returned within the _embedded property of HalPaginatedResource; each ProviderVoiceVA represents a name of a provider for the executed search. If no providers are found then the _embedded property of HalPaginatedResource returns an empty list.","operationId":"suggestProviders","security":[{"GA":["hls-provider:read"]}],"parameters":[{"name":"interaction_id","in":"query","required":true,"description":"Required interaction Id","schema":{"type":"string","example":"abc","minLength":1,"maxLength":2147483647}},{"name":"remove_pcp_flag","in":"query","description":"Remove pcp providers or not","schema":{"default":true,"type":"boolean"},"example":true},{"name":"page","in":"query","description":"The page number to request. Starts at 1, defaults to 1 when not provided.","required":false,"schema":{"default":1,"minimum":1,"maximum":50,"type":"integer"}},{"name":"per_page","in":"query","description":"The maximum amount of items per page. Defaults to 5 when not provided.","required":false,"schema":{"default":5,"minimum":1,"maximum":50,"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","required":["count","total","page","per_page","total_pages","_embedded","_links"],"properties":{"count":{"type":"integer","description":"The number of results in the current page"},"total":{"type":"integer","description":"The total of results"},"page":{"type":"integer","description":"The current page"},"per_page":{"type":"integer","description":"The number of results per page"},"total_pages":{"type":"integer","description":"The total number of result pages"},"_embedded":{"type":"object","description":"List of possible provider's names in current page","required":["provider_names"],"properties":{"provider_names":{"type":"array","items":{"type":"object","description":"Object that stores the providers name.","required":["name"],"properties":{"name":{"description":"Provider's name (readable)","type":"string","minLength":0,"maxLength":50}}}}}},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}},"next":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}},"prev":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}},"first":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}},"last":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}}}}}},"example":{"count":1,"total":1,"page":1,"per_page":5,"total_pages":1,"_embedded":{"provider_names":[{"name":"Physician Dermatology, MD"}]},"_links":{"self":{"href":"http://api-docs.talkdesk.org/healthcare/suggest-providers"},"next":{"href":"http://api-docs.talkdesk.org/healthcare/suggest-providers?page=2"},"first":{"href":"http://api-docs.talkdesk.org/healthcare/suggest-providers"},"last":{"href":"http://api-docs.talkdesk.org/healthcare/suggest-providers?page=5"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Generic Bad Request":{"value":{"code":"1484000","message":"Bad request."}},"Upstream Bad Request":{"value":{"code":"1484001","message":"Bad Request in upstream."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"1484010","message":"Invalid JWT token."}},"No Upstream":{"value":{"code":"1484012","message":"No upstream selected."}},"Upstream Unauthorized":{"value":{"code":"1484014","message":"Unauthorized in upstream."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Missing Scopes":{"value":{"code":"1484030","message":"Required scopes are missing."}},"Account Forbidden":{"value":{"code":"1484031","message":"Account does not have access."}},"Upstream Forbidden":{"value":{"code":"1484032","message":"Forbidden in upstream."}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Not Found":{"value":{"code":"1484040","message":"Resource not found."}},"Upstream Not Found":{"value":{"code":"1484041","message":"Not Found in upstream."}}}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484050","message":"Method not allowed."}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484150","message":"Unsupported Media Type"}}}}}}},"/healthcare/patients-studio":{"get":{"tags":["HLS Providers"],"summary":"Search by patients returning a PatientStudio object","description":"Search by patients returning one PatientStudio object only. If the search result returns a number of patients different from one, a PatientStudio object is returned with its count property pointing to the number of results found.","operationId":"searchPatientsStudio","security":[{"GA":["hls-patient:read"]}],"parameters":[{"name":"interaction_id","in":"query","required":true,"description":"Required interaction Id","schema":{"type":"string","example":"abc","minLength":1,"maxLength":2147483647}},{"name":"first_name","in":"query","required":false,"description":"Patient's first name","schema":{"type":"string","example":"John","minLength":1,"maxLength":2147483647}},{"name":"last_name","in":"query","required":false,"description":"Patient's last name","schema":{"type":"string","example":"Doe","minLength":1,"maxLength":2147483647}},{"name":"ssn","in":"query","required":false,"description":"Patient's social security number","schema":{"type":"string","example":"123-45-2145","minLength":1,"maxLength":2147483647}},{"name":"lookup_information","in":"query","required":false,"description":"The information to be used to search for the patient. It must be present if the lookup_information_type is present.","schema":{"type":"string","example":"80452145","minLength":1,"maxLength":2147483647}},{"name":"lookup_information_type","in":"query","required":false,"description":"The information type to be used to search for the patient. It must be present if the lookup_information is present.","schema":{"type":"string","enum":["DOB","SS","PH","A","HAR","IN"],"example":"PH","minLength":1,"maxLength":2147483647}},{"name":"mrn","in":"query","required":false,"description":"Patient's medical record number","schema":{"type":"string","example":"4364675453","minLength":1,"maxLength":2147483647}},{"name":"birth_date","in":"query","required":false,"description":"Birth date","schema":{"type":"string","format":"string","example":"yyyyMMdd","minLength":1,"maxLength":2147483647}},{"name":"gender","in":"query","required":false,"description":"Gender","schema":{"type":"string","enum":["MALE","FEMALE","OTHER","UNKNOWN"],"example":"MALE"}},{"name":"phone_number","in":"query","required":false,"description":"Patient's phone number","schema":{"type":"string","example":"919998877","minLength":1,"maxLength":15}},{"name":"get_pcp_info","in":"query","required":false,"description":"Optional flag to get the full information of the primary care provider(s) (PCP) linked to a patient. Defaults to false.","schema":{"type":"boolean","example":false}},{"name":"timezone","in":"query","required":false,"description":"Timezone from this interaction and must respect this format `US/Eastern`.","schema":{"type":"string","example":"US/Eastern","minLength":1,"maxLength":2147483647}},{"name":"zipcode","in":"query","required":false,"description":"The zipcode of the patient's home address","schema":{"type":"string","example":"92040"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string"}}}}},"id":{"type":"string"},"name":{"type":"string"},"ssn":{"type":"string"},"mrn":{"type":"string"},"birth_date":{"type":"string","format":"date"},"gender":{"type":"string","enum":["MALE","FEMALE","OTHER","UNKNOWN"]},"home_phone_number":{"type":"string"},"work_phone_number":{"type":"string"},"mobile_phone_number":{"type":"string"},"home_address_city":{"type":"string"},"home_address_state":{"type":"string"},"marital_status":{"type":"string"},"language":{"type":"string"},"active":{"type":"string"},"count":{"type":"integer"},"popup_url":{"type":"string"},"patient_status":{"type":"string"},"operation_outcome":{"type":"string"},"pcp_id":{"type":"string"},"pcp_name":{"type":"string"},"self_service_active":{"type":"string"},"postal_code":{"type":"string"},"rendering_provider_name":{"type":"string","description":"Patient's Rendering Provider name."},"rendering_provider_id":{"type":"string","description":"Patient's Rendering Provider ID."},"custom_fields":{"type":"object","description":"The custom fields associated with the provider, which is Athena."},"mychart_account_id":{"type":"string","description":"The unique identifier for the patient's MyChart account."}}},"example":{"_links":{"self":{"href":"https://api.talkdesk.com/healthcare/patients-studio?interaction_id=123&phone_number=123-123-123"}},"id":"123456qwerty","active":"true","birth_date":"1990-01-01","count":1,"gender":"MALE","home_address_city":"United States","home_address_state":"Coimbra","home_phone_number":"999-917-1234","language":"EN","marital_status":"SINGLE AND FREE","mobile_phone_number":"999-917-1234","mrn":"123456","name":"Figg Figg","ssn":"484-76-1235","work_phone_number":"999-917-1234","popup_url":"http://industries-auth.meza.talkdeskstg.com/forward","patient_status":"vipPatient","operation_outcome":"Additional data may be available using the Break-the-Glass protocol.","pcp_id":"E1000","pcp_name":"Physician Family Medicine, MD","self_service_active":"false","postal_code":"12345","rendering_provider_name":"renderingProvider 123","rendering_provider_id":"123","custom_fields":{"custom_field_1":"99999"},"mychart_account_id":"MYCHARTALLISON"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Generic Bad Request":{"value":{"code":"1484000","message":"Bad request."}},"Upstream Bad Request":{"value":{"code":"1484001","message":"Bad Request in upstream."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"1484010","message":"Invalid JWT token."}},"No Upstream":{"value":{"code":"1484012","message":"No upstream selected."}},"Upstream Unauthorized":{"value":{"code":"1484014","message":"Unauthorized in upstream."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Missing Scopes":{"value":{"code":"1484030","message":"Required scopes are missing."}},"Account Forbidden":{"value":{"code":"1484031","message":"Account does not have access."}},"Upstream Forbidden":{"value":{"code":"1484032","message":"Forbidden in upstream."}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Not Found":{"value":{"code":"1484040","message":"Resource not found."}},"Upstream Not Found":{"value":{"code":"1484041","message":"Not Found in upstream."}}}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484050","message":"Method not allowed."}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484150","message":"Unsupported Media Type"}}}}}}},"/healthcare/patients-studio/brief":{"get":{"tags":["HLS Providers"],"summary":"Search patients returning brief information of the patient","description":"Search patients returning brief information of the patient, this API is a brief implementation of the patient_studio API, it will respond faster and only return patient basic information.","operationId":"searchPatientsStudioBrief","security":[{"GA":["hls-patient:read"]}],"parameters":[{"name":"interaction_id","in":"query","required":true,"description":"Required interaction Id","schema":{"type":"string","example":"abc","minLength":1,"maxLength":2147483647}},{"name":"first_name","in":"query","required":false,"description":"Patient's first name","schema":{"type":"string","example":"John","minLength":1,"maxLength":2147483647}},{"name":"last_name","in":"query","required":false,"description":"Patient's last name","schema":{"type":"string","example":"Doe","minLength":1,"maxLength":2147483647}},{"name":"ssn","in":"query","required":false,"description":"Patient's social security number","schema":{"type":"string","example":"123-45-2145","minLength":1,"maxLength":2147483647}},{"name":"mrn","in":"query","required":false,"description":"Patient's medical record number","schema":{"type":"string","example":"4364675453","minLength":1,"maxLength":2147483647}},{"name":"birth_date","in":"query","required":false,"description":"Birth date","schema":{"type":"string","format":"string","example":"yyyyMMdd","minLength":1,"maxLength":2147483647}},{"name":"gender","in":"query","required":false,"description":"Gender","schema":{"type":"string","enum":["MALE","FEMALE","OTHER","UNKNOWN"],"example":"MALE"}},{"name":"phone_number","in":"query","required":false,"description":"Patient's phone number","schema":{"type":"string","example":"919998877","minLength":1,"maxLength":15}},{"name":"get_pcp_info","in":"query","required":false,"description":"Optional flag to get the full information of the primary care provider(s) (PCP) linked to a patient. Defaults to false.","schema":{"type":"boolean","example":false}},{"name":"timezone","in":"query","required":false,"description":"Timezone from this interaction and must respect this format `US/Eastern`.","schema":{"type":"string","example":"US/Eastern","minLength":1,"maxLength":2147483647}},{"name":"zipcode","in":"query","required":false,"description":"The zipcode of the patient's home address","schema":{"type":"string","example":"92040"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string"}}}}},"id":{"type":"string"},"name":{"type":"string"},"ssn":{"type":"string"},"mrn":{"type":"string"},"birth_date":{"type":"string","format":"date"},"gender":{"type":"string","enum":["MALE","FEMALE","OTHER","UNKNOWN"]}}},"example":{"_links":{"self":{"href":"https://api.talkdesk.com/healthcare/patients-studio?interaction_id=123&phone_number=123-123-123"}},"id":"123456qwerty","birth_date":"1990-01-01","count":1,"gender":"MALE","mrn":"123456","name":"Figg Figg","ssn":"484-76-1235"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Generic Bad Request":{"value":{"code":"1484000","message":"Bad request."}},"Upstream Bad Request":{"value":{"code":"1484001","message":"Bad Request in upstream."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"1484010","message":"Invalid JWT token."}},"No Upstream":{"value":{"code":"1484012","message":"No upstream selected."}},"Upstream Unauthorized":{"value":{"code":"1484014","message":"Unauthorized in upstream."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Missing Scopes":{"value":{"code":"1484030","message":"Required scopes are missing."}},"Account Forbidden":{"value":{"code":"1484031","message":"Account does not have access."}},"Upstream Forbidden":{"value":{"code":"1484032","message":"Forbidden in upstream."}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Not Found":{"value":{"code":"1484040","message":"Resource not found."}},"Upstream Not Found":{"value":{"code":"1484041","message":"Not Found in upstream."}}}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484050","message":"Method not allowed."}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484150","message":"Unsupported Media Type"}}}}}}},"/healthcare/patient-information":{"get":{"tags":["HLS Providers"],"summary":"Get the patient information of a patient.","description":"Get the patient information of a patient.","operationId":"patientInformation","security":[{"GA":["hls-patient:read"]}],"parameters":[{"name":"interaction_id","in":"query","required":true,"description":"Required interaction Id","schema":{"type":"string","example":"abc","minLength":1,"maxLength":2147483647}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"Patient's id"},"name":{"type":"string","description":"Patient name related to this interaction."},"birth_date":{"type":"string","description":"Patient's birth date, in yyyyMMdd."},"gender":{"type":"string","description":"Patient's gender. May be Female, Male, Other or Unknown."},"pcp":{"type":"string","description":"Patient's Primary Care Provider name. It corresponds to the Patient's first general Practitioner display."},"mrn":{"type":"string","description":"Patient's Medical Record Number."},"self_service_active":{"type":"boolean","description":"Patient self service related to this interaction."},"rendering_provider_name":{"type":"string","description":"Patient's Rendering Provider name."},"rendering_provider_id":{"type":"string","description":"Patient's Rendering Provider ID."},"custom_fields":{"type":"object","description":"The custom fields associated with the provider, which is Athena."},"home_address":{"type":"object","description":"Patient's home address","properties":{"line":{"type":"string","description":"Address line"},"city":{"type":"string","description":"Address city"},"district":{"type":"string","description":"Address district"},"state":{"type":"string","description":"Address state"},"postal_code":{"type":"string","description":"Address postal code"},"country":{"type":"string","description":"Address country"},"full":{"type":"string","description":"Full address"},"use":{"type":"string","description":"Address use","enum":["HOME","WORK","TEMP","OLD"]}}}}},"example":{"id":"id_123_456","name":"Gavin Lawson","birth_date":"1990-01-01","gender":"Other","pcp":"Physician Family Medicine, MD","mrn":"123456","self_service_active":false,"rendering_provider_name":"renderingProvider 123","rendering_provider_id":"123","custom_fields":{"custom_field_1":"99999"},"home_address":{"line":"123 Main St., Address line 2, Address line 3","city":"Madison","district":"district","state":"WI","postal_code":"53703","country":"US","full":"full","use":"HOME"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Generic Bad Request":{"value":{"code":"1484000","message":"Bad request."}},"Upstream Bad Request":{"value":{"code":"1484001","message":"Bad Request in upstream."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"1484010","message":"Invalid JWT token."}},"No Upstream":{"value":{"code":"1484012","message":"No upstream selected."}},"Upstream Unauthorized":{"value":{"code":"1484014","message":"Unauthorized in upstream."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Missing Scopes":{"value":{"code":"1484030","message":"Required scopes are missing."}},"Account Forbidden":{"value":{"code":"1484031","message":"Account does not have access."}},"Upstream Forbidden":{"value":{"code":"1484032","message":"Forbidden in upstream."}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Not Found":{"value":{"code":"1484040","message":"Resource not found."}},"Upstream Not Found":{"value":{"code":"1484041","message":"Not Found in upstream."}}}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484050","message":"Method not allowed."}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484150","message":"Unsupported Media Type"}}}}}}},"/healthcare/call-answered":{"post":{"tags":["HLS Providers"],"summary":"Write to the HLS Providers Call Answered API","operationId":"healthcareCallAnswered","security":[{"GA":["hls-providers:call-answered"]}],"parameters":[{"name":"interaction_id","in":"query","required":true,"schema":{"type":"string","example":"interaction_id"}},{"name":"agent_id","in":"query","required":true,"schema":{"type":"string","example":"agent_id"}},{"name":"dialed_phone_number","in":"query","required":false,"description":"The phone number that the patient called to(target phone number). This is optional and can be used to provide additional context.","schema":{"type":"string","example":"dialed_phone_number"}}],"responses":{"200":{"description":"Agent mapped to interaction"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Generic Bad Request":{"value":{"code":"1484000","message":"Bad request."}},"Upstream Bad Request":{"value":{"code":"1484001","message":"Bad Request in upstream."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"1484010","message":"Invalid JWT token."}},"No Upstream":{"value":{"code":"1484012","message":"No upstream selected."}},"Upstream Unauthorized":{"value":{"code":"1484014","message":"Unauthorized in upstream."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Missing Scopes":{"value":{"code":"1484030","message":"Required scopes are missing."}},"Account Forbidden":{"value":{"code":"1484031","message":"Account does not have access."}},"Upstream Forbidden":{"value":{"code":"1484032","message":"Forbidden in upstream."}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Not Found":{"value":{"code":"1484040","message":"Resource not found."}},"Upstream Not Found":{"value":{"code":"1484041","message":"Not Found in upstream."}}}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484050","message":"Method not allowed."}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484150","message":"Unsupported Media Type"}}}}}}},"/healthcare/contacts/sync-from-ehr":{"post":{"tags":["HLS Providers"],"summary":"Update Talkdesk contact by phone number with the patient information for the given interaction id","operationId":"updateTalkdeskContact","security":[{"GA":["hls-contact:write"]}],"parameters":[{"name":"phone_number","in":"query","required":true,"schema":{"type":"string","example":"+351922222222","minLength":1,"maxLength":16}},{"name":"interaction_id","in":"query","required":true,"schema":{"type":"string","example":"12456","minLength":1,"maxLength":64}},{"name":"patient_id","in":"query","required":false,"schema":{"type":"string","example":"456678","minLength":1,"maxLength":64}}],"responses":{"204":{"description":"Talkdesk contact updated with patient information"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Generic Bad Request":{"value":{"code":"1484000","message":"Bad request."}},"Upstream Bad Request":{"value":{"code":"1484001","message":"Bad Request in upstream."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"1484010","message":"Invalid JWT token."}},"No Upstream":{"value":{"code":"1484012","message":"No upstream selected."}},"Upstream Unauthorized":{"value":{"code":"1484014","message":"Unauthorized in upstream."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Missing Scopes":{"value":{"code":"1484030","message":"Required scopes are missing."}},"Account Forbidden":{"value":{"code":"1484031","message":"Account does not have access."}},"Upstream Forbidden":{"value":{"code":"1484032","message":"Forbidden in upstream."}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Not Found":{"value":{"code":"1484040","message":"Resource not found."}},"Upstream Not Found":{"value":{"code":"1484041","message":"Not Found in upstream."}}}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484050","message":"Method not allowed."}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Conflict":{"value":{"code":"1484090","message":"Conflict."}},"MultiplePhoneNumbersConflict":{"value":{"code":"1484091","message":"Multiple Phone Numbers Conflict."}}}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484150","message":"Unsupported Media Type"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484220","message":"Unprocessable Entity."}}}}}}},"/healthcare/contacts/reset":{"post":{"tags":["HLS Providers"],"summary":"Reset Talkdesk contact by phone number","description":"Reset Talkdesk contact by phone number (e.g. remove all traits of this contact except the phone number,\nand rename the contact name to said phone number)","operationId":"resetTalkdeskContact","security":[{"GA":["hls-contact:write"]}],"parameters":[{"name":"phone_number","in":"query","required":true,"schema":{"type":"string","example":"+351922222222","minLength":1,"maxLength":16}}],"responses":{"200":{"description":"Talkdesk contact successfully reset"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Generic Bad Request":{"value":{"code":"1484000","message":"Bad request."}},"Upstream Bad Request":{"value":{"code":"1484001","message":"Bad Request in upstream."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"1484010","message":"Invalid JWT token."}},"No Upstream":{"value":{"code":"1484012","message":"No upstream selected."}},"Upstream Unauthorized":{"value":{"code":"1484014","message":"Unauthorized in upstream."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Missing Scopes":{"value":{"code":"1484030","message":"Required scopes are missing."}},"Account Forbidden":{"value":{"code":"1484031","message":"Account does not have access."}},"Upstream Forbidden":{"value":{"code":"1484032","message":"Forbidden in upstream."}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Not Found":{"value":{"code":"1484040","message":"Resource not found."}},"Upstream Not Found":{"value":{"code":"1484041","message":"Not Found in upstream."}}}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484050","message":"Method not allowed."}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Conflict":{"value":{"code":"1484090","message":"Conflict."}},"MultiplePhoneNumbersConflict":{"value":{"code":"1484091","message":"Multiple Phone Numbers Conflict."}}}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484150","message":"Unsupported Media Type"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484220","message":"Unprocessable Entity."}}}}}}},"/healthcare/epic/phone-action":{"post":{"tags":["HLS Providers"],"summary":"Act (Pause or resume) call recording of specified EHR agent","description":"Act (Pause or resume) call recording of specified EHR agent","operationId":"phoneAction","security":[{"GA":["hls-phone-action:write"]}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["PhoneSystemRequest"],"properties":{"PhoneSystemRequest":{"type":"object","description":"Phone System Request object","required":["Action","User"],"properties":{"Action":{"type":"string","enum":["Pause","Resume"],"description":"Action to be performed on the call recording"},"User":{"type":"string","description":"Epic user id of employee requesting the call to be paused/resumed","minLength":1,"maxLength":2147483647},"Department":{"type":"integer","description":"Epic user department","minimum":1,"maximum":2147483647},"Workstation":{"type":"string","description":"Epic user workstation id","minLength":1,"maxLength":2147483647},"ID":{"type":"string","description":"External id of the user","minLength":1,"maxLength":2147483647}}}}},"example":{"PhoneSystemRequest":{"Action":"Pause","User":"123123","Department":10501101,"Workstation":"123A"}}}}},"responses":{"200":{"description":"Phone System Response object","content":{"application/json":{"schema":{"type":"object","required":["PhoneSystemResponse"],"properties":{"PhoneSystemResponse":{"type":"object","description":"Phone System Response object","required":["PhoneSystemResult"],"properties":{"PhoneSystemResult":{"type":"object","description":"Phone System Result object","required":["Success"],"properties":{"Success":{"type":"string","enum":["True","False"]}}}}}}},"example":{"PhoneSystemResponse":{"PhoneSystemResult":{"Success":"True"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Generic Bad Request":{"value":{"code":"1484000","message":"Bad request."}},"Upstream Bad Request":{"value":{"code":"1484001","message":"Bad Request in upstream."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"1484010","message":"Invalid JWT token."}},"No Upstream":{"value":{"code":"1484012","message":"No upstream selected."}},"Upstream Unauthorized":{"value":{"code":"1484014","message":"Unauthorized in upstream."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Missing Scopes":{"value":{"code":"1484030","message":"Required scopes are missing."}},"Account Forbidden":{"value":{"code":"1484031","message":"Account does not have access."}},"Upstream Forbidden":{"value":{"code":"1484032","message":"Forbidden in upstream."}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Not Found":{"value":{"code":"1484040","message":"Resource not found."}},"Upstream Not Found":{"value":{"code":"1484041","message":"Not Found in upstream."}}}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484050","message":"Method not allowed."}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484150","message":"Unsupported Media Type"}}}}}}},"/healthcare/epic/click-to-call":{"post":{"tags":["HLS Providers"],"summary":"Initiate call for authorized EHR agent","description":"Initiate call for authorized EHR agent","operationId":"clickToCall","security":[{"GA":["hls-click-to-call:write"]}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["PhoneAgentID","OriginPhoneExtension","PhoneNumber","EpicCallID"],"properties":{"PhoneAgentID":{"type":"string","description":"EPIC user id","minLength":1,"maxLength":2147483647},"OriginPhoneExtension":{"type":"string","description":"The extension used as the phone number for the call initiated from Epic","minLength":1,"maxLength":2147483647},"PhoneNumber":{"type":"string","description":"Phone number to be dialed","minLength":1,"maxLength":2147483647},"EpicCallID":{"type":"string","description":"Internal EPIC ID of the record that represents this call","minLength":1,"maxLength":2147483647}}},"example":{"PhoneAgentID":"8742eb9e-3358-11ec-8d3d-0242ac130003","OriginPhoneExtension":"973","PhoneNumber":"+19876543210","EpicCallId":"bb40c182-3358-11ec-8d3d-0242ac130003"}}}},"responses":{"201":{"description":"Click to call response object","content":{"application/json":{"schema":{"type":"object","required":["PhoneSystemCallID"],"properties":{"PhoneSystemCallID":{"type":"string","description":"Unique identifier for the call in the phone system"}}},"example":{"PhoneSystemCallID":"56789"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Generic Bad Request":{"value":{"code":"1484000","message":"Bad request."}},"Upstream Bad Request":{"value":{"code":"1484001","message":"Bad Request in upstream."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"1484010","message":"Invalid JWT token."}},"No Upstream":{"value":{"code":"1484012","message":"No upstream selected."}},"Upstream Unauthorized":{"value":{"code":"1484014","message":"Unauthorized in upstream."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Missing Scopes":{"value":{"code":"1484030","message":"Required scopes are missing."}},"Account Forbidden":{"value":{"code":"1484031","message":"Account does not have access."}},"Upstream Forbidden":{"value":{"code":"1484032","message":"Forbidden in upstream."}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Not Found":{"value":{"code":"1484040","message":"Resource not found."}},"Upstream Not Found":{"value":{"code":"1484041","message":"Not Found in upstream."}}}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484050","message":"Method not allowed."}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484150","message":"Unsupported Media Type"}}}}}}},"/healthcare/epic/outgoing-sms":{"post":{"tags":["HLS Providers"],"summary":"Outgoing SMS - EPIC","description":"EPIC request to send outgoing SMS","operationId":"outgoingSms","security":[{"GA":["hls-epic-outgoing-sms:write"]}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["ToPhoneParameter","BodyParameter"],"properties":{"ToPhoneParameter":{"type":"string","description":"Recipient phone number with country code","minLength":1,"maxLength":2147483647},"BodyParameter":{"type":"string","description":"The contents of the message","minLength":1,"maxLength":2147483647}}},"example":{"ToPhoneParameter":"16082719000","BodyParameter":"Scheduled|12345"}}}},"responses":{"200":{"description":"Outgoing Sms response"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Generic Bad Request":{"value":{"code":"1484000","message":"Bad request."}},"Upstream Bad Request":{"value":{"code":"1484001","message":"Bad Request in upstream."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"1484010","message":"Invalid JWT token."}},"No Upstream":{"value":{"code":"1484012","message":"No upstream selected."}},"Upstream Unauthorized":{"value":{"code":"1484014","message":"Unauthorized in upstream."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Missing Scopes":{"value":{"code":"1484030","message":"Required scopes are missing."}},"Account Forbidden":{"value":{"code":"1484031","message":"Account does not have access."}},"Upstream Forbidden":{"value":{"code":"1484032","message":"Forbidden in upstream."}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Not Found":{"value":{"code":"1484040","message":"Resource not found."}},"Upstream Not Found":{"value":{"code":"1484041","message":"Not Found in upstream."}}}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484050","message":"Method not allowed."}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484150","message":"Unsupported Media Type"}}}}}}},"/healthcare/epic/agent-status-sync":{"post":{"tags":["HLS Providers"],"summary":"Agent status sync for Epic","description":"EPIC request to sync agent status changes","operationId":"agentStatusSync","security":[{"GA":["hls-epic-agent-status-sync:write"]}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["EpicAgentIDs","Action"],"properties":{"EpicAgentIDs":{"type":"array","description":"The EPIC user IDs which will be used by talkdesk to map the agents","items":{"type":"object","required":["ID"],"properties":{"ID":{"type":"string","description":"The EPIC user identifier for the agent","minLength":1},"Type":{"type":"string","description":"The type of agent identifier","minLength":1}}},"example":[{"ID":"1234","Type":"Internal"},{"ID":"abcd","Type":"External"}]},"Action":{"type":"string","description":"What action should happen for this agent? Allowed values are RESERVE and RELEASE","enum":["RESERVE","RELEASE"]},"PhoneAgentId":{"type":"string","description":"The agent id on talkdesk. Note that this field will be discarded by TALKDESK","minLength":1,"maxLength":2147483647},"PhoneExtension":{"type":"string","description":"The extension for the phone that is associated with the workstation the agent is using. Note that this field will be discarded by TALKDESK"}}},"example":{"EpicAgentIDs":[{"ID":"1234","Type":"Internal"},{"ID":"abcd","Type":"External"}],"Action":"RESERVE"}}}},"responses":{"204":{"description":"Successful operation"},"400":{"description":"Invalid request body","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Generic Bad Request":{"value":{"code":"1484000","message":"Bad request."}},"Upstream Bad Request":{"value":{"code":"1484001","message":"Bad Request in upstream."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"1484010","message":"Invalid JWT token."}},"No Upstream":{"value":{"code":"1484012","message":"No upstream selected."}},"Upstream Unauthorized":{"value":{"code":"1484014","message":"Unauthorized in upstream."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Missing Scopes":{"value":{"code":"1484030","message":"Required scopes are missing."}},"Account Forbidden":{"value":{"code":"1484031","message":"Account does not have access."}},"Upstream Forbidden":{"value":{"code":"1484032","message":"Forbidden in upstream."}}}}}},"404":{"description":"Agent not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Not Found":{"value":{"code":"1484040","message":"Resource not found."}},"Upstream Not Found":{"value":{"code":"1484041","message":"Not Found in upstream."}}}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484050","message":"Method not allowed."}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484150","message":"Unsupported Media Type"}}}},"422":{"description":"Agent status change is not possible","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484220","message":"Unprocessable Entity."}}}}}}},"/healthcare/in-basket-message":{"post":{"tags":["HLS Providers"],"summary":"Send inbasket message","description":"Send inbasket message to Epic","operationId":"sendInbasketMessage","security":[{"GA":["hls-inbasket-message:write"]}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["message_priority","message_text","message_type","recipients","sender_id"],"properties":{"contact_id":{"type":"string","description":"The identifier for the reason for contact (e.g., appointment ID, order ID, etc.)","minLength":1,"maxLength":2147483647},"contact_id_type":{"type":"string","description":"The type of identifier used for the reason for contact (e.g., appointment ID, order ID, etc.)"},"message_priority":{"type":"string","description":"The standard values are `High`, `Routine`, `Low`, but they can be customized out of these standard values","minLength":1,"maxLength":2147483647},"message_text":{"type":"string","description":"The message text that contains all the required information of this business","minLength":1,"maxLength":2147483647},"message_type":{"type":"string","description":"The message type of the message being sent, it ust correspond to the a value ourside of Epic's release range or part of the safelist. This element also accepts the title.","minLength":1,"maxLength":2147483647},"patient_id":{"type":"string","description":"The patient identifier to include with the message, normally it is the FHIR type patient identifier","minLength":1,"maxLength":2147483647},"patient_id_type":{"type":"string","description":"The patient ID type, possibilities are \"CID\", \"RecordID\", \"Name\", \"NationalID\", \"MRN\" etc...","minLength":1,"maxLength":2147483647},"recipients":{"type":"array","description":"The recipients of the message, this is an array of object type Recipient","items":{"type":"object","description":"The recipient object that contains the recipient id, type and is_pool","properties":{"id":{"type":"string","description":"The recipient identifier","minLength":1,"maxLength":2147483647},"id_type":{"type":"string","description":"The recipient id type, possibilities are \"CID\", \"RecordID\", \"Name\", \"SystemLogin\", \"Alias\" etc..., default is \"Internal\"","minLength":1,"maxLength":2147483647},"is_pool":{"type":"boolean","description":"Whether the recipient id should be considered the id of a pool, if it's true, the id field is required","minLength":1,"maxLength":2147483647}}}},"sender_id":{"type":"string","description":"The identifier corresponding to a user to be identified as the sender of the message. Type of identifier is given in sender_id_type","minLength":1,"maxLength":2147483647},"sender_id_type":{"type":"string","description":"The sender id type, possibilities are \"CID\", \"RecordID\", \"Name\", \"SystemLogin\", \"Alias\" etc..., default is \"Internal\"","minLength":1,"maxLength":2147483647}}},"example":{"message_priority":"Routine","message_text":"The patient has a new appointment scheduled for 2023-10-01 at 10:00 AM.","message_type":"9999900","patient_id":"E2733","patient_id_type":"EPI","recipients":[{"id":"IPMD","id_type":"External","is_pool":false}],"sender_id":"FAMMD","sender_id_type":"External"}}}},"responses":{"204":{"description":"Successful operation"},"400":{"description":"Invalid request body","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Generic Bad Request":{"value":{"code":"1484000","message":"Bad request."}},"Upstream Bad Request":{"value":{"code":"1484001","message":"Bad Request in upstream."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"1484010","message":"Invalid JWT token."}},"No Upstream":{"value":{"code":"1484012","message":"No upstream selected."}},"Upstream Unauthorized":{"value":{"code":"1484014","message":"Unauthorized in upstream."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Missing Scopes":{"value":{"code":"1484030","message":"Required scopes are missing."}},"Account Forbidden":{"value":{"code":"1484031","message":"Account does not have access."}},"Upstream Forbidden":{"value":{"code":"1484032","message":"Forbidden in upstream."}}}}}},"404":{"description":"Agent not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Not Found":{"value":{"code":"1484040","message":"Resource not found."}},"Upstream Not Found":{"value":{"code":"1484041","message":"Not Found in upstream."}}}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484050","message":"Method not allowed."}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484150","message":"Unsupported Media Type"}}}}}}},"/healthcare/epic/patients/{patient_id}/mychart-password":{"put":{"tags":["HLS Providers"],"summary":"Epic MyChart reset password","description":"Send a password reset request to Epic MyChart for a patient.","operationId":"mychartResetPassword","security":[{"GA":["hls-epic-my-chart-reset-password:write"]}],"parameters":[{"name":"patient_id","description":"The patient identifier in the format required by the upstream system.","in":"path","required":true,"schema":{"type":"string","minLength":1}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["my_chart_account_id","site_id"],"properties":{"my_chart_account_id":{"type":"string","description":"The unique identifier for the patient's MyChart account.","minLength":1,"maxLength":2147483647},"site_id":{"type":"string","description":"The identifier for the healthcare site associated with the MyChart account.","minLength":1,"maxLength":2147483647},"message_type":{"type":"integer","description":"The type of message to be sent for password reset (e.g., 1 for email, 2 for SMS).","minimum":1,"maximum":2},"my_chart_account_id_type":{"type":"string","description":"The type of MyChart account identifier (e.g., \"MYCHARTLOGIN\").","minLength":1,"maxLength":2147483647}}},"example":{"my_chart_account_id":"MYCHARTALLISON","site_id":"https://mychart.examplehealth.org","message_type":2,"my_chart_account_id_type":"MYCHARTLOGIN"}}}},"responses":{"202":{"description":"Accepted"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"1484010","message":"Invalid JWT token."}},"No Upstream":{"value":{"code":"1484012","message":"No upstream selected."}},"Upstream Unauthorized":{"value":{"code":"1484014","message":"Unauthorized in upstream."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Missing Scopes":{"value":{"code":"1484030","message":"Required scopes are missing."}},"Account Forbidden":{"value":{"code":"1484031","message":"Account does not have access."}},"Upstream Forbidden":{"value":{"code":"1484032","message":"Forbidden in upstream."}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Generic Not Found":{"value":{"code":"1484040","message":"Resource not found."}},"Upstream Not Found":{"value":{"code":"1484041","message":"Not Found in upstream."}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Unprocessable Entity":{"value":{"code":"1484220","message":"Unprocessable Entity."}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}}}}}}}},"/healthcare/epic/oauth/jwks":{"get":{"tags":["HLS Providers"],"summary":"Get the jwks to be used within the header of the jwt epic oauth2 flow","description":"Get the jwks to be used within the header of the jwt epic oauth2 flow","operationId":"healthcareEpicOauthJwks","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"},"example":"abcdef"}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Generic Bad Request":{"value":{"code":"1484000","message":"Bad request."}},"Upstream Bad Request":{"value":{"code":"1484001","message":"Bad Request in upstream."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"1484010","message":"Invalid JWT token."}},"No Upstream":{"value":{"code":"1484012","message":"No upstream selected."}},"Upstream Unauthorized":{"value":{"code":"1484014","message":"Unauthorized in upstream."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Missing Scopes":{"value":{"code":"1484030","message":"Required scopes are missing."}},"Account Forbidden":{"value":{"code":"1484031","message":"Account does not have access."}},"Upstream Forbidden":{"value":{"code":"1484032","message":"Forbidden in upstream."}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Not Found":{"value":{"code":"1484040","message":"Resource not found."}},"Upstream Not Found":{"value":{"code":"1484041","message":"Not Found in upstream."}}}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484050","message":"Method not allowed."}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484150","message":"Unsupported Media Type"}}}}}}},"/healthcare/patients-va":{"get":{"tags":["HLS Providers"],"summary":"Search by patients on VA returning a PatientStudio object","description":"Search by patients returning one PatientStudio object only. If the search result returns a number of patients different from one, a PatientStudio object is returned with its count property pointing to the number of results found.","operationId":"searchPatientsVA","security":[{"GA":["hls-patient:read"]}],"parameters":[{"name":"interaction_id","in":"query","required":true,"description":"Required interaction Id","schema":{"type":"string","example":"abc","minLength":1,"maxLength":2147483647}},{"name":"first_name","in":"query","required":false,"description":"Patient's first name","schema":{"type":"string","example":"John","minLength":1,"maxLength":2147483647}},{"name":"last_name","in":"query","required":false,"description":"Patient's last name","schema":{"type":"string","example":"Doe","minLength":1,"maxLength":2147483647}},{"name":"ssn","in":"query","required":false,"description":"Patient's Social Security Number","schema":{"type":"string","example":"123-45-2145","minLength":1,"maxLength":2147483647}},{"name":"lookup_information","in":"query","required":false,"description":"The information to be used to search for the patient. It must be present if the lookup_information_type is present.","schema":{"type":"string","example":"80452145","minLength":1,"maxLength":2147483647}},{"name":"lookup_information_type","in":"query","required":false,"description":"The information type to be used to search for the patient. It must be present if the lookup_information is present.","schema":{"type":"string","enum":["DOB","SS","PH","A","HAR","IN"],"example":"PH","minLength":1,"maxLength":2147483647}},{"name":"mrn","in":"query","required":false,"description":"Patient Medical Record Number","schema":{"type":"string","example":"4364675453","minLength":1,"maxLength":2147483647}},{"name":"birth_date","in":"query","required":false,"description":"Birth date","schema":{"type":"string","format":"date","example":"1985-08-05","minLength":1,"maxLength":2147483647}},{"name":"gender","in":"query","required":false,"description":"Patient Gender","schema":{"type":"string","enum":["MALE","FEMALE","OTHER","UNKNOWN"],"example":"MALE"}},{"name":"phone_number","in":"query","required":false,"description":"Patient phone number","schema":{"type":"string","example":"919998877","minLength":1,"maxLength":15}},{"name":"timezone","in":"query","required":false,"description":"Timezone from this interaction and must respect this format `US/Eastern`.","schema":{"type":"string","example":"US/Eastern","minLength":1,"maxLength":2147483647}},{"name":"zipcode","in":"query","required":false,"description":"The zipcode of the patient's home address","schema":{"type":"string","example":"92040"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string"}}}}},"id":{"type":"string"},"name":{"type":"string"},"ssn":{"type":"string"},"mrn":{"type":"string"},"birth_date":{"type":"string","format":"date"},"gender":{"type":"string","enum":["MALE","FEMALE","OTHER","UNKNOWN"]},"home_phone_number":{"type":"string"},"work_phone_number":{"type":"string"},"mobile_phone_number":{"type":"string"},"home_address_city":{"type":"string"},"home_address_state":{"type":"string"},"marital_status":{"type":"string"},"language":{"type":"string"},"active":{"type":"string"},"count":{"type":"integer"},"popup_url":{"type":"string"},"patient_status":{"type":"string"},"operation_outcome":{"type":"string"},"pcp_id":{"type":"string"},"pcp_name":{"type":"string"},"self_service_active":{"type":"string"},"postal_code":{"type":"string"},"rendering_provider_name":{"type":"string","description":"Patient's Rendering Provider name."},"rendering_provider_id":{"type":"string","description":"Patient's Rendering Provider ID."},"custom_fields":{"type":"object","description":"The custom fields associated with the provider, which is Athena."},"mychart_account_id":{"type":"string","description":"The unique identifier for the patient's MyChart account."}}},"example":{"_links":{"self":{"href":"https://api.talkdesk.com/healthcare/patients-va?interaction_id=123&phone_number=123-123-123&birth_date=1994-12-15T00:00:00-00:00&person=Allison+Mychart"}},"id":"123456qwerty","active":"true","birth_date":"1990-01-01","count":1,"gender":"MALE","home_address_city":"United States","home_address_state":"Coimbra","home_phone_number":"999-917-1234","language":"EN","marital_status":"SINGLE AND FREE","mobile_phone_number":"999-917-1234","mrn":"123456","name":"Figg Figg","ssn":"484-76-1235","work_phone_number":"999-917-1234","popup_url":"http://industries-auth.meza.talkdeskstg.com/forward","patient_status":"vipPatient","operation_outcome":"Additional data may be available using the Break-the-Glass protocol.","pcp_id":"E1000","pcp_name":"Physician Family Medicine, MD","self_service_active":"true","postal_code":"12345","rendering_provider_name":"renderingProvider 123","rendering_provider_id":"123","custom_fields":{"custom_field_1":"99999"},"my_chart_account_id":"MYCHARTALLISON"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Generic Bad Request":{"value":{"code":"1484000","message":"Bad request."}},"Upstream Bad Request":{"value":{"code":"1484001","message":"Bad Request in upstream."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"1484010","message":"Invalid JWT token."}},"No Upstream":{"value":{"code":"1484012","message":"No upstream selected."}},"Upstream Unauthorized":{"value":{"code":"1484014","message":"Unauthorized in upstream."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Missing Scopes":{"value":{"code":"1484030","message":"Required scopes are missing."}},"Account Forbidden":{"value":{"code":"1484031","message":"Account does not have access."}},"Upstream Forbidden":{"value":{"code":"1484032","message":"Forbidden in upstream."}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Not Found":{"value":{"code":"1484040","message":"Resource not found."}},"Upstream Not Found":{"value":{"code":"1484041","message":"Not Found in upstream."}}}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484050","message":"Method not allowed."}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484150","message":"Unsupported Media Type"}}}}}}},"/healthcare/prescriptions-va":{"get":{"tags":["HLS Providers"],"summary":"Get the prescriptions of a patient, adapted for the VA","description":"Get all prescriptions associated with a patient, returning a HalPaginatedResource.","operationId":"prescriptionsVA","security":[{"GA":["hls-prescription:read"]}],"parameters":[{"name":"patient_id","in":"query","required":true,"schema":{"type":"string","example":"ejptBFS0Cxxxxxxxxxx"}},{"name":"interaction_id","in":"query","description":"The ID of the interaction.","required":false,"example":"b4379742769e4bb4927644fa15126c64","schema":{"type":"string","minLength":1}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","example":1,"minimum":1,"maximum":2147483647,"default":1}},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","example":5,"minimum":1,"maximum":50,"default":5}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","required":["count","total","page","per_page","total_pages","_links","_embedded"],"properties":{"count":{"type":"integer","description":"The number of results in the current page"},"total":{"type":"integer","description":"The total of results"},"page":{"type":"integer","description":"The current page"},"per_page":{"type":"integer","description":"The number of results per page"},"total_pages":{"type":"integer","description":"The total number of result pages"},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string"}}}}},"_embedded":{"type":"object","description":"List of Prescriptions in current page","required":["prescriptions"],"properties":{"prescriptions":{"type":"array","items":{"type":"object","properties":{"id":{"description":"Prescription identifier.","type":"string"},"medication":{"description":"The medication name associated with the prescription.","type":"string"},"status":{"description":"The status of the prescription.","type":"string","enum":["UNDEFINED","ACTIVE","DISCONTINUED","ENDED","EXPIRED"]},"pharmacy_id":{"description":"The pharmacy id of the prescription.","type":"string"},"pharmacy_ncpdp_id":{"description":"The NCPDP ID of the pickup pharmacy.","type":"string"},"pharmacy_name":{"description":"The pharmacy name of the prescription.","type":"string"},"pharmacy_address":{"description":"The pharmacy address of the prescription.","type":"string"},"last_dispensed":{"description":"The last dispensed of the prescription.","type":"string","format":"date-time"},"end_date":{"description":"The end date of the prescription.","type":"string","format":"date-time"},"fills_remaining":{"description":"Number of (whole) fills remaining on the prescription.","type":"integer"},"is_fillable":{"description":"Indicates whether the prescription is currently able to be filled.","type":"boolean"},"has_fill_in_progress":{"description":"Indicates whether there is a fill in progress for this prescription.","type":"boolean"},"is_rar_able":{"description":"Indicates whether a Refill Authorization Request can be generated for the prescription.","type":"boolean"},"rar_status":{"description":"The status of the latest refill authorization request. This will be populated when the latest non-cancelled action on a prescription is a refill authorization request.","type":"string","enum":["PENDING","APPROVED","DENIED"]}}}}}}}},"example":{"count":3,"total":3,"page":1,"per_page":5,"total_pages":1,"_links":{"self":{"href":"https://api.talkdesk.com/healthcare/prescriptions-va?patient_id=1234"}},"_embedded":{"prescriptions":[{"id":"202561","medication":"omeprazole 40 MG DR capsule","status":"EXPIRED","pharmacy_id":"52","pharmacy_ncpdp_id":"0100622","pharmacy_name":"EMC Prescription Pharmacy South","pharmacy_address":"123 Ghost Street, Verona, Wisconsin, 53593, United States of America","end_date":"2016-06-23T00:00:00Z","fills_remaining":11,"is_fillable":false,"is_rar_able":true,"rar_status":"PENDING"},{"id":"202561","medication":"FLUoxetine 40 MG capsule","status":"EXPIRED","pharmacy_id":"52","pharmacy_ncpdp_id":"0100622","pharmacy_name":"EMC Prescription Pharmacy South","pharmacy_address":"123 Cookies Street, Verona, Wisconsin, 53593, United States of America","last_dispensed":"2013-10-05T00:00:00Z","end_date":"2015-07-24T00:00:00Z","fills_remaining":0,"is_fillable":false,"has_fill_in_progress":true,"is_rar_able":false,"rar_status":"APPROVED"},{"id":"202561","medication":"naproxen 375 MG tablet","status":"EXPIRED","pharmacy_id":"52","pharmacy_ncpdp_id":"0100622","pharmacy_name":"EMC Prescription Pharmacy South","pharmacy_address":"123 Pasta Street, Verona, Wisconsin, 53593, United States of America","end_date":"2015-07-15T00:00:00Z","fills_remaining":0,"is_fillable":false,"has_fill_in_progress":true,"is_rar_able":true}]}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Generic Bad Request":{"value":{"code":"1484000","message":"Bad request."}},"Upstream Bad Request":{"value":{"code":"1484001","message":"Bad Request in upstream."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"1484010","message":"Invalid JWT token."}},"No Upstream":{"value":{"code":"1484012","message":"No upstream selected."}},"Upstream Unauthorized":{"value":{"code":"1484014","message":"Unauthorized in upstream."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Missing Scopes":{"value":{"code":"1484030","message":"Required scopes are missing."}},"Account Forbidden":{"value":{"code":"1484031","message":"Account does not have access."}},"Upstream Forbidden":{"value":{"code":"1484032","message":"Forbidden in upstream."}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Not Found":{"value":{"code":"1484040","message":"Resource not found."}},"Upstream Not Found":{"value":{"code":"1484041","message":"Not Found in upstream."}}}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484050","message":"Method not allowed."}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484150","message":"Unsupported Media Type"}}}}}}},"/healthcare/prescriptions-refill-va":{"post":{"tags":["HLS Providers"],"summary":"Request a prescription refill, adapted for the VA","description":"Request a prescriptions associated with a patient, returning a HalPaginatedResource.","operationId":"prescriptionRefillVA","security":[{"GA":["hls-prescription:write"]}],"parameters":[{"name":"prescription_id","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":100,"example":"1ac98fe3e24b"}},{"name":"interaction_id","in":"query","description":"The ID of the interaction.","required":false,"example":"b4379742769e4bb4927644fa15126c64","schema":{"type":"string","minLength":1}},{"name":"fill_quantity","in":"query","required":false,"schema":{"type":"integer","example":2,"minimum":1,"maximum":100}},{"name":"pharmacy_ncpdp_id","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":100,"example":"47a4b876ff2"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","required":["prescription_result"],"properties":{"error_message":{"type":"string","description":"Error message describing the reason why the refill was not possible","example":"Database error"},"prescription_result":{"type":"object","description":"The prescription refill result","required":["updated"],"properties":{"id":{"type":"string","description":"Prescription ID"},"updated":{"type":"boolean","description":"Whether the prescription was updated with a refill or not"},"update_timestamp":{"type":"string","description":"Timestamp of the prescription update"},"error_message":{"type":"string","description":"Error message describing the reason why the refill was not possible","example":"Database error"}}}}},"example":{"prescription_result":{"id":"289347293849832","updated":true,"update_timestamp":"2022-08-20T10:00:00Z"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Generic Bad Request":{"value":{"code":"1484000","message":"Bad request."}},"Upstream Bad Request":{"value":{"code":"1484001","message":"Bad Request in upstream."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"1484010","message":"Invalid JWT token."}},"No Upstream":{"value":{"code":"1484012","message":"No upstream selected."}},"Upstream Unauthorized":{"value":{"code":"1484014","message":"Unauthorized in upstream."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Missing Scopes":{"value":{"code":"1484030","message":"Required scopes are missing."}},"Account Forbidden":{"value":{"code":"1484031","message":"Account does not have access."}},"Upstream Forbidden":{"value":{"code":"1484032","message":"Forbidden in upstream."}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Not Found":{"value":{"code":"1484040","message":"Resource not found."}},"Upstream Not Found":{"value":{"code":"1484041","message":"Not Found in upstream."}}}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484050","message":"Method not allowed."}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484150","message":"Unsupported Media Type"}}}}}}},"/healthcare/cancel-appointments-va":{"delete":{"tags":["HLS Providers"],"summary":"Cancel appointments on VA","description":"Cancel the appointment that is selected on the interaction using interactionId.","operationId":"cancelAppointmentVA","security":[{"GA":["hls-appointment:write"]}],"parameters":[{"name":"interaction_id","in":"query","required":true,"description":"Required interaction Id","schema":{"type":"string","example":"abc","minLength":1,"maxLength":2147483647}},{"name":"agent_id","in":"query","required":false,"description":"Talkdesk agent ID related to this interaction","schema":{"type":"string","example":"617bc5d698cec24b2e3c16eb","minLength":1,"maxLength":2147483647}},{"name":"reason","in":"query","required":false,"description":"Cancelled Appointment reason","schema":{"type":"string","example":"cancel appointment","minLength":1,"maxLength":2147483647}},{"name":"comment","in":"query","required":false,"schema":{"description":"Cancelled Appointment comment","type":"string","example":"comment","minLength":1,"maxLength":2147483647}},{"name":"appointment_id","in":"query","required":false,"schema":{"description":"Cancelled Appointment Id, if appointment id is provided, it cancels that appointment. Otherwise, the appointment is canceled based on the current interaction.","type":"string","example":"a-55614","minLength":1,"maxLength":2147483647}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"Cancelled Appointment identifier","type":"string"},"provider_id":{"description":"Cancelled Appointment provider identifier","type":"string"},"provider_name":{"description":"Cancelled Appointment provider name","type":"string"},"service_type_id":{"description":"Cancelled Appointment service type identifier","type":"string"},"location_id":{"description":"Cancelled Appointment location identifier","type":"string"}}},"example":{"id":"55614","provider_id":"E1000","provider_name":"Physician O. Cardiology, MD","service_type_id":"1004","location_id":"10501101"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Generic Bad Request":{"value":{"code":"1484000","message":"Bad request."}},"Upstream Bad Request":{"value":{"code":"1484001","message":"Bad Request in upstream."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"1484010","message":"Invalid JWT token."}},"No Upstream":{"value":{"code":"1484012","message":"No upstream selected."}},"Upstream Unauthorized":{"value":{"code":"1484014","message":"Unauthorized in upstream."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Missing Scopes":{"value":{"code":"1484030","message":"Required scopes are missing."}},"Account Forbidden":{"value":{"code":"1484031","message":"Account does not have access."}},"Upstream Forbidden":{"value":{"code":"1484032","message":"Forbidden in upstream."}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Not Found":{"value":{"code":"1484040","message":"Resource not found."}},"Upstream Not Found":{"value":{"code":"1484041","message":"Not Found in upstream."}}}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484050","message":"Method not allowed."}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484150","message":"Unsupported Media Type"}}}}}}},"/healthcare/schedule-appointments-va":{"post":{"tags":["HLS Providers"],"summary":"Schedule appointments on VA","description":"Schedule the appointment that is selected on the interaction using interactionId.","operationId":"scheduleAppointmentVA","security":[{"GA":["hls-appointment:write"]}],"parameters":[{"name":"interaction_id","in":"query","required":true,"description":"Required interaction Id","schema":{"type":"string","example":"abc","minLength":1,"maxLength":2147483647}},{"name":"notes_prefix","in":"query","description":"Prefix to add to appointment notes","schema":{"type":"string","example":"abc","minLength":1,"maxLength":2147483647}},{"name":"sub_location","in":"query","description":"The sub-location (department) for the available slot.","schema":{"type":"string","example":"Cardiology","minLength":1,"maxLength":2147483647}}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Generic Bad Request":{"value":{"code":"1484000","message":"Bad request."}},"Upstream Bad Request":{"value":{"code":"1484001","message":"Bad Request in upstream."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"1484010","message":"Invalid JWT token."}},"No Upstream":{"value":{"code":"1484012","message":"No upstream selected."}},"Upstream Unauthorized":{"value":{"code":"1484014","message":"Unauthorized in upstream."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Missing Scopes":{"value":{"code":"1484030","message":"Required scopes are missing."}},"Account Forbidden":{"value":{"code":"1484031","message":"Account does not have access."}},"Upstream Forbidden":{"value":{"code":"1484032","message":"Forbidden in upstream."}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Not Found":{"value":{"code":"1484040","message":"Resource not found."}},"Upstream Not Found":{"value":{"code":"1484041","message":"Not Found in upstream."}}}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484050","message":"Method not allowed."}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484150","message":"Unsupported Media Type"}}}}}}},"/healthcare/future-appointments-va":{"get":{"tags":["HLS Providers"],"summary":"Search future appointments on VA returning a FutureAppointmentsVA object","description":"Search patients future appointments using interactionId returning one FutureAppointmentsVA object only. If the search finds multiple appointments a FutureAppointmentsVA object is returned with its total property pointing to the number of results found and the closest appointment.","operationId":"futureAppointmentsVA","security":[{"GA":["hls-appointment:read"]}],"parameters":[{"name":"interaction_id","in":"query","required":true,"description":"Required interaction Id","schema":{"type":"string","example":"abc","minLength":1,"maxLength":2147483647}},{"name":"count","in":"query","description":"Number of appointments to fetch","schema":{"minimum":1,"maximum":50,"default":1,"type":"integer"},"example":10},{"name":"start_date","in":"query","description":"The date from which the available slots should be considered as a viable option according to the client’s schedule.","required":false,"example":"2022-01-17T11:00:00.000Z","schema":{"type":"string","format":"date-time","minLength":10,"maxLength":24}},{"name":"end_date","in":"query","description":"The date until which the available slots should be considered as a viable option according to the client’s schedule.","required":false,"example":"2022-01-22T11:00:00.000Z","schema":{"type":"string","format":"date-time","minLength":10,"maxLength":24}},{"name":"max_days","in":"query","required":false,"description":"Quantity of days to look up in the future to fetch the appointments","schema":{"type":"integer","example":1,"minimum":1,"maximum":2000,"default":30}},{"name":"timezone","in":"query","required":false,"description":"Timezone from this interaction and must respect this format `America/Chicago`.","schema":{"type":"string","example":"America/Chicago"}},{"name":"cancelable_only","in":"query","description":"Return only appointments able to be cancelled","schema":{"default":false,"type":"boolean"},"example":true},{"name":"status","in":"query","required":false,"description":"List of the desired appointment statuses, comma-separated (e.g. 'booked,noshow')","schema":{"type":"string","enum":["proposed","pending","booked","arrived","fulfilled","cancelled","noshow","entered-in-error","checked-in","waitlist"],"example":"booked","minLength":1,"maxLength":200}},{"name":"category","in":"query","required":false,"description":"Appointment category","schema":{"type":"string","enum":["APPOINTMENT","SURGERY"],"example":"APPOINTMENT","minLength":1,"maxLength":100}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string"}}}}},"remaining":{"description":"Number of other appointments found","type":"integer"},"id":{"type":"string"},"service_type":{"type":"string"},"date_time":{"type":"string"},"date":{"type":"string"},"time":{"type":"string"},"category":{"type":"string"},"timezone":{"type":"string"},"speciality":{"type":"string"},"provider":{"type":"string"},"address":{"type":"string"},"location":{"type":"string"},"patient_instructions":{"type":"string"},"service_type_id":{"description":"Appointment service type identifier","type":"string"},"location_id":{"description":"Appointment location identifier","type":"string"},"provider_id":{"description":"Appointment provider identifier","type":"string"},"has_service_type_id":{"description":"If service type is present","type":"string"},"cancellable":{"description":"If appointment can be cancelled","type":"string"},"comment":{"description":"The appointment comments","type":"string"},"appointment_dat_type_id":{"description":"the contact ID whose contact type is DAT","type":"string"},"sub_location":{"description":"Specific department, clinic, or area within the facility where the appointment occurs.","type":"string"},"sub_location_id":{"description":"System identifier for the sub-location within the facility, used to disambiguate departments/areas under the same location.","type":"string"}}},"example":{"remaining":4,"id":"54940.92","service_type":"New Patient Appointment","date_time":"2021-12-20T08:55:00Z","date":"2021-12-20","time":"08:55:00","category":"appointment","timezone":"America/Chicago","speciality":"Family Medicine","provider":"Physician O. Cardiology, MD","address":"123 My Way, Line 2, VERONA, WI, 53593","location":"PHREESIA DEPARTMENT","providerId":"1234","locationId":"1235","serviceTypeId":"123","hasServiceTypeId":"true","patient_instructions":"Bring list of current medications and any insurance information and a copayment if required by your insurance company.","cancellable":"true","comment":"Test comment","appointment_dat_type_id":"12345","sub_location":"Pediatrics","sub_location_id":"67890","_links":{"self":{"href":"https://api.talkdesk.com/healthcare/future-appointments-va?interaction_id=123&count=5&max_days=30"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Generic Bad Request":{"value":{"code":"1484000","message":"Bad request."}},"Upstream Bad Request":{"value":{"code":"1484001","message":"Bad Request in upstream."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"1484010","message":"Invalid JWT token."}},"No Upstream":{"value":{"code":"1484012","message":"No upstream selected."}},"Upstream Unauthorized":{"value":{"code":"1484014","message":"Unauthorized in upstream."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Missing Scopes":{"value":{"code":"1484030","message":"Required scopes are missing."}},"Account Forbidden":{"value":{"code":"1484031","message":"Account does not have access."}},"Upstream Forbidden":{"value":{"code":"1484032","message":"Forbidden in upstream."}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Not Found":{"value":{"code":"1484040","message":"Resource not found."}},"Upstream Not Found":{"value":{"code":"1484041","message":"Not Found in upstream."}}}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484050","message":"Method not allowed."}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484150","message":"Unsupported Media Type"}}}}}}},"/healthcare/providers/reset-va":{"get":{"tags":["HLS Providers"],"summary":"Resets VA Arrays and returns patient studio information for specific interaction","description":"This endpoint resets the all VA arrays for when VA needs to switch context, and grabs patient studio information from REDIS to prevent extra unnecessary patient lookup","operationId":"resetHealthcareProvidersVa","security":[{"GA":["hls-patient:read"]}],"parameters":[{"name":"interaction_id","in":"query","required":true,"description":"Required interaction id","schema":{"type":"string","example":"abc","minLength":1,"maxLength":2147483647}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string"}}}}},"id":{"type":"string"},"name":{"type":"string"},"ssn":{"type":"string"},"mrn":{"type":"string"},"birth_date":{"type":"string","format":"date"},"gender":{"type":"string","enum":["MALE","FEMALE","OTHER","UNKNOWN"]},"home_phone_number":{"type":"string"},"work_phone_number":{"type":"string"},"mobile_phone_number":{"type":"string"},"home_address_city":{"type":"string"},"home_address_state":{"type":"string"},"marital_status":{"type":"string"},"language":{"type":"string"},"active":{"type":"string"},"count":{"type":"integer"},"popup_url":{"type":"string"},"patient_status":{"type":"string"},"operation_outcome":{"type":"string"},"pcp_id":{"type":"string"},"pcp_name":{"type":"string"},"self_service_active":{"type":"string"},"postal_code":{"type":"string"},"rendering_provider_name":{"type":"string","description":"Patient's Rendering Provider name."},"rendering_provider_id":{"type":"string","description":"Patient's Rendering Provider ID."},"custom_fields":{"type":"object","description":"The custom fields associated with the provider, which is Athena."},"mychart_account_id":{"type":"string","description":"The unique identifier for the patient's MyChart account."}}},"example":{"_links":{"self":{"href":"https://api.talkdesk.com/healthcare/patients-studio?interaction_id=123&phone_number=123-123-123"}},"id":"123456qwerty","active":"true","birth_date":"1990-01-01","count":1,"gender":"MALE","home_address_city":"United States","home_address_state":"Coimbra","home_phone_number":"999-917-1234","language":"EN","marital_status":"SINGLE AND FREE","mobile_phone_number":"999-917-1234","mrn":"123456","name":"Figg Figg","ssn":"484-76-1235","work_phone_number":"999-917-1234","popup_url":"http://industries-auth.meza.talkdeskstg.com/forward","patient_status":"vipPatient","operation_outcome":"Additional data may be available using the Break-the-Glass protocol.","pcp_id":"E1000","pcp_name":"Physician Family Medicine, MD","self_service_active":"false","postal_code":"12345","rendering_provider_name":"renderingProvider 123","rendering_provider_id":"123","custom_fields":{"custom_field_1":"99999"},"mychart_account_id":"MYCHARTALLISON"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Generic Bad Request":{"value":{"code":"1484000","message":"Bad request."}},"Upstream Bad Request":{"value":{"code":"1484001","message":"Bad Request in upstream."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"1484010","message":"Invalid JWT token."}},"No Upstream":{"value":{"code":"1484012","message":"No upstream selected."}},"Upstream Unauthorized":{"value":{"code":"1484014","message":"Unauthorized in upstream."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Missing Scopes":{"value":{"code":"1484030","message":"Required scopes are missing."}},"Account Forbidden":{"value":{"code":"1484031","message":"Account does not have access."}},"Upstream Forbidden":{"value":{"code":"1484032","message":"Forbidden in upstream."}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Not Found":{"value":{"code":"1484040","message":"Resource not found."}},"Upstream Not Found":{"value":{"code":"1484041","message":"Not Found in upstream."}}}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484050","message":"Method not allowed."}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484150","message":"Unsupported Media Type"}}}}}}},"/healthcare/encounters":{"get":{"tags":["HLS Providers"],"summary":"Get encounters","description":"Get a list of encounters connected via an interactionId.","operationId":"getEncounters","security":[{"GA":["hls-encounter:read"]}],"parameters":[{"name":"interaction_id","in":"query","required":true,"description":"Interaction ID","schema":{"type":"string","example":"abc","minLength":1,"maxLength":2147483647}},{"name":"start_date","in":"query","description":"The initial date from which the encounter should retrieved","required":false,"example":"2022-01-17T11:00:00.000Z","schema":{"type":"string","format":"date-time","minLength":10,"maxLength":24}},{"name":"end_date","in":"query","description":"The final date up until which the encounter should retrieved","required":false,"example":"2022-01-22T11:00:00.000Z","schema":{"type":"string","format":"date-time","minLength":10,"maxLength":24}},{"name":"max_days","in":"query","required":false,"description":"Quantity of days to look back to fetch encounters","schema":{"type":"integer","example":1,"minimum":1,"maximum":2000,"default":30}},{"name":"timezone","in":"query","required":false,"description":"Timezone from this interaction and must respect this format `America/Chicago`.","schema":{"type":"string","example":"America/Chicago"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","example":1,"minimum":1,"maximum":2147483647,"default":1}},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","example":5,"minimum":1,"maximum":50,"default":5}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","required":["count","total","page","per_page","total_pages","_links","_embedded"],"properties":{"count":{"type":"integer","description":"The number of results in the current page"},"total":{"type":"integer","description":"The total of results"},"page":{"type":"integer","description":"The current page"},"per_page":{"type":"integer","description":"The number of results per page"},"total_pages":{"type":"integer","description":"The total number of result pages"},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string"}}}}},"_embedded":{"type":"object","description":"List of encounters in current page","required":["encounters"],"properties":{"encounters":{"type":"array","items":{"type":"object","required":["id"],"properties":{"id":{"description":"Encounter identifier","type":"string"},"type":{"description":"The type of the encounter","type":"string"},"date_time":{"description":"Date of the encounter","type":"string","format":"date-time"},"timezone":{"description":"Timezone of the encounter's date","type":"string"},"status":{"description":"The status of the encounter. For Athena, the status is not in the allowed enum values","type":"string","enum":["PLANNED","ARRIVED","TRIAGED","IN_PROGRESS","ONLEAVE","FINISHED","CANCELLED","ENTERED_IN_ERROR","UNKNOWN"]},"location_id":{"description":"The location identifier of the encounter","type":"string"},"location":{"description":"The location name of the encounter","type":"string"},"provider_id":{"description":"The provider identifier of the encounter","type":"string"},"provider":{"description":"The provider name of the encounter","type":"string"},"reason":{"description":"The reason of the encounter","type":"string"}}}}}}}},"example":{"count":1,"total":1,"page":1,"per_page":5,"total_pages":1,"_links":{"self":{"href":"https://api.talkdesk.com/healthcare/encounters?interaction_id=a1b980cc981f"}},"_embedded":{"encounters":[{"id":"a1b980cc981f","type":"Wait List","date_time":"2023-03-21T00:00:00Z","timezone":"Europe/Lisbon","status":"UNKNOWN","location_id":"6564","location":"EMC Family Medicine","provider_id":"9971","provider":"Family Medicine Physician, MD","reason":"Family Medicine"}]}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Generic Bad Request":{"value":{"code":"1484000","message":"Bad request."}},"Upstream Bad Request":{"value":{"code":"1484001","message":"Bad Request in upstream."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"1484010","message":"Invalid JWT token."}},"No Upstream":{"value":{"code":"1484012","message":"No upstream selected."}},"Upstream Unauthorized":{"value":{"code":"1484014","message":"Unauthorized in upstream."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Missing Scopes":{"value":{"code":"1484030","message":"Required scopes are missing."}},"Account Forbidden":{"value":{"code":"1484031","message":"Account does not have access."}},"Upstream Forbidden":{"value":{"code":"1484032","message":"Forbidden in upstream."}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Not Found":{"value":{"code":"1484040","message":"Resource not found."}},"Upstream Not Found":{"value":{"code":"1484041","message":"Not Found in upstream."}}}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484050","message":"Method not allowed."}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484150","message":"Unsupported Media Type"}}}}}}},"/healthcare/medication-orders":{"get":{"tags":["HLS Providers"],"summary":"Get the medication orders of a patient","description":"Get the medication orders of a patient","operationId":"getPatientMedicationOrders","security":[{"GA":["hls-medication-order:read"]}],"parameters":[{"name":"interaction_id","in":"query","required":true,"schema":{"type":"string","example":"ejptBFS0Cxxxxxxxxxx","minLength":1,"maxLength":2147483647}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","example":1,"minimum":1,"maximum":2147483647,"default":1}},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","example":5,"minimum":1,"maximum":50,"default":5}},{"name":"status","in":"query","required":false,"schema":{"type":"string","example":"active","minLength":1,"maxLength":2147483647}}],"responses":{"200":{"description":"OK","content":{"application/fhir+json":{"schema":{"type":"object","description":"A paginated list response containing Medication Orders and pagination metadata.","required":["count","total","page","per_page","total_pages","_embedded"],"properties":{"count":{"type":"integer","description":"Number of results returned in the current page."},"total":{"type":"integer","description":"Total number of results available across all pages."},"page":{"type":"integer","description":"Current page number (1-based)."},"per_page":{"type":"integer","description":"Number of results requested per page."},"total_pages":{"type":"integer","description":"Total number of available pages."},"_links":{"type":"object","description":"Pagination and resource navigation links.","properties":{"self":{"type":"object","description":"Link to the current resource.","properties":{"href":{"type":"string","description":"Absolute URL to the current page or resource."}}}}},"_embedded":{"type":"object","description":"List of Medication Orders in current page","required":["medication_orders"],"properties":{"medication_orders":{"type":"array","description":"List of Medication Orders in the current page.","items":{"type":"object","description":"A prescription or authorization to supply and administer a medication to a patient.","required":["id","name","category"],"properties":{"id":{"description":"Unique identifier of the Medication Order.","type":"string"},"status":{"description":"Current status of the Medication Order (e.g., active, completed, cancelled).","type":"string"},"category":{"description":"Workflow category or type of the Medication Order (e.g., Inpatient, Outpatient).","type":"string"},"name":{"description":"Human-readable medication name as provided by the source system.","type":"string"},"authored_on":{"type":"string","format":"date-time","description":"Date/time when the Medication Order was authored."},"requester":{"description":"Name of the clinician or system who requested the Medication Order.","type":"string"},"dose":{"description":"Dosage instructions for the medication (e.g., 30 mg, 1 tablet).","type":"string"},"initial_fill_quantity":{"type":"string","description":"The amount or quantity to provide as part of the first dispense.","example":"30 ml"},"initial_fill_duration":{"type":"string","description":"The length of time that the first dispense is expected to last.","example":"10 days"},"dispense_interval":{"type":"string","description":"The minimum period of time that must occur between dispenses of the medication.","example":"30 days"},"validity_period":{"type":"object","description":"A time period defined by a start and end date-time.","required":["start"],"properties":{"start":{"type":"string","format":"date-time","description":"The start of the period."},"end":{"type":"string","format":"date-time","description":"The end of the period."}}},"number_of_repeats_allowed":{"description":"Number of authorized refills (repeats) beyond the initial fill.","type":"integer"},"quantity":{"type":"string","description":"The amount that is to be dispensed for one fill.","example":"30 ml"},"expected_supply_duration":{"type":"string","description":"Number of days supply per dispenseAs the VA, I want to have more detailed information about the medication request, so when a patient asks for a refill I know what I should do .","example":"30 days"},"substitution_allowed":{"description":"Whether a substitution is allowed.","type":"boolean","default":false},"substitution_reason":{"description":"The reason for substitution, if applicable.","type":"string"},"dispenser":{"type":"object","description":"Information about the dispenser (e.g., pharmacy).","required":["id"],"properties":{"id":{"type":"string","description":"Dispenser identifier."},"name":{"type":"string","description":"Dispenser name."}}},"dispenser_instruction":{"description":"Additional free-text instructions for the dispenser.","type":"string"},"destination":{"description":"Destination address/location where the medication should be sent or picked up.","type":"string"}}}}}}}},"example":{"count":2,"total":2,"page":1,"per_page":5,"total_pages":1,"_links":{"self":{"href":"https://api.talkdesk.com/healthcare/patients/1234/medication-orders"}},"_embedded":{"medication_orders":[{"id":"euxsRZosRENGRiSB1QY5sfg3","status":"active","category":"Outpatient","name":"PSEUDOEPHEDRINE HCL 30 MG PO TABS","authored_on":"2022-01-11T14:45:00Z","requester":"Physician Family Medicine, MD","dose":"30 mg","number_of_repeats_allowed":2,"substitution_allowed":false,"quantity":"30 tablets","validity_period":{"start":"2022-01-11T00:00:00Z","end":"2022-02-11T00:00:00Z"}},{"id":"eY0Avl7TVGnvJSEzD8rV8ow3","status":"active","category":"Outpatient","name":"adalimumab (HUMIRA) 40 mg/0.8 mL injection","authored_on":"2019-12-30T14:26:01Z","requester":"Md Builder Family Medicine, MD","dose":"40 mg","dispenser":{"id":"pharmacy-123","name":"Main Street Pharmacy"},"dispenser_instruction":"Keep refrigerated.","destination":"123 Main St, Springfield, USA"}]}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Generic Bad Request":{"value":{"code":"1484000","message":"Bad request."}},"Upstream Bad Request":{"value":{"code":"1484001","message":"Bad Request in upstream."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"1484010","message":"Invalid JWT token."}},"No Upstream":{"value":{"code":"1484012","message":"No upstream selected."}},"Upstream Unauthorized":{"value":{"code":"1484014","message":"Unauthorized in upstream."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Missing Scopes":{"value":{"code":"1484030","message":"Required scopes are missing."}},"Account Forbidden":{"value":{"code":"1484031","message":"Account does not have access."}},"Upstream Forbidden":{"value":{"code":"1484032","message":"Forbidden in upstream."}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Not Found":{"value":{"code":"1484040","message":"Resource not found."}},"Upstream Not Found":{"value":{"code":"1484041","message":"Not Found in upstream."}}}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484050","message":"Method not allowed."}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484150","message":"Unsupported Media Type"}}}}}}},"/healthcare/appointments/{appointment_id}/confirmation":{"post":{"tags":["HLS Providers"],"summary":"Appointment Confirmation","description":"Triggers a confirmation process, signaling to the EHR that the patient will attend","operationId":"confirmAppointment","security":[{"GA":["hls-appointment:write"]}],"parameters":[{"name":"interaction_id","in":"query","required":true,"description":"Required interaction Id","schema":{"type":"string","example":"abc","minLength":1,"maxLength":2147483647}},{"name":"appointment_id","in":"path","required":true,"description":"Id of the appointment to be confirmed","schema":{"type":"string","example":"appointment-1","minLength":1,"maxLength":2147483647}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Generic Bad Request":{"value":{"code":"1484000","message":"Bad request."}},"Upstream Bad Request":{"value":{"code":"1484001","message":"Bad Request in upstream."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"1484010","message":"Invalid JWT token."}},"No Upstream":{"value":{"code":"1484012","message":"No upstream selected."}},"Upstream Unauthorized":{"value":{"code":"1484014","message":"Unauthorized in upstream."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Missing Scopes":{"value":{"code":"1484030","message":"Required scopes are missing."}},"Account Forbidden":{"value":{"code":"1484031","message":"Account does not have access."}},"Upstream Forbidden":{"value":{"code":"1484032","message":"Forbidden in upstream."}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Not Found":{"value":{"code":"1484040","message":"Resource not found."}},"Upstream Not Found":{"value":{"code":"1484041","message":"Not Found in upstream."}}}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484050","message":"Method not allowed."}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484150","message":"Unsupported Media Type"}}}}}}},"/healthcare/appointments/{appointment_id}/rescheduling":{"post":{"tags":["HLS Providers"],"summary":"Reschedule an appointment","description":"Reschedule an existing appointment using its unique appointment ID.","operationId":"rescheduleAppointment","security":[{"GA":["hls-appointment:write"]}],"parameters":[{"name":"appointment_id","in":"path","required":true,"description":"The unique identifier of the original appointment to reschedule","schema":{"type":"string","example":"12345","minLength":1,"maxLength":2147483647}},{"name":"interaction_id","in":"query","required":true,"description":"Required interaction Id","schema":{"type":"string","example":"a1b980cc981f","minLength":1,"maxLength":2147483647}}],"requestBody":{"description":"The details for the appointment rescheduling","required":true,"content":{"application/json":{"schema":{"type":"object","required":["location_id","provider_id","service_type_id","date_time","duration","time_zone_id","comments"],"properties":{"location_id":{"type":"string","description":"The unique identifier of the service location/department for the rescheduled appointment","example":"10501101","maxLength":50},"provider_id":{"type":"string","description":"The unique identifier of the provider for the rescheduled appointment","example":"E1000","maxLength":50},"service_type_id":{"type":"string","description":"The unique identifier of the specialization/area of expertise for the rescheduled appointment","example":"123","maxLength":50},"date_time":{"type":"string","format":"date-time","description":"The time at which the rescheduled appointment starts","example":"2022-12-21T21:15:00Z"},"duration":{"type":"integer","description":"The duration of the appointment in minutes","example":60,"minimum":1,"maximum":1440},"time_zone_id":{"type":"string","description":"The time zone of the rescheduled appointment as an IANA time zone identifier (e.g., \"America/Chicago\")","example":"America/Chicago","maxLength":100},"comments":{"type":"array","description":"List of comments associated with the appointment","items":{"type":"string","maxLength":500},"example":["Patient requested earlier time"]},"is_review_only":{"type":"boolean","description":"Flag indicating if this is only for review purposes","example":false},"reschedule_comments":{"type":"string","description":"Comments specifically related to the rescheduling action","example":"Patient requested to reschedule due to work conflict","maxLength":1000},"reschedule_reason":{"type":"string","description":"The reason code for rescheduling the appointment","example":"PATIENT_REQUEST","maxLength":100},"sub_location":{"type":"string","description":"The sub-location (department) for the rescheduled appointment","example":"Cardiology","maxLength":100}}},"example":{"location_id":"10501101","provider_id":"E1000","service_type_id":"123","date_time":"2022-12-21T21:15:00Z","duration":60,"time_zone_id":"America/Chicago","comments":["Patient requested earlier time"],"is_review_only":false,"reschedule_comments":"Patient requested to reschedule due to work conflict","reschedule_reason":"PATIENT_REQUEST","sub_location":"Cardiology"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The rescheduled appointment identifier","example":"67890","maxLength":50},"can_reschedule":{"type":"boolean","description":"Flag indicating if the appointment can be rescheduled again","example":true},"date_time":{"type":"string","description":"The ISO 8601 formatted date and time of the rescheduled appointment","example":"2022-12-21T21:15:00Z","maxLength":30},"time_zone_id":{"type":"string","description":"The time zone of the rescheduled appointment as an IANA time zone identifier (e.g., \"America/Chicago\")","example":"America/Chicago","maxLength":100},"address":{"type":"string","description":"The physical address of the appointment location","example":"123 Medical Plaza, Suite 456, Chicago, IL 60601","maxLength":500},"specialty":{"type":"string","description":"The medical specialty related to the appointment","example":"Cardiology","maxLength":100},"patient_id":{"type":"string","description":"The unique identifier of the patient","example":"P987654","maxLength":50},"patient_name":{"type":"string","description":"The full name of the patient","example":"John Doe","maxLength":255},"patient_instructions":{"type":"string","description":"Special instructions for the patient regarding the appointment","example":"Please arrive 15 minutes early and bring your insurance card","maxLength":1000},"location":{"type":"string","description":"The name of the appointment location","example":"Downtown Medical Center","maxLength":255},"location_id":{"type":"string","description":"The unique identifier of the appointment location","example":"10501101","maxLength":50},"provider":{"type":"string","description":"The name of the healthcare provider","example":"Dr. Jane Smith","maxLength":255},"provider_id":{"type":"string","description":"The unique identifier of the healthcare provider","example":"E1000","maxLength":50},"duration_in_minutes":{"type":"integer","description":"The duration of the appointment in minutes","example":60,"minimum":1,"maximum":1440},"service_type":{"type":"string","description":"The name of the service type","example":"Follow-up Consultation","maxLength":255},"service_type_id":{"type":"string","description":"The unique identifier of the service type","example":"123","maxLength":50},"warnings":{"type":"array","description":"List of warnings or alerts associated with the appointment rescheduling","items":{"type":"string","maxLength":500},"example":[]}}},"example":{"id":"67890","can_reschedule":true,"date_time":"2022-12-21T21:15:00Z","time_zone_id":"America/Chicago","address":"123 Medical Plaza, Suite 456, Chicago, IL 60601","specialty":"Cardiology","patient_id":"P987654","patient_name":"John Doe","patient_instructions":"Please arrive 15 minutes early and bring your insurance card","location":"Downtown Medical Center","location_id":"10501101","provider":"Dr. Jane Smith","provider_id":"E1000","duration_in_minutes":60,"service_type":"Follow-up Consultation","service_type_id":"123","warnings":[]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Generic Bad Request":{"value":{"code":"1484000","message":"Bad request."}},"Upstream Bad Request":{"value":{"code":"1484001","message":"Bad Request in upstream."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"1484010","message":"Invalid JWT token."}},"No Upstream":{"value":{"code":"1484012","message":"No upstream selected."}},"Upstream Unauthorized":{"value":{"code":"1484014","message":"Unauthorized in upstream."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Missing Scopes":{"value":{"code":"1484030","message":"Required scopes are missing."}},"Account Forbidden":{"value":{"code":"1484031","message":"Account does not have access."}},"Upstream Forbidden":{"value":{"code":"1484032","message":"Forbidden in upstream."}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Not Found":{"value":{"code":"1484040","message":"Resource not found."}},"Upstream Not Found":{"value":{"code":"1484041","message":"Not Found in upstream."}}}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484050","message":"Method not allowed."}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484150","message":"Unsupported Media Type"}}}}}}},"/healthcare/appointment-confirmation-va":{"post":{"tags":["HLS Providers"],"summary":"Appointment Confirmation","description":"Triggers a confirmation process, signaling to the EHR that the patient will attend","operationId":"confirmAppointmentVa","security":[{"GA":["hls-appointment:write"]}],"parameters":[{"name":"interaction_id","in":"query","required":true,"description":"Required interaction Id","schema":{"type":"string","example":"abc","minLength":1,"maxLength":2147483647}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Generic Bad Request":{"value":{"code":"1484000","message":"Bad request."}},"Upstream Bad Request":{"value":{"code":"1484001","message":"Bad Request in upstream."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"1484010","message":"Invalid JWT token."}},"No Upstream":{"value":{"code":"1484012","message":"No upstream selected."}},"Upstream Unauthorized":{"value":{"code":"1484014","message":"Unauthorized in upstream."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Missing Scopes":{"value":{"code":"1484030","message":"Required scopes are missing."}},"Account Forbidden":{"value":{"code":"1484031","message":"Account does not have access."}},"Upstream Forbidden":{"value":{"code":"1484032","message":"Forbidden in upstream."}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Not Found":{"value":{"code":"1484040","message":"Resource not found."}},"Upstream Not Found":{"value":{"code":"1484041","message":"Not Found in upstream."}}}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484050","message":"Method not allowed."}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484150","message":"Unsupported Media Type"}}}}}}},"/healthcare/service-requests":{"get":{"tags":["HLS Providers"],"summary":"Get service requests","description":"Get a list of service requests connected via an interactionId.","operationId":"getServiceRequests","security":[{"GA":["hls-service-request:read"]}],"parameters":[{"name":"interaction_id","in":"query","required":true,"description":"Interaction ID","schema":{"type":"string","example":"abc","minLength":1,"maxLength":2147483647}},{"name":"status","in":"query","required":false,"description":"Status","schema":{"type":"string","example":"status","minLength":1,"maxLength":2147483647}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","example":1,"minimum":1,"maximum":2147483647,"default":1}},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","example":5,"minimum":1,"maximum":50,"default":5}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","required":["count","total","page","per_page","total_pages","_embedded"],"properties":{"count":{"type":"integer","description":"The number of results in the current page"},"total":{"type":"integer","description":"The total of results"},"page":{"type":"integer","description":"The current page"},"per_page":{"type":"integer","description":"The number of results per page"},"total_pages":{"type":"integer","description":"The total number of result pages"},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string","format":"uri","minLength":1}}}}},"_embedded":{"type":"object","description":"List of Service Request in current page","required":["service_requests"],"properties":{"service_requests":{"type":"array","items":{"type":"object","minLength":0,"properties":{"id":{"description":"Service request identifier","type":"string"},"status":{"description":"The status of the service request","type":"string"},"intent":{"description":"The intent of the service request","type":"string"},"category":{"description":"The category of the service request","type":"string"},"type":{"description":"The type of the service request.","type":"string"},"do_not_perform":{"description":"Whether the service request should be performed or not.","type":"boolean"},"based_on":{"description":"List of the items that gave origin to this service request (Plan/proposal/order).","type":"array","items":{"type":"object","minLength":0,"required":["id"],"properties":{"name":{"description":"name of the object to be used","type":"string"},"id":{"description":"id of the object to be used","type":"string"}}}},"quantity":{"description":"The quantity of the service request.","type":"string"},"authored_on":{"description":"The date in which the service request was created.","type":"string","format":"date-time"},"start":{"description":"The start date for the service request.","type":"string","format":"date-time"},"end":{"description":"The end date for the service request.","type":"string","format":"date-time"},"frequency":{"description":"The frequency of the service request.","type":"integer"},"period":{"description":"The period of the service request.","type":"string"},"priority":{"description":"The priority of the service request.","type":"string"},"requester":{"description":"The requester of the service request.","type":"object","required":["id"],"properties":{"name":{"description":"name of the object to be used","type":"string"},"id":{"description":"id of the object to be used","type":"string"}}},"performer":{"description":"The list of performers of the service request.","type":"array","items":{"type":"object","minLength":0,"required":["id"],"properties":{"name":{"description":"name of the object to be used","type":"string"},"id":{"description":"id of the object to be used","type":"string"}}}},"location":{"description":"The location of the service request.","type":"object","required":["id"],"properties":{"name":{"description":"name of the object to be used","type":"string"},"id":{"description":"id of the object to be used","type":"string"}}},"reason":{"description":"The list of reasons for the service request.","type":"array","items":{"type":"string","minLength":0}},"notes":{"description":"The list of notes of the service request.","type":"array","items":{"type":"string","minLength":0}},"insurance":{"description":"The list of insurance for the service request.","type":"array","items":{"type":"object","minLength":0,"required":["id"],"properties":{"name":{"description":"name of the object to be used","type":"string"},"id":{"description":"id of the object to be used","type":"string"}}}},"patient_instructions":{"description":"The instructions for the patient of the service request.","type":"string"}}}}}}}},"example":{"count":2,"total":2,"page":1,"per_page":5,"total_pages":1,"_links":{"self":{"href":"https://api.talkdesk.com/healthcare/patients/1234/service-requests"}},"_embedded":{"service_requests":[{"id":"evBUQXlFhAGdqaLWxwjEa1crqqiUOyE8ISZh1QObzXII3","status":"ACTIVE","intent":"filler_order","category":"Procedures","type":"MyChart BP Flowsheet","quantity":"1","authored_on":"2021-06-11T20:37:42Z","start":"2021-06-11T05:00:00Z","requester":{"name":"Pediatric Provider Dental, DMD","id":"Practitioner/eFW2qUFaPiai78h5-Xt6eYQib6ulilHDesUbt3h4JsUw3"},"reason":["Essential hypertension"]}]}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Generic Bad Request":{"value":{"code":"1484000","message":"Bad request."}},"Upstream Bad Request":{"value":{"code":"1484001","message":"Bad Request in upstream."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"1484010","message":"Invalid JWT token."}},"No Upstream":{"value":{"code":"1484012","message":"No upstream selected."}},"Upstream Unauthorized":{"value":{"code":"1484014","message":"Unauthorized in upstream."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Missing Scopes":{"value":{"code":"1484030","message":"Required scopes are missing."}},"Account Forbidden":{"value":{"code":"1484031","message":"Account does not have access."}},"Upstream Forbidden":{"value":{"code":"1484032","message":"Forbidden in upstream."}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Not Found":{"value":{"code":"1484040","message":"Resource not found."}},"Upstream Not Found":{"value":{"code":"1484041","message":"Not Found in upstream."}}}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484050","message":"Method not allowed."}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484150","message":"Unsupported Media Type"}}}}}}},"/healthcare/procedures":{"get":{"tags":["HLS Providers"],"summary":"Get the procedures of a patient, as public endpoint for VA usage","description":"Get all procedures associated with a patient, returning a HalPaginatedResource.","operationId":"patientProceduresVA","security":[{"GA":["hls-procedure:read"]}],"parameters":[{"name":"convert_ids","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"category","in":"query","required":false,"schema":{"type":"string","example":"28394734","minLength":1,"maxLength":1000}},{"name":"start_date","in":"query","required":false,"description":"Start date","schema":{"type":"string","format":"date","example":"2013-11-05","minLength":1,"maxLength":50}},{"name":"end_date","in":"query","required":false,"description":"End date","schema":{"type":"string","format":"date","example":"2013-11-08","minLength":1,"maxLength":50}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","example":1,"minimum":1,"maximum":2147483647,"default":1}},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","example":5,"minimum":1,"maximum":50,"default":5}}],"responses":{"200":{"description":"OK","content":{"application/hal+json":{"schema":{"type":"object","required":["count","total","page","per_page","total_pages","_links","_embedded"],"properties":{"count":{"type":"integer","description":"The number of results in the current page"},"total":{"type":"integer","description":"The total of results"},"page":{"type":"integer","description":"The current page"},"per_page":{"type":"integer","description":"The number of results per page"},"total_pages":{"type":"integer","description":"The total number of result pages"},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string","format":"uri","minLength":1}}}}},"_embedded":{"type":"object","description":"List of Procedures in current page","required":["procedures"],"properties":{"procedures":{"type":"array","items":{"type":"object","required":["id"],"properties":{"id":{"description":"Procedure identifier.","type":"string"},"name":{"description":"Procedure name.","type":"string"},"status":{"description":"Status of the procedure.","type":"string","enum":["PREPARATION","IN_PROGRESS","NOT_DONE","ON_HOLD","STOPPED","COMPLETED","ENTERED_IN_ERROR","UNKNOWN"]},"category":{"description":"Category of the procedure (tipically a numeric identifier).","type":"string"},"performed_start_date_time":{"description":"Date/time when the procedure started.","type":"string","format":"date-time"},"performed_end_date_time":{"description":"Date/time when the procedure finished.","type":"string","format":"date-time"},"outcome":{"description":"The outcome of the procedure.","type":"string"},"subject":{"description":"The patient to whom the procedure was done to.","type":"object","required":["id"],"properties":{"name":{"description":"name of the object to be used","type":"string"},"id":{"description":"id of the object to be used","type":"string"}}},"performers":{"description":"List of performers that had a role in the procedure","type":"array","items":{"type":"object","required":["id"],"properties":{"name":{"description":"name of the object to be used","type":"string"},"id":{"description":"id of the object to be used","type":"string"}}}},"encounter":{"description":"The encounter associated with this procedure.","type":"object","required":["id"],"properties":{"name":{"description":"name of the object to be used","type":"string"},"id":{"description":"id of the object to be used","type":"string"}}},"location":{"description":"The location where the procedure happened.","type":"object","required":["id"],"properties":{"name":{"description":"name of the object to be used","type":"string"},"id":{"description":"id of the object to be used","type":"string"}}},"body_sites":{"description":"List of sites in the patient's body that were targets of the procedure.","type":"array","items":{"type":"string"}},"reports":{"description":"List of reports, associated with the procedure.","type":"array","items":{"type":"object","required":["id"],"properties":{"name":{"description":"name of the object to be used","type":"string"},"id":{"description":"id of the object to be used","type":"string"}}}},"follow_ups":{"description":"Follow-up actions to be taken after the procedure.","type":"array","items":{"type":"string"}},"focal_devices":{"description":"List of devices used during the procedure.","type":"array","items":{"type":"string"}},"used_references":{"description":"List of references to the elements that were used during the procedure.","type":"array","items":{"type":"object","required":["id"],"properties":{"name":{"description":"name of the object to be used","type":"string"},"id":{"description":"id of the object to be used","type":"string"}}}}}}}}}}},"example":{"count":1,"total":1,"page":1,"per_page":5,"total_pages":1,"_links":{"self":{"href":"https://api.talkdesk.com/healthcare/procedures"}},"_embedded":{"procedures":[{"id":"202561","name":"Total hip replacement","status":"COMPLETED","category":"387713003","performed_start_date_time":"2023-04-10T13:45:00Z","performed_end_date_time":"2023-04-10T16:30:00Z","outcome":"success","subject":{"name":"George Lucas","id":"Patient/203984"},"performers":[{"name":"Dr. Seuss","id":"Practitioner/32904"}],"encounter":{"id":"Encounter/989898"},"location":{"name":"Far far away MD","id":"Location/542211"},"body_sites":["tooth #20","knee","left hip"],"reports":[{"name":"X-ray of the left hip","id":"DocumentReference/49818911"},{"name":"X-ray report","id":"DiagnosticReport/5518921"}],"follow_ups":["absolute rest for 6 days","physiotherapy"]}]}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Generic Bad Request":{"value":{"code":"1484000","message":"Bad request."}},"Upstream Bad Request":{"value":{"code":"1484001","message":"Bad Request in upstream."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"1484010","message":"Invalid JWT token."}},"No Upstream":{"value":{"code":"1484012","message":"No upstream selected."}},"Upstream Unauthorized":{"value":{"code":"1484014","message":"Unauthorized in upstream."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Missing Scopes":{"value":{"code":"1484030","message":"Required scopes are missing."}},"Account Forbidden":{"value":{"code":"1484031","message":"Account does not have access."}},"Upstream Forbidden":{"value":{"code":"1484032","message":"Forbidden in upstream."}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Not Found":{"value":{"code":"1484040","message":"Resource not found."}},"Upstream Not Found":{"value":{"code":"1484041","message":"Not Found in upstream."}}}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484050","message":"Method not allowed."}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484150","message":"Unsupported Media Type"}}}}}}},"/healthcare/diagnosis":{"post":{"tags":["HLS Providers"],"summary":"Diagnosis API, returns diagnosis results, whether to continue asking the next question, and the content of the question","description":"Diagnosis API, returns diagnosis results, whether to continue asking the next question, and the content of the question","operationId":"diagnosisPublic","security":[{"GA":["hls-symptom-checker:write"]}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["interaction_id"],"description":"The diagnosis request body.","properties":{"diagnosis_process_id":{"type":"string","description":"The diagnosis flow ID, UUID, It's empty when first called.","minLength":1,"maxLength":100},"interaction_id":{"type":"string","description":"The interaction id of VA.","minLength":1,"maxLength":100},"language":{"type":"string","description":"The diagnosis language. \n \n \n \n \n \n \n \n \n \n \n \n \n
    ProviderAllowed values
    isabelen,es,de,ar,hi,ur,tl,ml,ru,fr
    infermedicaar,zh,zh-hk,cs,da,nl,en,et,fr,de,gr,it,ja,es-xl,pl,pt,pt-br,ro,ru,sk,es,th,tr,uk
    \n","minLength":1,"maxLength":100,"enum":["en","es","de","ar","hi","ur","tl","ml","ru","zh","zh-hk","cs","da","nl","et","fr","gr","it","ja","es-xl","pl","pt","pt-br","ro","sk","th","tr","uk"]},"gender":{"type":"string","description":"The patient’s gender.","minLength":1,"maxLength":100},"pregnant":{"type":"string","description":"Isabel requires input as to whether a female patient is pregnant or not, N for \"Not Pregnant\", Y for “Pregnant\", and blank for \"Not Specified\"","minLength":1,"maxLength":100,"enum":["Y","N","null or empty string"]},"birth_date":{"type":"string","description":"The patient’s Birthdate.","minLength":1,"maxLength":8},"region":{"type":"string","description":"The region where the patient has lived or have recently traveled to. \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    ProviderAllowed valuesExplanation
    isabel\n 1,\n 2,\n 3,\n 4,\n 5,\n 6,\n 7,\n 8,\n 9,\n 10,\n 11,\n 12,\n 13,\n 14,\n 15,\n 16,\n 17\n \n 1-Western Europe. 2-Eastern Europe.\n 3-Africa Central. 4-Africa North.\n 5-Africa East. 6-Africa Southern.\n 7-Africa West. 8-Asia Southeast.\n 9-Asia East. 10-Asia South.\n 11-Caribbean. 12-North America.\n 13-America Central. 14-America South (tropical).\n 15-America South (temperate).16-Australasia.\n 17-Middle East.\n
    infermedica\n p_236,\n p_19,\n p_17,\n p_14,\n p_15,\n p_21,\n p_16,\n p_20,\n p_18,\n p_13\n \n p_236-Residence or recent travel, Asia, excluding Middle East, Russia, Mongolia and Kazakhstan.\n p_19-Residence or recent travel, Australia and Oceania.\n p_17-Residence or recent travel, Central Africa.\n p_14-Residence or recent travel, Central or South America.\n p_15-Residence or recent travel, Europe.\n p_21-Residence or recent travel, Middle East.\n p_16-Residence or recent travel, Northern Africa.\n p_20-Residence or recent travel, Russia, Kazakhstan, or Mongolia.\n p_18-Residence or recent travel, Southern Africa.\n p_13-Residence or recent travel, the United States or Canada.\n
    ","minLength":1,"maxLength":100,"enum":[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,"p_236","p_19","p_17","p_14","p_15","p_21","p_16","p_20","p_18","p_13"]},"symptoms_text":{"type":"string","description":"The symptoms described by patient.","minLength":1,"maxLength":2147483647},"answers":{"type":"array","description":"The list of Patient Diagnostic Questionnaire Answer.","items":{"type":"object","required":["option_id","option_value"],"properties":{"option_id":{"type":"string","description":"The patient Diagnostic Questionnaire Answer ID.","minLength":1,"maxLength":100},"option_value":{"type":"string","description":"The patient Diagnostic Questionnaire Answer Value.","minLength":1,"maxLength":100}}}}}},"example":{"diagnosis_process_id":"542385fc-a7b5-4044-bb30-1891c57a7744","interaction_id":"yourInteractionId","language":"en","gender":"MALE","birth_date":"1990-01-01","region":"1","symptoms_text":"i am headache","answers":[{"option_id":"1","option_value":"a"}]}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","required":["diagnosis_process_id","should_stop"],"description":"The diagnosis response body.","properties":{"id":{"type":"string","description":"The diagnosis flow ID, UUID","minLength":1,"maxLength":100},"diagnosis_process_id":{"type":"string","description":"The diagnosis flow ID, UUID","minLength":1,"maxLength":100},"should_stop":{"type":"boolean","description":"Is should stop diagnosis."},"diagnosis_result":{"type":"array","description":"The list of diagnosis result.","items":{"type":"object","required":["diagnosis_id","diagnosis_name"],"properties":{"diagnosis_id":{"type":"string","description":"The id of the diagnosis result.","minLength":1,"maxLength":100},"diagnosis_name":{"type":"string","description":"The name of the diagnosis result.","minLength":1,"maxLength":2147483647}}}},"question":{"type":"object","description":"The diagnosis next question.","required":["question_type","question_text","options"],"properties":{"question_type":{"type":"string","description":"The diagnosis the type of question.","minLength":1,"maxLength":100},"question_text":{"type":"string","description":"The diagnosis the text of question.","minLength":1,"maxLength":2147483647},"options":{"type":"array","description":"The list of the diagnosis option.","items":{"type":"object","required":["option_id","option_label","option_value"],"properties":{"option_id":{"type":"string","description":"The option ID to Diagnosis the question.","minLength":1,"maxLength":100},"option_label":{"type":"string","description":"The option label to Diagnosis the question.","minLength":1,"maxLength":2147483647},"option_value":{"type":"string","description":"The option value to Diagnosis the question.","minLength":1,"maxLength":100}}}}}}}},"example":{"id":"542385fc-a7b5-4044-bb30-1891c57a7744","diagnosis_process_id":"542385fc-a7b5-4044-bb30-1891c57a7744","should_stop":false,"diagnosis_result":[{"diagnosis_id":"1997","diagnosis_name":"Brain Tumors"}],"question":{"question_type":"single","question_text":"Do you have a runny nose?","options":[{"option_id":"s_107","option_label":"Nasal catarrh","option_value":"present"}]}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Generic Bad Request":{"value":{"code":"1484000","message":"Bad request."}},"Upstream Bad Request":{"value":{"code":"1484001","message":"Bad Request in upstream."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"1484010","message":"Invalid JWT token."}},"No Upstream":{"value":{"code":"1484012","message":"No upstream selected."}},"Upstream Unauthorized":{"value":{"code":"1484014","message":"Unauthorized in upstream."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Missing Scopes":{"value":{"code":"1484030","message":"Required scopes are missing."}},"Account Forbidden":{"value":{"code":"1484031","message":"Account does not have access."}},"Upstream Forbidden":{"value":{"code":"1484032","message":"Forbidden in upstream."}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Not Found":{"value":{"code":"1484040","message":"Resource not found."}},"Upstream Not Found":{"value":{"code":"1484041","message":"Not Found in upstream."}}}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484050","message":"Method not allowed."}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484150","message":"Unsupported Media Type"}}}}}}},"/healthcare/triages/{diagnosis_process_id}":{"post":{"tags":["HLS Providers"],"summary":"Triage API, returns triage level","description":"Triage API, returns triage level.","operationId":"triagePublic","security":[{"GA":["hls-symptom-checker:write"]}],"parameters":[{"name":"diagnosis_process_id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":100,"example":"542385fc-a7b5-4044-bb30-1891c57a7744"}},{"name":"interaction_id","in":"query","required":true,"description":"Interaction id","schema":{"type":"string","example":"a4321244a4c340c2b326965fdb15js0e"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","required":["triage_level"],"properties":{"id":{"type":"string","description":"The diagnosis flow ID, UUID","minLength":1,"maxLength":100},"diagnosis_process_id":{"type":"string","description":"The diagnosis flow ID, UUID, It's empty when first called.","minLength":1,"maxLength":100},"triage_level":{"type":"string","minLength":1,"maxLength":100,"enum":["EMERGENCY_HOSPITAL","URGENT_APPOINTMENT","FOLLOW_UP_APPOINTMENT"],"description":"The level of triage, (Emergency Hospital) - Go to the near emergency hospital,(Urgent Appointment) - Schedule an appointment soon as possible, (Follow-up Appointment) - It’s not critical."}}},"example":{"id":"542385fc-a7b5-4044-bb30-1891c57a7744","diagnosis_process_id":"542385fc-a7b5-4044-bb30-1891c57a7744","triage_level":"EMERGENCY_HOSPITAL"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Generic Bad Request":{"value":{"code":"1484000","message":"Bad request."}},"Upstream Bad Request":{"value":{"code":"1484001","message":"Bad Request in upstream."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"1484010","message":"Invalid JWT token."}},"No Upstream":{"value":{"code":"1484012","message":"No upstream selected."}},"Upstream Unauthorized":{"value":{"code":"1484014","message":"Unauthorized in upstream."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Missing Scopes":{"value":{"code":"1484030","message":"Required scopes are missing."}},"Account Forbidden":{"value":{"code":"1484031","message":"Account does not have access."}},"Upstream Forbidden":{"value":{"code":"1484032","message":"Forbidden in upstream."}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Not Found":{"value":{"code":"1484040","message":"Resource not found."}},"Upstream Not Found":{"value":{"code":"1484041","message":"Not Found in upstream."}}}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484050","message":"Method not allowed."}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484150","message":"Unsupported Media Type"}}}}}}},"/healthcare/patient-case":{"post":{"tags":["HLS Providers"],"summary":"Create a case documents of a patient.","description":"Create a case documents of a patient.","operationId":"patientCases","security":[{"GA":["hls-patient-case:write"]}],"parameters":[{"name":"interaction_id","in":"query","required":true,"description":"Required interaction Id","schema":{"type":"string","example":"abc","minLength":1,"maxLength":200}}],"requestBody":{"description":"The request_body of the patient case.","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"facility_id":{"type":"string","nullable":true,"description":"Facility ID.","minLength":0,"maxLength":50},"provider_id":{"type":"string","nullable":true,"description":"Provider ID.","minLength":0,"maxLength":50},"subject":{"type":"string","nullable":true,"description":"Subject of the case.","minLength":0,"maxLength":100},"note":{"type":"string","nullable":true,"description":"Note of the case.","minLength":0,"maxLength":4000},"case_class":{"type":"string","nullable":true,"description":"Class of the case.","minLength":0},"priority":{"type":"string","nullable":true,"description":"priority of the case.","minLength":0},"auto_close":{"type":"boolean","nullable":true,"description":"When set to true, the document will skip the clinical inbox and be added directly to the patient chart with a closed status."},"case_subclass":{"type":"string","nullable":true,"description":"Subclass of the case.","minLength":0},"resolution_first_contact":{"type":"boolean","nullable":true,"description":"Indicates if the resolution was made on first contact."},"resolution_reason":{"type":"string","nullable":true,"description":"Reason for resolution.","minLength":0}}},"example":{"facility_id":"12345","provider_id":"67890","subject":"General Checkup","note":"Patient needs a follow-up in two weeks.","case_class":"Consultation","priority":"Normal","auto_close":true,"case_subclass":"routine","resolution_first_contact":true,"resolution_reason":"Resolved during call"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","required":["id","success"],"properties":{"id":{"type":"string","nullable":false,"description":"Identifier of the patient case."},"success":{"type":"boolean","nullable":false,"description":"Indicates if the patient case was successfully created."}}},"example":{"id":"206090","success":true}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Generic Bad Request":{"value":{"code":"1484000","message":"Bad request."}},"Upstream Bad Request":{"value":{"code":"1484001","message":"Bad Request in upstream."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"1484010","message":"Invalid JWT token."}},"No Upstream":{"value":{"code":"1484012","message":"No upstream selected."}},"Upstream Unauthorized":{"value":{"code":"1484014","message":"Unauthorized in upstream."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Missing Scopes":{"value":{"code":"1484030","message":"Required scopes are missing."}},"Account Forbidden":{"value":{"code":"1484031","message":"Account does not have access."}},"Upstream Forbidden":{"value":{"code":"1484032","message":"Forbidden in upstream."}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Not Found":{"value":{"code":"1484040","message":"Resource not found."}},"Upstream Not Found":{"value":{"code":"1484041","message":"Not Found in upstream."}}}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484050","message":"Method not allowed."}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484150","message":"Unsupported Media Type"}}}}}}},"/healthcare/outstanding-orders":{"get":{"tags":["HLS Providers"],"summary":"Get the outstanding orders of a patient.","description":"Get the outstanding orders of a patient.","operationId":"getOutstandingOrdersPublic","security":[{"GA":["hls-outstanding-order:read"]}],"parameters":[{"name":"interaction_id","in":"query","required":true,"description":"Required interaction Id","schema":{"type":"string","example":"abc","minLength":1,"maxLength":200}},{"name":"show_declined_orders","in":"query","required":false,"description":"Show declined orders.default is false.","schema":{"type":"boolean"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","example":1,"minimum":1,"maximum":2147483647,"default":1}},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","example":5,"minimum":1,"maximum":50,"default":5}}],"responses":{"200":{"description":"OK","content":{"application/hal+json":{"schema":{"type":"object","required":["count","total","page","per_page","total_pages","_embedded"],"properties":{"count":{"type":"integer","description":"The number of results in the current page"},"total":{"type":"integer","description":"The total of results"},"page":{"type":"integer","description":"The current page"},"per_page":{"type":"integer","description":"The number of results per page"},"total_pages":{"type":"integer","description":"The total number of result pages"},"_embedded":{"type":"object","description":"List of patient cases in current page","required":["outstanding_orders"],"properties":{"outstanding_orders":{"type":"array","items":{"type":"object","properties":{"id":{"description":"order id","type":"string","minLength":0,"maxLength":255},"assigned_user":{"type":"string","nullable":true,"description":"The user assigned to the order.","minLength":0,"maxLength":255},"order_class":{"type":"string","nullable":true,"description":"The class of the order.","minLength":0,"maxLength":255},"order_class_description":{"type":"string","nullable":true,"description":"The description of the order class.","minLength":0,"maxLength":255},"clinical_provider_id":{"type":"integer","nullable":true,"description":"The ID of the clinical provider."},"clinical_provider_name":{"type":"string","nullable":true,"description":"The name of the clinical provider."},"contraindication_reason":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"The code indicating why the order was not given.","nullable":true,"minLength":0,"maxLength":255},"codeset":{"type":"string","description":"The codeset that the code belongs to.","nullable":true,"minLength":0,"maxLength":255},"description":{"type":"string","description":"The plaintext description of the reason the order was not given.","nullable":true,"minLength":0,"maxLength":255}}},"nullable":true,"description":"The reason for the contraindication."},"created_encounter_id":{"type":"integer","nullable":true,"description":"The ID of the encounter created for the order."},"date_ordered":{"format":"date-time","type":"string","description":"The date the order was created.","minLength":0,"maxLength":255},"declined_reason":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"The code indicating why the order was not given.","nullable":true,"minLength":0,"maxLength":255},"codeset":{"type":"string","description":"The codeset that the code belongs to.","nullable":true,"minLength":0,"maxLength":255},"description":{"type":"string","description":"The plaintext description of the reason the order was not given.","nullable":true,"minLength":0,"maxLength":255}}},"nullable":true,"description":"The reason for the order being declined."},"declined_reason_text":{"type":"string","nullable":true,"description":"The text reason for the order being declined.","minLength":0,"maxLength":255},"department_id":{"type":"integer","nullable":true,"description":"The ID of the department.","minLength":0,"maxLength":255},"description":{"type":"string","nullable":true,"description":"The description of the order.","minLength":0,"maxLength":255},"documentation_only":{"type":"string","nullable":true,"description":"The documentation only flag.","minLength":0,"maxLength":255},"document_id":{"type":"integer","description":"The ID of the document."},"encounter_id":{"type":"integer","nullable":true,"description":"The ID of the encounter."},"name":{"type":"string","description":"The name of the order.","minLength":0,"maxLength":255},"ordering_provider":{"type":"string","nullable":true,"description":"The provider who ordered the order.","minLength":0,"maxLength":255},"perform_date":{"format":"date-time","type":"string","nullable":true,"description":"The date the order is to be performed.","minLength":0,"maxLength":255},"priority":{"type":"integer","nullable":true,"description":"The priority of the order."},"status":{"type":"string","description":"The status of the order document. New orders start in REVIEW status and Open Orders include Review, Pending, Administer, Submit, Submitted, Perform, Followup, Dispense, Schedule, Scheduled, and Athena Error.","minLength":0,"maxLength":255}}}}}}}},"example":{"count":1,"total":1,"page":1,"per_page":5,"total_pages":1,"_embedded":{"outstanding_orders":[{"assigned_user":"john","order_class":"consult","order_class_description":"Consultation","clinical_provider_id":0,"clinical_provider_name":"John van Bockxmeer MD","contraindication_reason":[{"code":"44054006","codeset":"SNOMED","description":"type 2 diabetes mellitus"}],"created_encounter_id":0,"date_ordered":"2021-01-01T00:00:00Z","declined_reason":[{"code":"44054006","codeset":"SNOMED","description":"type 2 diabetes mellitus"}],"declined_reason_text":"text","department_id":157,"description":"azithromycin 500 mg tablet","documentation_only":"true","document_id":157,"encounter_id":0,"name":"azithromycin 500 mg tablet","ordering_provider":"abricker1","perform_date":"2021-01-01T00:00:00Z","priority":0,"status":"Review"}]}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Generic Bad Request":{"value":{"code":"1484000","message":"Bad request."}},"Upstream Bad Request":{"value":{"code":"1484001","message":"Bad Request in upstream."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"1484010","message":"Invalid JWT token."}},"No Upstream":{"value":{"code":"1484012","message":"No upstream selected."}},"Upstream Unauthorized":{"value":{"code":"1484014","message":"Unauthorized in upstream."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Missing Scopes":{"value":{"code":"1484030","message":"Required scopes are missing."}},"Account Forbidden":{"value":{"code":"1484031","message":"Account does not have access."}},"Upstream Forbidden":{"value":{"code":"1484032","message":"Forbidden in upstream."}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Not Found":{"value":{"code":"1484040","message":"Resource not found."}},"Upstream Not Found":{"value":{"code":"1484041","message":"Not Found in upstream."}}}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484050","message":"Method not allowed."}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484150","message":"Unsupported Media Type"}}}}}}},"/healthcare/popup/intent":{"post":{"tags":["HLS Providers"],"summary":"Save intent of a patient.","description":"Save intent of a patient.","operationId":"saveIntentPublic","security":[{"GA":["hls-popup-intent:write"]}],"requestBody":{"description":"The request_body of save intent.","required":true,"content":{"application/json":{"schema":{"type":"object","required":["interaction_id","intent"],"properties":{"interaction_id":{"type":"string","nullable":false,"description":"Interaction ID.","minLength":0,"maxLength":50},"intent":{"type":"string","nullable":false,"description":"intent of a patient.","minLength":0,"maxLength":100}}},"example":{"interaction_id":"123456","intent":"Scheduling"}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"type":"object","required":["id","success"],"properties":{"id":{"type":"string","nullable":false,"description":"Interaction ID."},"success":{"type":"boolean","nullable":false,"description":"Indicates if the intent of patient was successfully saved."}}},"example":{"id":"123456","success":true}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Generic Bad Request":{"value":{"code":"1484000","message":"Bad request."}},"Upstream Bad Request":{"value":{"code":"1484001","message":"Bad Request in upstream."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"1484010","message":"Invalid JWT token."}},"No Upstream":{"value":{"code":"1484012","message":"No upstream selected."}},"Upstream Unauthorized":{"value":{"code":"1484014","message":"Unauthorized in upstream."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Missing Scopes":{"value":{"code":"1484030","message":"Required scopes are missing."}},"Account Forbidden":{"value":{"code":"1484031","message":"Account does not have access."}},"Upstream Forbidden":{"value":{"code":"1484032","message":"Forbidden in upstream."}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Not Found":{"value":{"code":"1484040","message":"Resource not found."}},"Upstream Not Found":{"value":{"code":"1484041","message":"Not Found in upstream."}}}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484050","message":"Method not allowed."}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484150","message":"Unsupported Media Type"}}}}}}},"/healthcare/patients/{patient_id}/medication-statements":{"get":{"tags":["HLS Providers"],"summary":"Get Medication Statement.","description":"Get a list of medication statement via an patient id.","operationId":"getMedicationStatements","security":[{"GA":["hls-medication-statement:read"]}],"parameters":[{"name":"patient_id","in":"path","required":true,"description":"patient ID","schema":{"type":"string","example":"abcd","minLength":1,"maxLength":2147483647}},{"name":"status","in":"query","required":false,"description":"Status","schema":{"type":"string","example":"status","minLength":1,"maxLength":2147483647}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","example":1,"minimum":1,"maximum":2147483647,"default":1}},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","example":5,"minimum":1,"maximum":50,"default":5}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","required":["count","total","page","per_page","total_pages","_embedded"],"properties":{"count":{"type":"integer","description":"The number of results in the current page"},"total":{"type":"integer","description":"The total of results"},"page":{"type":"integer","description":"The current page"},"per_page":{"type":"integer","description":"The number of results per page"},"total_pages":{"type":"integer","description":"The total number of result pages"},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string","format":"uri","minLength":1}}}}},"_embedded":{"type":"object","description":"List of Medication Statement in current page","required":["medication_statements"],"properties":{"medication_statements":{"type":"array","items":{"type":"object","minLength":0,"properties":{"id":{"description":"The medication statement id","type":"string"},"status":{"description":"The status of the medication statement","type":"string"},"name":{"description":"The medication name","type":"string"},"authored_on":{"description":"Date/time statement was recorded","type":"string","format":"date-time"},"dose":{"description":"How medication is taken","type":"string"},"patientInstruction":{"description":"Instructions for the patient","type":"string"},"effectivePeriod":{"type":"object","description":"Time of actual medication usage (point or period)","properties":{"start":{"description":"Start of the period","type":"string","format":"date-time"},"end":{"description":"End of the period","type":"string","format":"date-time"}}},"requester":{"description":"The requester of the Medication Statement.","type":"string"}}}}}}}},"example":{"count":1,"total":1,"page":1,"per_page":5,"total_pages":1,"_links":{"self":{"href":"https://api.talkdesk.com/healthcare/patients/1234/medication_statements"}},"_embedded":{"medication_statements":[{"id":"12332123","status":"active","name":"PSEUDOEPHEDRINE HCL 30 MG PO TABS","authored_on":"2022-01-11T14:45:00Z","dose":"30","patientInstruction":"Take one tablet by mouth every 4 to 6 hours as needed.","effectivePeriod":{"start":"2025-07-23T00:00:00","end":"2025-08-20T00:00:00"},"informationSource":"PRINTZ, TARA"}]}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Generic Bad Request":{"value":{"code":"1484000","message":"Bad request."}},"Upstream Bad Request":{"value":{"code":"1484001","message":"Bad Request in upstream."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"1484010","message":"Invalid JWT token."}},"No Upstream":{"value":{"code":"1484012","message":"No upstream selected."}},"Upstream Unauthorized":{"value":{"code":"1484014","message":"Unauthorized in upstream."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Missing Scopes":{"value":{"code":"1484030","message":"Required scopes are missing."}},"Account Forbidden":{"value":{"code":"1484031","message":"Account does not have access."}},"Upstream Forbidden":{"value":{"code":"1484032","message":"Forbidden in upstream."}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Not Found":{"value":{"code":"1484040","message":"Resource not found."}},"Upstream Not Found":{"value":{"code":"1484041","message":"Not Found in upstream."}}}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484050","message":"Method not allowed."}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484150","message":"Unsupported Media Type"}}}}}},"post":{"tags":["HLS Providers"],"summary":"Create Medication Statement.","description":"Create medication statement.","operationId":"CreateMedicationStatement","security":[{"GA":["hls-medication-statement:write"]}],"parameters":[{"name":"patient_id","in":"path","required":true,"description":"The patient id","schema":{"type":"string","example":"abc","minLength":1,"maxLength":2147483647}}],"requestBody":{"description":"The request body of medication statement.","content":{"application/json":{"schema":{"type":"object","required":["medication_statement_id"],"properties":{"medication_statement_id":{"type":"string","nullable":false,"description":"The medication statement id.","minLength":0,"maxLength":50},"status":{"type":"string","nullable":false,"description":"The medication statement status.","minLength":0,"maxLength":100}}},"example":{"medication_statement_id":"123456","status":"active"}}}},"responses":{"201":{"description":"Successfully created medication statement.","content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","nullable":false,"description":"The medication Statement ID."}}},"example":{"id":"123456"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Generic Bad Request":{"value":{"code":"1484000","message":"Bad request."}},"Upstream Bad Request":{"value":{"code":"1484001","message":"Bad Request in upstream."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"1484010","message":"Invalid JWT token."}},"No Upstream":{"value":{"code":"1484012","message":"No upstream selected."}},"Upstream Unauthorized":{"value":{"code":"1484014","message":"Unauthorized in upstream."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Missing Scopes":{"value":{"code":"1484030","message":"Required scopes are missing."}},"Account Forbidden":{"value":{"code":"1484031","message":"Account does not have access."}},"Upstream Forbidden":{"value":{"code":"1484032","message":"Forbidden in upstream."}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Not Found":{"value":{"code":"1484040","message":"Resource not found."}},"Upstream Not Found":{"value":{"code":"1484041","message":"Not Found in upstream."}}}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484050","message":"Method not allowed."}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484150","message":"Unsupported Media Type"}}}}}}},"/healthcare/patients/{patient_id}/medication-orders":{"post":{"tags":["HLS Providers"],"summary":"Create medication order(request).","description":"Create medication order(request).","operationId":"CreateMedicationOrder","security":[{"GA":["hls-medication-order:write"]}],"parameters":[{"name":"patient_id","in":"path","required":true,"description":"The patient id","schema":{"type":"string","example":"abc","minLength":1,"maxLength":2147483647}}],"requestBody":{"description":"The request body of medication orders.","content":{"application/json":{"schema":{"type":"object","required":["medication_order_id"],"properties":{"medication_order_id":{"type":"string","nullable":false,"description":"The medication order(request) id.","minLength":0,"maxLength":50},"status":{"type":"string","nullable":true,"description":"The medication order(request) status. Defaults to \"active\" if not specified.","default":"active","minLength":0,"maxLength":100}}},"example":{"medication_order_id":"123456","status":"active"}}}},"responses":{"201":{"description":"Successfully created medication order(request).","content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","nullable":false,"description":"The medication order ID."}}},"example":{"id":"123456"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Generic Bad Request":{"value":{"code":"1484000","message":"Bad request."}},"Upstream Bad Request":{"value":{"code":"1484001","message":"Bad Request in upstream."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"1484010","message":"Invalid JWT token."}},"No Upstream":{"value":{"code":"1484012","message":"No upstream selected."}},"Upstream Unauthorized":{"value":{"code":"1484014","message":"Unauthorized in upstream."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Missing Scopes":{"value":{"code":"1484030","message":"Required scopes are missing."}},"Account Forbidden":{"value":{"code":"1484031","message":"Account does not have access."}},"Upstream Forbidden":{"value":{"code":"1484032","message":"Forbidden in upstream."}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Not Found":{"value":{"code":"1484040","message":"Resource not found."}},"Upstream Not Found":{"value":{"code":"1484041","message":"Not Found in upstream."}}}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484050","message":"Method not allowed."}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484150","message":"Unsupported Media Type"}}}}}}},"/industries/external-entities":{"post":{"tags":["Industries External Entity Mapper"],"summary":"Create a map","description":"Create a new map with a given external entity.\n","operationId":"createMap","security":[{"GA":["entitymapper-map:write"]}],"requestBody":{"content":{"application/json":{"schema":{"required":["external_entity_context","external_entity_id","interaction_id"],"type":"object","properties":{"external_entity_context":{"type":"string","description":"The external entity context","minLength":1,"maxLength":2147483647},"external_entity_id":{"type":"string","description":"The external entity ID","minLength":1,"maxLength":2147483647},"external_entity_name":{"type":"string","description":"The external entity name","minLength":1,"maxLength":2147483647},"external_entity_birthdate":{"type":"string","format":"date","description":"The external entity birthdate","minLength":1,"maxLength":20},"interaction_id":{"type":"string","description":"The interaction ID","minLength":1,"maxLength":2147483647},"contact_id":{"type":"string","description":"The contact ID","minLength":1,"maxLength":2147483647},"extra_fields":{"type":"object","description":"The interaction extra fields","additionalProperties":{"type":"string"}}}},"example":{"external_entity_context":"hls-providers","external_entity_id":"123456","external_entity_name":"Patient 123456","external_entity_birthdate":"2001-06-30","interaction_id":"2d3dd6394ffdbffad79c","contact_id":"12423423412364354","extra_fields":{"PATIENT_MRN":"123456"}}}},"required":true},"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3344000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"3344010","message":"Invalid JWT."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3344030","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3344040","message":"Resource not found."}}}}}}},"/industries/external-entities-mapper":{"post":{"tags":["Industries External Entity Mapper"],"summary":"Create a map","description":"Create a new map with a given external entity.\n","operationId":"createMaps","security":[{"GA":["entitymapper-contact-interactions:write"]}],"requestBody":{"content":{"application/json":{"schema":{"required":["external_entity_context","external_entity_id","interaction_id"],"type":"object","properties":{"external_entity_context":{"type":"string","description":"The external entity context","minLength":1,"maxLength":2147483647},"external_entity_id":{"type":"string","description":"The external entity ID","minLength":1,"maxLength":2147483647},"external_entity_name":{"type":"string","description":"The external entity name","minLength":1,"maxLength":2147483647},"external_entity_birthdate":{"type":"string","format":"date","description":"The external entity birthdate","minLength":1,"maxLength":20},"interaction_id":{"type":"string","description":"The interaction ID","minLength":1,"maxLength":2147483647},"contact_id":{"type":"string","description":"The contact ID","minLength":1,"maxLength":2147483647},"extra_fields":{"type":"object","description":"The interaction extra fields","additionalProperties":{"type":"string"}}}},"example":{"external_entity_context":"hls-providers","external_entity_id":"123456","external_entity_name":"Patient 123456","external_entity_birthdate":"2001-06-30","interaction_id":"2d3dd6394ffdbffad79c","contact_id":"12423423412364354","extra_fields":{"PATIENT_MRN":"123456"}}}},"required":true},"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3344000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"3344010","message":"Invalid JWT."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3344030","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3344040","message":"Resource not found."}}}}}}},"/industries/external-entities/contacts/{phone}":{"get":{"tags":["Industries External Entity Mapper"],"summary":"Search Talkdesk contact by phone","description":"Search Talkdesk contact by phone.\n","operationId":"searchContactByPhone","security":[{"GA":["entitymapper-contacts:read"]}],"parameters":[{"in":"path","name":"phone","schema":{"type":"string"},"required":true,"description":"The phone number"}],"responses":{"200":{"description":"The contact detail information.","content":{"application/json":{"schema":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"Contact ID"},"name":{"type":"string","description":"Contact name"},"address":{"type":"string","description":"Contact address"},"tags":{"type":"array","items":{"type":"string"},"description":"Array of Contact tags"},"emails":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","description":"Email label"},"email":{"type":"string","description":"Email address"}}}},"phones":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","description":"Phone number label"},"number":{"type":"string","description":"Phone number in E.164 format"}}}},"custom_fields":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"Custom field key"},"value":{"type":"string","description":"Custom field value"}}}},"integrations":{"type":"array","items":{"type":"object","properties":{"integration_id":{"type":"string","description":"Identifier for the integration"},"external_id":{"type":"string","description":"External identifier for the contact in the integration"},"external_url":{"type":"string","description":"URL to the contact in the external system"},"external_sync_state":{"type":"string","description":"State of synchronization with the external system"},"contact_type":{"type":"string","description":"Type of contact"}}},"description":"Array of integration objects"}}},"example":{"id":"f68519eb9e5047b59dbf1c0e","name":"Daniel","address":"San Francisco","emails":[{"label":"Personal","email":"personal@personal.com"},{"label":"Company","email":"company@company.com"}],"phones":[{"label":"Mobile","number":"+351987654321"},{"label":"Business","number":"+321212345678"}],"custom_fields":[{"key":"ssn","value":"123456"}],"integrations":[{"integration_id":"bigcommerce","external_id":"1","external_url":"https://store-b7jd1jdnhf.mybigcommerce.com/admin/index.php?ToDo=viewCustomers&searchQuery=15","external_sync_state":"1;65ba1a288ff6880001054fd9;2024-01-31T10:04:15.593379523Z;1;0","contact_type":"contact"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3344000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"3344010","message":"Invalid JWT."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3344030","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3344040","message":"Resource not found."}}}}}}},"/industries/external-entities/contacts/channels":{"post":{"tags":["Industries External Entity Mapper"],"summary":"Search Talkdesk contact","description":"Search Talkdesk contact\n","operationId":"searchContactByChannels","security":[{"GA":["entitymapper-contacts:read"]}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","description":"The email address of the contact","minLength":1,"maxLength":2147483647},"phone":{"type":"string","description":"The phone of the contact","minLength":1,"maxLength":2147483647}}},"example":{"email":"inygardensnake@eggshells.yum","phone":"+351 916 085 400"}}},"required":true},"responses":{"200":{"description":"The contact detail information.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Contact ID"},"name":{"type":"string","description":"Contact name"},"address":{"type":"string","description":"Contact address"},"tags":{"type":"array","items":{"type":"string"},"description":"Array of Contact tags"},"emails":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","description":"Email label"},"email":{"type":"string","description":"Email address"}}}},"phones":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","description":"Phone number label"},"number":{"type":"string","description":"Phone number in E.164 format"}}}},"custom_fields":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"Custom field key"},"value":{"type":"string","description":"Custom field value"}}}}}}},"example":[{"id":"f68519eb9e5047b59dbf1c0e","name":"Daniel","address":"San Francisco","emails":[{"label":"Personal","email":"inygardensnake@eggshells.yum"},{"label":"Company","email":"inygardensnake@eggshells.yum"}],"phones":[{"label":"Mobile","number":"+351 916 085 400"},{"label":"Business","number":"+351 916 085 400"}],"custom_fields":[{"key":"ssn","value":"123456"}]}]}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3344000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"3344010","message":"Invalid JWT."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3344030","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3344040","message":"Resource not found."}}}}}}},"/industries/external-entities/contact-external":{"post":{"tags":["Industries External Entity Mapper"],"summary":"Create a contact","description":"Create a new contact by a given external contact info, this used for digital chat channel.","operationId":"searchAndCreateContact","security":[{"GA":["entitymapper-contacts:write"]}],"requestBody":{"content":{"application/json":{"schema":{"required":["external_id"],"type":"object","properties":{"external_id":{"type":"string","description":"The external ID of the contact,this must be unique to the external system"},"contact_name":{"type":"string","description":"The name of the contact","minLength":1,"maxLength":2147483647},"contact_phone":{"type":"string","description":"The phone number of the contact","minLength":1,"maxLength":2147483647},"contact_email":{"type":"string","format":"email","description":"The email address of the contact","minLength":1,"maxLength":2147483647}}},"example":{"external_id":"1001","contact_name":"","contact_phone":"","contact_email":""}}},"required":true},"responses":{"200":{"description":"Create a new contact response.","content":{"application/json":{"schema":{"type":"object","properties":{"matched":{"type":"integer","description":"The number of matched contacts"},"_embedded":{"type":"object","properties":{"contacts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the contact"},"tags":{"type":"array","items":{"type":"string"},"description":"The tags associated with the contact"},"name":{"type":"string","description":"The name of the contact"},"address":{"type":"string","description":"The address of the contact"},"emails":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","description":"The label of the email"},"email":{"type":"string","format":"email","description":"The email address"}}},"description":"The emails associated with the contact"},"phones":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","description":"The label of the phone number"},"number":{"type":"string","description":"The phone number"}}},"description":"The phone numbers associated with the contact"},"custom_fields":{"type":"array","items":{"type":"object"},"description":"The custom fields associated with the contact"},"integrations":{"type":"array","items":{"type":"object","properties":{"integration_id":{"type":"string","description":"The integration ID"},"external_id":{"type":"string","description":"The external ID"},"external_url":{"type":"string","description":"The external URL"},"external_sync_state":{"type":"string","description":"The external sync state"},"contact_type":{"type":"string","description":"The type of contact"}}},"description":"The integrations associated with the contact"},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","description":"The self-reference link"}}}}}}}}}}}},"example":{"matched":3,"_embedded":{"contacts":[{"id":"66051314713d63001ef18eb6","tags":[],"name":"david test create 001","address":"","emails":[{"label":"","email":"test1@gmail.com"}],"phones":[],"custom_fields":[],"integrations":[{"integration_id":"autocreate contact","external_id":"0","external_url":"","external_sync_state":null,"contact_type":"contact"}],"_links":{"self":{"href":"https://api.talkdeskstg.com/callbar/contacts/66051314713d63001ef18eb6"}}},{"id":"6605628df756cc00217b07b8","tags":[],"name":"test create 001","address":"","emails":[{"label":"","email":"test2@gmail.com"}],"phones":[],"custom_fields":[],"integrations":[{"integration_id":"autocreate contact","external_id":"0","external_url":"","external_sync_state":null,"contact_type":"contact"}],"_links":{"self":{"href":"https://api.talkdeskstg.com/callbar/contacts/6605628df756cc00217b07b8"}}},{"id":"660562f0f756cc00217b07ba","tags":[],"name":"test create 002","address":"","emails":[{"label":"","email":"test3@gmail.com"}],"phones":[],"custom_fields":[],"integrations":[{"integration_id":"autocreate contact","external_id":"0","external_url":"","external_sync_state":null,"contact_type":"contact"}],"_links":{"self":{"href":"https://api.talkdeskstg.com/callbar/contacts/660562f0f756cc00217b07ba"}}}]}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3344000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"3344010","message":"Invalid JWT."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3344030","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3344040","message":"Resource not found."}}}}}}},"/industries/external-entities/contact-bind-interaction":{"post":{"tags":["Industries External Entity Mapper"],"summary":"Contact bind to an interaction","description":"Bind a contact to an interaction.","operationId":"bindContactToInteraction","security":[{"GA":["entitymapper-contact-interactions:write"]}],"requestBody":{"content":{"application/json":{"schema":{"required":["contact_id","interaction_id"],"type":"object","properties":{"contact_id":{"type":"string","description":"ID of the contact"},"interaction_id":{"type":"string","description":"ID of the interaction"}}},"example":{"contact_id":"1234","interaction_id":"5678"}}},"required":true},"responses":{"200":{"description":"The contact bind interaction result.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID of the binding interaction"},"status":{"type":"string","description":"Status of the binding interaction"},"channel_type":{"type":"string","description":"Type of channel for the interaction"},"contact_person":{"type":"object","properties":{"endpoint":{"type":"string","description":"Endpoint of the contact person"},"href":{"type":"string","description":"Href of the contact person"},"id":{"type":"string","description":"ID of the contact person"}}}}},"example":{"id":"abcd1234","status":"success","channel_type":"email","contact_person":{"endpoint":"https://example.com/contact/1234","href":"https://example.com/contact/1234","id":"1234"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3344000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"3344010","message":"Invalid JWT."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3344030","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3344040","message":"Resource not found."}}}}}}},"/industries/external-entities/contact-sync/{integration_id}/{external_id}":{"put":{"tags":["Industries External Entity Mapper"],"summary":"Syncs a contact based on external integration ID and external ID","description":"Upserts a contact based on external integration ID and external ID","operationId":"searchAndUpsertContact","security":[{"GA":["entitymapper-contacts:write"]}],"parameters":[{"name":"integration_id","in":"path","required":true,"description":"Integration ID","schema":{"type":"string","minLength":1}},{"name":"external_id","in":"path","required":true,"description":"External ID for the contact in the external system","schema":{"type":"string","minLength":1}},{"name":"existing_contact_id","in":"query","required":false,"description":"Existing contact ID associated with the interaction (optional)","schema":{"type":"string","minLength":24,"maxLength":24}}],"requestBody":{"content":{"application/json":{"schema":{"required":["integrations"],"type":"object","properties":{"tags":{"type":"array","items":{"type":"string","minLength":1},"description":"The tags associated with the contact"},"name":{"type":"string","description":"The name of the contact","minLength":1,"nullable":true},"address":{"type":"string","description":"The address of the contact","minLength":1,"nullable":true},"emails":{"type":"array","items":{"type":"object","required":["email"],"properties":{"label":{"type":"string","description":"The label of the email","minLength":1,"nullable":true},"email":{"type":"string","format":"email","description":"The email address","minLength":1}}},"description":"The emails associated with the contact"},"phones":{"type":"array","items":{"type":"object","required":["number"],"properties":{"label":{"type":"string","description":"The label of the phone number","minLength":1,"nullable":true},"number":{"type":"string","description":"The phone number","minLength":1}}},"description":"The phone numbers associated with the contact"},"custom_fields":{"type":"array","items":{"type":"object","required":["key","value"],"properties":{"key":{"type":"string","description":"The key of the custom field","minLength":1},"value":{"type":"string","description":"The value of the custom field","minLength":1}}},"description":"The custom fields associated with the contact"},"integrations":{"type":"array","items":{"type":"object","required":["integration_id","external_id"],"properties":{"integration_id":{"type":"string","description":"The integration ID","minLength":1},"external_id":{"type":"string","description":"The external ID","minLength":1},"external_url":{"type":"string","description":"The external URL","minLength":1,"nullable":true},"external_sync_state":{"type":"string","description":"The external sync state","minLength":1,"nullable":true},"contact_type":{"type":"string","description":"The type of contact","minLength":1,"nullable":true}}},"description":"The integrations associated with the contact"}}},"example":{"name":"John Doe","address":"123 Main St, Springfield, IL 62701","integrations":[{"integration_id":"salesforce","external_id":"SF-001","external_url":"https://salesforce.com/contacts/SF-001","contact_type":"Lead","external_sync_state":"synced"}],"tags":["VIP","Newsletter Subscriber"],"emails":[{"label":"work","email":"john.doe@work.com"}]}}},"required":true},"responses":{"200":{"description":"Upserts the contact based on whether a contact was found using the integration ID and external ID.","content":{"application/json":{"schema":{"type":"object","required":["matched"],"properties":{"matched":{"type":"integer","description":"The number of matched contacts"},"_embedded":{"type":"object","required":["contacts"],"properties":{"contacts":{"type":"array","items":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the contact"},"tags":{"type":"array","items":{"type":"string"},"description":"The tags associated with the contact"},"name":{"type":"string","description":"The name of the contact"},"address":{"type":"string","description":"The address of the contact"},"emails":{"type":"array","items":{"type":"object","required":["email"],"properties":{"label":{"type":"string","description":"The label of the email"},"email":{"type":"string","format":"email","description":"The email address"}}},"description":"The emails associated with the contact"},"phones":{"type":"array","items":{"type":"object","required":["number"],"properties":{"label":{"type":"string","description":"The label of the phone number"},"number":{"type":"string","description":"The phone number"}}},"description":"The phone numbers associated with the contact"},"custom_fields":{"type":"array","items":{"type":"object","required":["key"],"properties":{"key":{"type":"string","description":"The key of the custom field"},"value":{"type":"string","description":"The value of the custom field"}}},"description":"The custom fields associated with the contact"},"integrations":{"type":"array","items":{"type":"object","required":["integration_id","external_id"],"properties":{"integration_id":{"type":"string","description":"The integration ID"},"external_id":{"type":"string","description":"The external ID"},"external_url":{"type":"string","description":"The external URL"},"external_sync_state":{"type":"string","description":"The external sync state"},"contact_type":{"type":"string","description":"The type of contact"}}},"description":"The integrations associated with the contact"},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string","description":"The self-reference link"}}}}}}}}}}}},"example":{"matched":1,"_embedded":{"contacts":[{"id":"66051314713d63001ef18eb6","tags":["VIP","Newsletter Subscriber"],"name":"John Doe","address":"123 Main St, Springfield, IL 62701","emails":[{"label":"work","email":"john.doe@work.com"}],"phones":[],"custom_fields":[],"integrations":[{"integration_id":"salesforce","external_id":"SF-001","external_url":"https://salesforce.com/contacts/SF-001","contact_type":"Lead","external_sync_state":"synced"}],"_links":{"self":{"href":"https://api.talkdeskstg.com/callbar/contacts/66051314713d63001ef18eb6"}}}]}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3344000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"3344010","message":"Invalid JWT."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3344030","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3344040","message":"Resource not found."}}}}}}},"/appointment-scheduling/virtual-agent/schedule-settings":{"get":{"tags":["Appointment scheduling service"],"summary":"Retrieve flat appointment scheduling","description":"Retrieve flat appointment scheduling by provider, service type or location.","operationId":"getFlatAppointmentScheduling","security":[{"GA":["appointment-scheduling-va:read"]}],"parameters":[{"name":"provider_id","in":"query","description":"Id of the provider.","required":false,"example":"provider_id_123","schema":{"type":"string","minLength":1}},{"name":"service_type_id","in":"query","description":"Id of the service type.","required":false,"example":"service_type_id_123","schema":{"type":"string","minLength":1}},{"name":"location_id","in":"query","description":"Id of the location.","required":false,"example":"location_id_123","schema":{"type":"string","minLength":1}},{"name":"service_type_description","in":"query","description":"Service type description. Only applies if service_type_id is not specified.","required":false,"example":"service type description.","schema":{"type":"string","minLength":1}},{"name":"provider_description","in":"query","description":"Provider description. Only applies if provider_id is not specified.","required":false,"example":"Provider description.","schema":{"type":"string","minLength":1}},{"name":"location_description","in":"query","description":"Location description. Only applies if location_id is not specified.","required":false,"example":"Location description.","schema":{"type":"string","minLength":1}},{"name":"office_address","in":"query","description":"Office address. Only applies if location_id is not specified.","required":false,"example":"Office Address.","schema":{"type":"string","minLength":1}},{"name":"office_city","in":"query","description":"Office City. Only applies if location_id is not specified.","required":false,"example":"Office city.","schema":{"type":"string","minLength":1}},{"name":"office_state","in":"query","description":"Office State. Only applies if location_id is not specified.","required":false,"example":"Office State.","schema":{"type":"string","minLength":1}},{"name":"office_zip_code","in":"query","description":"Office zip code. Only applies if location_id is not specified.","required":false,"example":"Office zip code.","schema":{"type":"string","minLength":1}},{"name":"office_phone_number","in":"query","description":"Office Phone Number. Only applies if location_id is not specified.","required":false,"example":"Office Phone Number.","schema":{"type":"string","minLength":1}},{"name":"gender","in":"query","description":"The sex of the physician. Only applies if provider_id is not specified.","required":false,"example":"The sex of the physician.","schema":{"type":"string","minLength":1}},{"name":"language","in":"query","description":"The language spoken by physician. Only applies if provider_id is not specified.","required":false,"example":"The language spoken by physician.","schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","required":["provider_id","provider_description","photo_url","gender","language","service_type_id","service_type_description","location_id","location_description","office_address","office_city","office_state","office_zip_code","office_phone_number","total","provider_list","service_type_list","location_list"],"properties":{"provider_id":{"type":"string","minLength":1,"description":"The provider id, if this field doesn't exist, it returns an empty string."},"provider_description":{"type":"string","minLength":1,"description":"The provider description, if this field doesn't exist, it returns an empty string."},"photo_url":{"type":"string","minLength":1,"description":"The provider photo url, only URL starting with https:// and ending with .jpg are supported, and the field only returns intermediate paths, e.g. https://test/A.jpg returns test/A, if this field doesn't exist, it returns an empty string."},"gender":{"type":"string","minLength":1,"description":"The sex of the physician, if this field doesn't exist, it returns an empty string."},"language":{"type":"string","minLength":1,"description":"The language spoken by physician, if this field doesn't exist, it returns an empty string."},"service_type_id":{"type":"string","minLength":1,"description":"The service type id, if this field doesn't exist, it returns an empty string."},"service_type_description":{"type":"string","minLength":1,"description":"The service type description, if this field doesn't exist, it returns an empty string."},"location_id":{"type":"string","minLength":1,"description":"The location id, if this field doesn't exist, it returns an empty string."},"location_description":{"type":"string","minLength":1,"description":"The location description, if this field doesn't exist, it returns an empty string."},"office_address":{"type":"string","minLength":1,"description":"The office address, if this field doesn't exist, it returns an empty string."},"office_city":{"type":"string","minLength":1,"description":"The office city, if this field doesn't exist, it returns an empty string."},"office_state":{"type":"string","minLength":1,"description":"The office state, if this field doesn't exist, it returns an empty string."},"office_zip_code":{"type":"string","minLength":1,"description":"The office zip code, if this field doesn't exist, it returns an empty string."},"office_phone_number":{"type":"string","minLength":1,"description":"The office phone number, if this field doesn't exist, it returns an empty string."},"total":{"type":"integer","minLength":1,"description":"The total combinations found."},"provider_list":{"description":"List of providers in the query response, if more than one scheduling setting was found.","type":"array","items":{"description":"Virtual Agent Schedule Setting Field Dto.","type":"object","required":["id","description","photo_url","gender","language"],"properties":{"id":{"type":"string","minLength":1,"description":"The provider id."},"description":{"type":"string","minLength":1,"description":"The provider description."},"photo_url":{"type":"string","minLength":1,"description":"The provider photo url, only URL starting with 'https://' and ending with '.jpg' are supported, and the field only returns intermediate paths, e.g. 'https://test/A.jpg' returns 'test/A', if this field doesn't exist, it returns an empty string."},"gender":{"type":"string","minLength":1,"description":"The sex of the physician, if this field doesn't exist, it returns an empty string."},"language":{"type":"string","minLength":1,"description":"The language spoken by physician, if this field doesn't exist, it returns an empty string."}}}},"service_type_list":{"description":"List of service types in the query response, if more than one scheduling setting was found.","type":"array","items":{"description":"Virtual Agent Schedule Setting Field Dto.","type":"object","required":["id","description"],"properties":{"id":{"type":"string","minLength":1,"description":"The service_type id."},"description":{"type":"string","minLength":1,"description":"The service_type description."}}}},"location_list":{"description":"List of locations in the query response, if more than one scheduling setting was found.","type":"array","items":{"description":"Virtual Agent Schedule Setting Field Dto.","type":"object","required":["id","description","office_address","office_city","office_state","office_zip_code","office_phone_number"],"properties":{"id":{"type":"string","minLength":1,"description":"The location id."},"description":{"type":"string","minLength":1,"description":"The location description."},"office_address":{"type":"string","minLength":1,"description":"The office address, if this field doesn't exist, it returns an empty string."},"office_city":{"type":"string","minLength":1,"description":"The office city, if this field doesn't exist, it returns an empty string."},"office_state":{"type":"string","minLength":1,"description":"The office state, if this field doesn't exist, it returns an empty string."},"office_zip_code":{"type":"string","minLength":1,"description":"The office zip code, if this field doesn't exist, it returns an empty string."},"office_phone_number":{"type":"string","minLength":1,"description":"The office phone number, if this field doesn't exist, it returns an empty string."}}}}}},"example":{"provider_id":"21dc3e40-670b-11ec-90d6-0242ac120003","provider_description":"Cardiothoracic surgeon","photo_url":"image/photo","gender":"Female","language":"English","service_type_id":"8ce8d946-670b-11ec-90d6-0242ac120003","service_type_description":"Surgery","location_id":"b87acf92-670b-11ec-90d6-0242ac120003","location_description":"Saint Francis Memorial Hospital, department C","office_address":"789 Oak St","office_city":"City C","office_state":"State Z","office_zip_code":123456,"office_phone_number":"(555) 345-6789","total":1,"provider_list":[{"id":123,"description":"provider description","photo_url":"image/photo","gender":"Female","language":"English"}],"service_type_list":[{"id":123,"description":"service_type description"}],"location_list":[{"id":123,"description":"location description","office_address":"office address","office_city":"office city","office_state":"office state","office_zip_code":"office zip code","office_phone_number":"office phone number"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484010","message":"Invalid JWT token."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484030","message":"Required scopes are missing."}}}}}}},"/appointment-scheduling/healthcare/past-encounters/physicians":{"get":{"tags":["Appointment scheduling service"],"summary":"Search physicians based on the patient's past encounters","description":"Search physicians based on the patient's past encounters, if no encounters exist, return physicians based on the searching conditions.","operationId":"getPhysiciansByPastEncounters","security":[{"GA":["appointment-scheduling-va:read"]}],"parameters":[{"name":"patient_id","in":"query","description":"Id of the patient.","required":true,"example":"ex7vpf96kjzlg2n","schema":{"type":"string","minLength":1}},{"name":"service_type_id","in":"query","description":"Id of the service type.","required":false,"example":"service_type_id_123","schema":{"type":"string","minLength":1}},{"name":"location_id","in":"query","description":"Id of the location.","required":false,"example":"location_id_123","schema":{"type":"string","minLength":1}},{"name":"service_type_description","in":"query","description":"Service type description. Only applies if service_type_id is not specified.","required":false,"example":"service type description.","schema":{"type":"string","minLength":1}},{"name":"provider_description","in":"query","description":"Provider description. Only applies if provider_id is not specified.","required":false,"example":"Provider description.","schema":{"type":"string","minLength":1}},{"name":"location_description","in":"query","description":"Location description. Only applies if location_id is not specified.","required":false,"example":"Location description.","schema":{"type":"string","minLength":1}},{"name":"office_address","in":"query","description":"Office address. Only applies if location_id is not specified.","required":false,"example":"Office Address.","schema":{"type":"string","minLength":1}},{"name":"office_city","in":"query","description":"Office City. Only applies if location_id is not specified.","required":false,"example":"Office city.","schema":{"type":"string","minLength":1}},{"name":"office_state","in":"query","description":"Office State. Only applies if location_id is not specified.","required":false,"example":"Office State.","schema":{"type":"string","minLength":1}},{"name":"office_zip_code","in":"query","description":"Office zip code. Only applies if location_id is not specified.","required":false,"example":"Office zip code.","schema":{"type":"string","minLength":1}},{"name":"office_phone_number","in":"query","description":"Office Phone Number. Only applies if location_id is not specified.","required":false,"example":"Office Phone Number.","schema":{"type":"string","minLength":1}},{"name":"gender","in":"query","description":"The sex of the physician. Only applies if provider_id is not specified.","required":false,"example":"The sex of the physician.","schema":{"type":"string","minLength":1}},{"name":"language","in":"query","description":"The language spoken by physician. Only applies if provider_id is not specified.","required":false,"example":"The language spoken by physician.","schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","required":["total","physicians"],"properties":{"id":{"type":"integer","format":"int32","description":"The record id."},"total":{"type":"integer","format":"int32","description":"Total count of the physicians in the list."},"physicians":{"description":"List of physicians that match the query.","type":"array","items":{"description":"Physician DTO.","type":"object","required":["physician_id","physician_name","phone_number","gender","language","photo_url","specialty","specialty_id","address","address_id","accept_new_patient"],"properties":{"id":{"type":"integer","format":"int32","description":"The record id of the physician."},"physician_id":{"type":"string","minLength":1,"description":"The physician external id."},"physician_name":{"type":"string","minLength":1,"description":"The physician name."},"photo_url":{"type":"string","minLength":1,"description":"The provider photo url, only URL starting with 'https://' and ending with '.jpg' are supported, and the field only returns intermediate paths, e.g. 'https://test/A.jpg' returns 'test/A', if this field doesn't exist, it returns an empty string."},"gender":{"type":"string","minLength":1,"description":"The sex of the physician, if this field doesn't exist, it returns an empty string."},"language":{"type":"string","minLength":1,"description":"The language spoken by physician, if this field doesn't exist, it returns an empty string."},"phone_number":{"type":"string","minLength":1,"description":"The phone number that can be used to contact the physician."},"specialty":{"type":"string","minLength":1,"description":"The specialty of the physician."},"specialty_id":{"type":"string","minLength":1,"description":"The specialty id of the physician."},"address":{"type":"string","minLength":1,"description":"The address of the physician."},"address_id":{"type":"string","minLength":1,"description":"The address id of the physician."},"accept_new_patient":{"type":"boolean","description":"If the physician is able to accept new patient."}}}}}},"example":{"total":1,"physicians":[{"id":434,"physician_id":123,"physician_name":"Dr. Luís de Camões","photo_url":"https://test/A.jpg","gender":"Male","language":"English","phone_number":"123-123-123","specialty":"Cardiology","specialty_id":545,"address":"123 Main St","address_id":774,"accept_new_patient":true}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484010","message":"Invalid JWT token."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484030","message":"Required scopes are missing."}}}}}}},"/voicebiometrics/contacts/{contact_id}/enrollment":{"delete":{"tags":["Voice Biometrics"],"summary":"Deletes the contact's enrollment information","operationId":"deleteEnrollment","security":[{"GA":["voicebiometrics-enroll:write"]}],"parameters":[{"name":"contact_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1320001","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1320002","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1320003","message":"Resource not found."}}}}}},"put":{"tags":["Voice Biometrics"],"summary":"Creates a new contact enrollment","operationId":"createEnrollment","security":[{"GA":["voicebiometrics-enroll:write"]}],"parameters":[{"name":"contact_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["phrase_id"],"type":"object","properties":{"phrase_id":{"type":"number","format":"int32"}}},"example":{"phrase_id":0}}}},"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1320001","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1320002","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1320003","message":"Resource not found."}}}}}}},"/voicebiometrics/contacts/{contact_id}/consent":{"get":{"tags":["Voice Biometrics"],"summary":"Provides a contact's consent for voice biometrics authentication","operationId":"getConsent","description":"Returns a contact consent state for voice biometrics authentication","security":[{"GA":["voicebiometrics-consent:read"]}],"parameters":[{"name":"contact_id","in":"path","required":true,"schema":{"type":"string"},"example":"c408ca815d1b1cc6a24ba"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"required":["status"],"type":"object","description":"The consent payload","properties":{"status":{"type":"string","description":"The consent status","enum":["NO_CONSENT","CONSENTED","DELETED","REFUSED"]},"consented_at":{"type":"string","description":"Consent date.","format":"date-time"},"_links":{"properties":{"self":{"description":"The current link.","properties":{"href":{"description":"The hypertext reference describing this link.","example":"https://voicebiometrics-backend.talkdesk.org/voicebiometrics-backend/page","type":"string"}},"type":"object"}},"type":"object"}}},"example":{"status":"CONSENTED","consented_at":"2022-09-13T15:01:21.352Z","_links":{"self":{"href":"https://voicebiometrics-backend.talkdesk.org/voicebiometrics/contacts/+351123456789/consent"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1320001","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1320002","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1320003","message":"Resource not found."}}}}}},"put":{"tags":["Voice Biometrics"],"summary":"Changes a contact's consent for voice biometrics authentication","description":"Sets a contact consent state for voice biometrics authentication","operationId":"editConsent","security":[{"GA":["voicebiometrics-consent:write"]}],"parameters":[{"name":"contact_id","in":"path","required":true,"schema":{"type":"string"},"example":"c408ca815d1b1cc6a24ba"}],"requestBody":{"content":{"application/json":{"schema":{"required":["status"],"type":"object","description":"The consent payload","properties":{"status":{"type":"string","description":"The consent status","enum":["NO_CONSENT","CONSENTED","REFUSED"]}}},"example":{"status":"CONSENTED"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"required":["status"],"type":"object","description":"The consent payload","properties":{"status":{"type":"string","description":"The consent status","enum":["NO_CONSENT","CONSENTED","DELETED","REFUSED"]}}},"example":{"status":"CONSENTED"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"required":["status"],"type":"object","description":"The consent payload","properties":{"status":{"type":"string","description":"The consent status","enum":["NO_CONSENT","CONSENTED","DELETED","REFUSED"]}}},"example":{"status":"CONSENTED"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1320000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1320001","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1320002","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1320003","message":"Resource not found."}}}}}}},"/wfm/timeseries/history_imports":{"post":{"description":"Returns the URL for tracking import status in the Content-Location header","operationId":"uploadHistoryImport","requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"abandoned_volume":{"maximum":2147483647,"minimum":0,"type":"integer"},"occupancy":{"type":"number"},"timezone":{"type":"string"},"average_time_to_abandon":{"type":"number"},"file_name":{"type":"string"},"header_row":{"maximum":2147483647,"minimum":0,"type":"integer"},"average_handle_time":{"type":"number"},"service_level_percentage":{"type":"number"},"average_wait_time":{"type":"number"},"staffing":{"type":"number"},"interaction_volume_offered":{"maximum":2147483647,"minimum":0,"type":"integer"},"csv_file":{"format":"binary","type":"string"},"trigger_scheduler_job":{"default":false,"description":"Instruct the service to trigger the scheduler job on a successful file import","example":true,"type":"boolean"},"backlog":{"maximum":2147483647,"minimum":0,"type":"integer"},"granularity":{"maximum":2147483647,"minimum":0,"type":"integer"},"file_format":{"enum":["WFM","ZENDESK"],"type":"string"},"date_format":{"description":"The date format used in the file","enum":["YYYY_MM_DD","YYYYMMDD","MM_DD_YYYY","MM_DD_YY","DD_MM_YYYY"],"default":"DD_MM_YYYY","example":"DD_MM_YYYY","type":"string"}},"type":"object"},"example":{"file_name":"wfm-history-import.csv","timezone":"Europe/Lisbon","file_format":"WFM","date_format":"DD_MM_YYYY","granularity":15,"header_row":1,"trigger_scheduler_job":false}}},"description":"The file to upload the History Import","required":true},"responses":{"202":{"content":{"application/json":{}},"description":"The History Import","headers":{"Content-Location":{"description":"Information about the location of a newly created resource","schema":{"type":"string"},"example":"https://api.talkdeskapp.com/wfm/timeseries/history_imports/8ae6a6b17c6fcc00017c6fddd2c00001"}}},"401":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0560410","message":"Invalid authentication."}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0560611","description":"Policies denied for account","message":"Invalid permissions."}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0560604","description":"No import history found.","message":"Internal Server Error"}}},"description":"Not Found"},"415":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0560420","description":"Unsupported Media Type.","message":"Unsupported Media Type"}}},"description":"Unsupported Media Type"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0560500","description":"An unknown error has occurred.","message":"Internal Server Error"}}},"description":"Internal Server Error"}},"security":[{"EarlyAccess":["wfm-public:write"]}],"summary":"History Import from CSV file","tags":["WFM"]}},"/wfm/timeseries/history_imports/{id}":{"get":{"description":"Find History Import by Id","operationId":"GetHistoryImport","parameters":[{"description":"Id of the History Import that needs to be fetched","example":"92AF91D0759B11E989D9833F6973C849","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"description":"All data belonging to a History Import","properties":{"id":{"description":"The id of the History Import","example":"92AF91D0759B11E989D9833F6973C849","type":"string"},"status":{"description":"The status of the History Import","enum":["UPLOADED","PROCESSING","IMPORTED","IMPORTED_WITH_ERRORS","ERROR"],"type":"string"}},"type":"object"},"example":{"id":"92AF9D0759B11E989D9833F6973C849","status":"UPLOADED"}}},"description":"The History Import"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0560410","message":"Invalid authentication."}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0560611","description":"Policies denied for account","message":"Invalid permissions."}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0560404","message":"Not found History import with id: 402881ce7c751ab3017c751aedd200001"}}},"description":"History Import not found"}},"security":[{"EarlyAccess":["wfm-public:read"]}],"summary":"Get History Import","tags":["WFM"]}},"/wfm/aion/externals/schedules/time-offs/{id}":{"delete":{"x-namespace":"/wfm/aion","description":"Deletes a Time Off","operationId":"DeleteTimeOffAionExternal","parameters":[{"description":"Id of the Time Off that needs to be deleted","example":"2e25c3a4c1604155ab475293767aaee6","in":"path","name":"id","required":true,"schema":{"description":"UUId","maxLength":255,"minLength":1,"type":"string"}}],"responses":{"204":{"description":"Time Off successfully deleted"},"401":{"content":{"application/json":{"example":{"code":"1580005","message":"Invalid authentication."},"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"example":{"code":"1580006","message":"Invalid permissions."},"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"code":"1580007","message":"Resource not found."},"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}}}},"description":"Time Off not found"}},"security":[{"GA":["wfm-aion-public:write"]}],"summary":"A time off is deleted by an external service","tags":["WFM-Aion"]},"patch":{"description":"Updates a Time Off.","operationId":"UpdateTimeOffAionExternal","parameters":[{"description":"Id of the Time Off that needs to be updated","example":"2e25c3a4c1604155ab475293767aaee6","in":"path","name":"id","required":true,"schema":{"description":"UUId","maxLength":255,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"description":"TimeOff item has information on the time off event like start, end, description to update an existing time off.","properties":{"description":{"description":"Description or comment associated with the time-off.","example":"Take some rest","maxLength":255,"type":"string"},"end_at":{"description":"End date and time for time off in UTC.","example":"2019-06-22T01:29:31Z","format":"date-time","maxLength":20,"minLength":20,"type":"string"},"start_at":{"description":"Start date and time for time off in UTC.","example":"2019-06-22T01:14:31Z","format":"date-time","maxLength":20,"minLength":20,"type":"string"}},"readOnly":true,"required":["start_at","end_at"],"type":"object"}}},"description":"The existing Time Off to update","required":true},"responses":{"204":{"description":"Time Off successfully updated"},"400":{"content":{"application/json":{"example":{"code":"1580001","message":"Invalid fields."},"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}}}},"description":"Validation errors were found in the submitted data."},"401":{"content":{"application/json":{"example":{"code":"1580005","message":"Invalid authentication."},"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"example":{"code":"1580006","message":"Invalid permissions."},"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"code":"1580007","message":"Resource not found"},"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}}}},"description":"Time Off not found"}},"security":[{"GA":["wfm-aion-public:write"]}],"summary":"A time off is updated by an external service","tags":["WFM-Aion"]}},"/wfm/aion/externals/schedules/time-offs":{"post":{"x-namespace":"/wfm/aion","description":"Creates a TimeOff and returns the newly created TimeOff item","operationId":"CreateTimeOffAionExternal","requestBody":{"content":{"application/json":{"schema":{"description":"Has information on the time off event like start, end, event type to create new time off.","properties":{"agent_email":{"description":"Email of the agent that will be on time off","example":"agent.email@talkdesk.com","maxLength":255,"minLength":1,"type":"string"},"description":{"description":"Description or comment associated with the time-off.","example":"Take some rest","maxLength":255,"type":"string"},"end_at":{"description":"End date and time for time off in UTC.","example":"2019-06-22T01:29:31Z","format":"date-time","maxLength":20,"minLength":20,"type":"string"},"event_type_name":{"description":"Name of the event type that will be associated with the time off. The event type with that name must be previously created in WFM and must be of type TIME OFF.","example":"Medical leave.","maxLength":255,"minLength":1,"type":"string"},"start_at":{"description":"Start date and time for time off in UTC.","example":"2019-06-22T01:14:31Z","format":"date-time","maxLength":20,"minLength":20,"type":"string"}},"readOnly":true,"required":["agent_email","start_at","end_at","event_type_name"],"type":"object"}}},"description":"The Time Off to create","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"description":"TimeOff item has information on the time off event like start, end, event type, etc.","properties":{"agent_email":{"description":"Email of the agent that will be on time off","example":"agent.email@talkdesk.com","maxLength":255,"minLength":1,"type":"string"},"description":{"description":"Description or comment associated with the time-off.","example":"Take some rest","maxLength":255,"minLength":0,"type":"string"},"end_at":{"description":"End date and time for time off in UTC.","example":"2019-06-22T01:29:31.000Z","format":"date-time","maxLength":20,"minLength":20,"type":"string"},"event_type_name":{"description":"Name of the event type that will be associated with the time off. The event type with that name must be previously created in WFM and must be of type TIME OFF.","example":"Medical leave.","maxLength":255,"minLength":1,"type":"string"},"id":{"description":"The id of the time off.","example":"92af91d0-759b-11e9-89d9-833f7653c849","maxLength":255,"minLength":1,"type":"string"},"start_at":{"description":"Start date and time for time off in UTC.","example":"2019-06-22T01:14:31.000Z","format":"date-time","maxLength":20,"minLength":20,"type":"string"}},"readOnly":true,"required":["id","start_at","end_at","event_type_name"],"type":"object"}}},"description":"The payload was accepted by the server and stored in the DB successfully","headers":{"Location":{"description":"Information about the location of a newly created resource","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"code":"1580001","message":"Invalid fields."},"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}}}},"description":"Validation errors were found in the submitted data."},"401":{"content":{"application/json":{"example":{"code":"1580005","message":"Invalid authentication."},"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"example":{"code":"1580006","message":"Invalid permissions."},"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}}}},"description":"Forbidden"}},"security":[{"GA":["wfm-aion-public:write"]}],"summary":"A time off is created by an external service","tags":["WFM-Aion"]}},"/wfm/request-management/externals/time-offs/balances":{"put":{"x-namespace":"/wfm/request-management","description":"Import time off balance.","operationId":"PutTimeOffBalanceExternal","requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"The request body of time off balances","properties":{"time_off_balances":{"type":"array","description":"The list of time off balance","items":{"properties":{"agent_email":{"description":"The email of the user","type":"string","example":"mars.xiao@talkdesk.com"},"event_type_name":{"description":"Defines part of the Time off type.","type":"string","example":"annual"},"balance":{"description":"The balance of the time off type","type":"number","example":1200,"minimum":1,"maximum":50000}}},"required":["agent_email","event_type_name"]}},"required":["time_off_balances"]},"example":{"time_off_balances":[{"agent_email":"mars.xiao@talkdesk.com","event_type_name":"annual","balance":1200},{"agent_email":"jeff.ke@talkdesk.com","event_type_name":"break","balance":200}]}}},"description":"The time off balance","required":true},"responses":{"200":{"description":"Time Off balance successfully updated","content":{"application/json":{"schema":{"type":"object","description":"The list of time off balance response","properties":{"time_off_balances":{"type":"array","description":"The time off balance","items":{"type":"object","properties":{"id":{"description":"The ID of the time off balance","type":"string","maxLength":36},"agent_email":{"description":"The email of the user","type":"string"},"balance":{"description":"The balance of the time off type","type":"number","minimum":1,"maximum":50000},"event_type_name":{"description":"Defines part of the Time off type.","type":"string"}}},"required":["balance","event_type_name"]}},"required":["id","agent_email"]},"example":{"time_off_balances":[{"id":"8858c834481d4a028176cffc02c50350","agent_email":"mars.xiao@talkdesk.com","event_type_name":"annual","balance":1200},{"id":"028176cffc034481d4ac5035028858c8","agent_email":"jeff.ke@talkdesk.com","event_type_name":"break","balance":200}]}}}},"400":{"content":{"application/json":{"example":{"code":"1580001","message":"Invalid fields."},"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}}}},"description":"Validation errors were found in the submitted data."},"401":{"content":{"application/json":{"example":{"code":"1580005","message":"Invalid authentication."},"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"example":{"code":"1580006","message":"Invalid permissions."},"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"code":"1580007","message":"Resource not found."},"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}}}},"description":"Time Off Balance not found"}},"security":[{"GA":["wfm-request-management-public:write"]}],"summary":"create or update the Time off balance.","tags":["WFM-Request-Management"]}},"/wfm/request-management/externals/time-offs/balances/{id}":{"delete":{"x-namespace":"/wfm/request-management","description":"Deletes a time off balance","operationId":"DeleteTimeOffBalanceExternal","parameters":[{"description":"Id of the Time Off Balance that needs to be deleted","example":"2e25c3a4c1604155ab475293767aaee6","in":"path","name":"id","required":true,"schema":{"description":"UUId","maxLength":255,"minLength":1,"type":"string"}}],"responses":{"200":{"description":"Time Off balance successfully deleted"},"401":{"content":{"application/json":{"example":{"code":"1580005","message":"Invalid authentication."},"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"example":{"code":"1580006","message":"Invalid permissions."},"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"code":"1580007","message":"Resource not found."},"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}}}},"description":"Time Off Balance not found"}},"security":[{"GA":["wfm-request-management-public:write"]}],"summary":"A time off balance is deleted by an external service","tags":["WFM-Request-Management"]}},"/industries-activities/activities/{activity_id}":{"patch":{"tags":["Industries Activity API"],"description":"Patch the activity","summary":"Patch the activity","security":[{"EarlyAccess":["industries-activity:write"]}],"parameters":[{"name":"activity_id","in":"path","required":true,"schema":{"type":"string","example":"activity id 1"}}],"requestBody":{"description":"JSON Patch specification","required":true,"content":{"application/json-patch+json":{"schema":{"type":"array","items":{"type":"object","required":["op"],"properties":{"op":{"type":"string","description":"Operation to apply","example":"add","enum":["add","remove","replace","move","copy","test"]},"path":{"type":"string","description":"Property to which the operation should be applied","example":"/tags/-"},"value":{"description":"Value to use when applying the operation","example":"tag"},"from":{"type":"string","description":"Property from which the value should be copied/moved (depending on the operation)","example":"/contact_id"}}}},"example":[{"op":"add","path":"/tags/-","value":"new_tag"},{"op":"replace","path":"/user_name","value":"John Doe"}]}}},"responses":{"200":{"description":"The activity with the provided id was modified.","content":{"application/json":{"schema":{"required":["id","account_id","activity_type_id","direction","started_at"],"type":"object","properties":{"id":{"type":"string"},"account_id":{"type":"string"},"activity_type_id":{"type":"string"},"contact_id":{"type":"string"},"contact_phone_number":{"type":"string"},"duration":{"type":"string","description":"The duration of the activity. Represented by an ISO 8601 duration."},"direction":{"type":"string","enum":["IN","OUT"]},"interaction_id":{"type":"string"},"ring_groups":{"type":"array","items":{"type":"string"}},"started_at":{"type":"string","format":"date-time"},"tags":{"type":"array","items":{"type":"string"}},"user_id":{"type":"string"},"user_name":{"type":"string"},"data":{"type":"object"},"events":{"type":"array","description":"List of events","items":{"required":["id","event_type_id","occurred_at"],"type":"object","properties":{"id":{"type":"string"},"event_type_id":{"type":"string"},"occurred_at":{"type":"string","format":"date-time"},"data":{"type":"object"}}}},"external_integration_name":{"type":"string"},"external_id":{"type":"string"}}},"example":{"id":"act123","account_id":"acc123","activity_type_id":"new_conversation","contact_id":"contact123","contact_phone_number":"+14155550175","duration":"PT12S","direction":"IN","interaction_id":"int123","ring_groups":["agents"],"started_at":"2019-12-30T14:26:01Z","tags":["conversation","facebook"],"user_id":"agent123","data":{"user_name":"new.user","network":"facebook"},"events":[{"id":"123","event_type_id":"new_message","occurred_at":"2019-12-30T14:26:01Z"}],"external_integration_name":"ext_int_name","external_id":"ext_id"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1734000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1734010","message":"Invalid JWT token."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1734030","message":"Required scopes are missing."}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1734040","message":"Resource not found."}}}},"405":{"description":"Method not supported","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1734050","message":"Request method not supported."}}}}}}},"/industries-activities/activities":{"post":{"tags":["Industries Activity API"],"description":"Create an activity for the given activity type.","summary":"Create an activity for the given activity type.","security":[{"EarlyAccess":["industries-activity:write"]}],"responses":{"202":{"description":"The activity was sent to be created.","content":{"application/json":{"schema":{"required":["id","account_id","activity_type_id","direction","started_at"],"type":"object","properties":{"id":{"type":"string"},"account_id":{"type":"string"},"activity_type_id":{"type":"string"},"contact_id":{"type":"string"},"contact_phone_number":{"type":"string"},"duration":{"type":"string","description":"The duration of the activity. Represented by an ISO 8601 duration."},"direction":{"type":"string","enum":["IN","OUT"]},"interaction_id":{"type":"string"},"ring_groups":{"type":"array","items":{"type":"string"}},"started_at":{"type":"string","format":"date-time"},"tags":{"type":"array","items":{"type":"string"}},"user_id":{"type":"string"},"user_name":{"type":"string"},"data":{"type":"object"},"events":{"type":"array","description":"List of events","items":{"required":["id","event_type_id","occurred_at"],"type":"object","properties":{"id":{"type":"string"},"event_type_id":{"type":"string"},"occurred_at":{"type":"string","format":"date-time"},"data":{"type":"object"}}}},"external_integration_name":{"type":"string"},"external_id":{"type":"string"}}},"example":{"id":"act123","account_id":"acc123","activity_type_id":"new_conversation","contact_id":"contact123","contact_phone_number":"+14155550175","duration":"PT12S","direction":"IN","interaction_id":"int123","ring_groups":["agents"],"started_at":"2019-12-30T14:26:01Z","tags":["conversation","facebook"],"user_id":"agent123","data":{"user_name":"new.user","network":"facebook"},"events":[{"id":"123","event_type_id":"new_message","occurred_at":"2019-12-30T14:26:01Z"}],"external_integration_name":"ext_int_name","external_id":"ext_id"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1734000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1734010","message":"Invalid JWT token."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1734030","message":"Required scopes are missing."}}}},"405":{"description":"Method not supported","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1734050","message":"Request method not supported."}}}}},"requestBody":{"description":"Activity properties","required":true,"content":{"application/json":{"schema":{"required":["activity_type_id","direction","started_at"],"type":"object","properties":{"activity_type_id":{"type":"string"},"contact_id":{"type":"string"},"contact_phone_number":{"type":"string"},"duration":{"type":"string","description":"The duration of the activity. Represented by an ISO 8601 duration."},"direction":{"type":"string","enum":["IN","OUT"]},"interaction_id":{"type":"string"},"ring_groups":{"type":"array","items":{"type":"string"}},"started_at":{"type":"string","format":"date-time"},"tags":{"type":"array","items":{"type":"string"}},"user_id":{"type":"string"},"user_name":{"type":"string"},"data":{"type":"object"},"events":{"type":"array","description":"List of events","items":{"required":["id","event_type_id","occurred_at"],"type":"object","properties":{"id":{"type":"string"},"event_type_id":{"type":"string"},"occurred_at":{"type":"string","format":"date-time"},"data":{"type":"object"}}}},"external_integration_name":{"type":"string"},"external_id":{"type":"string"}}},"example":{"activity_type_id":"new_conversation","contact_id":"contact123","contact_phone_number":"+14155550175","duration":"PT12S","direction":"IN","interaction_id":"int123","ring_groups":["agents"],"started_at":"2019-12-30T14:26:01Z","tags":["conversation","facebook"],"user_id":"agent123","data":{"user_name":"new.user","network":"facebook"},"events":[{"id":"123","event_type_id":"new_message","occurred_at":"2019-12-30T14:26:01Z"}],"external_integration_name":"ext_int_name","external_id":"ext_id"}}}}}},"/industries-activities/activities/{activity_id}/events":{"post":{"tags":["Industries Activity API"],"description":"Add an event to an activity for the given event type.","summary":"Add an event to an activity for the given event type.","security":[{"EarlyAccess":["industries-activity:write"]}],"parameters":[{"name":"activity_id","in":"path","required":true,"schema":{"type":"string","example":"activity id 1"}}],"responses":{"202":{"description":"The event was sent to be created.","content":{"application/json":{"schema":{"required":["id","event_type_id","occurred_at"],"type":"object","properties":{"id":{"type":"string"},"event_type_id":{"type":"string"},"occurred_at":{"type":"string","format":"date-time"},"data":{"type":"object"}}},"example":{"id":"123","event_type_id":"new_message","occurred_at":"2019-12-30T14:26:01Z"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1734000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1734010","message":"Invalid JWT token."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1734030","message":"Required scopes are missing."}}}},"405":{"description":"Method not supported","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1734050","message":"Request method not supported."}}}}},"requestBody":{"description":"Event properties","required":true,"content":{"application/json":{"schema":{"required":["event_type_id","occurred_at"],"type":"object","properties":{"id":{"type":"string"},"event_type_id":{"type":"string"},"occurred_at":{"type":"string","format":"date-time"},"data":{"type":"object"}}},"example":{"event_type_id":"new_message","occurred_at":"2019-12-30T14:26:01Z"}}}}}},"/industries-settings/interaction-configurations":{"put":{"tags":["Industries Settings"],"summary":"Create an interaction specific configuration which can be used for all the requests of the interaction ID.","description":"Create an interaction specific configuration which can be used for all the requests of the interaction ID.","operationId":"createInteractionConfiguration","security":[{"GA":["industries-settings-public:write"]}],"requestBody":{"content":{"application/json":{"schema":{"required":["service","interaction_id","json"],"type":"object","description":"The request body for creating a mapping","properties":{"service":{"type":"string","description":"The name of the service","minLength":1,"maxLength":256,"example":"hls-providers-integrations-ellkay"},"interaction_id":{"type":"string","description":"The interaction ID","minLength":1,"maxLength":256},"json":{"type":"string","description":"The defined json string","minLength":2,"maxLength":2147483647}}},"example":{"service":"hls-providers-integrations-ellkay","interaction_id":"2d3dd6394ffdbffad79c","json":"{\"site_service_key\": \"102865901651265016512\"}"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","description":"The response body for creating a mapping","properties":{"json":{"type":"string","description":"The defined json string, it could be any json string defined in the request body","example":"{\"site_service_key\": \"102865901651265016512\"}"}}},"example":{"site_service_key":"102865901651265016512"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3444000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"3444010","message":"Invalid JWT."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3444030","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3444040","message":"Resource not found."}}}}}}},"/industries/contexts/{context_id}":{"get":{"tags":["Industries Contexts"],"summary":"Get context","description":"Returns all key/value pairs stored for the given context.","operationId":"getIndustriesContext","security":[{"GA":["industries-contexts:read"]}],"parameters":[{"name":"context_id","in":"path","required":true,"description":"Context identifier.","schema":{"type":"string","minLength":1,"maxLength":256}}],"responses":{"200":{"description":"Context values.","content":{"application/json":{"schema":{"type":"object","description":"Map of context values, keyed by id.","additionalProperties":{"type":"string"},"example":{"customer_id":"12345","insurance_plan":"gold"}},"example":{"customer_id":"12345","insurance_plan":"gold"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3444000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"3444010","message":"Invalid JWT."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3444030","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3444040","message":"Resource not found."}}}}}},"delete":{"tags":["Industries Contexts"],"summary":"Delete context","description":"Deletes all values stored for the given context.","operationId":"deleteIndustriesContext","security":[{"GA":["industries-contexts:write"]}],"parameters":[{"name":"context_id","in":"path","required":true,"description":"Context identifier.","schema":{"type":"string","minLength":1,"maxLength":256}}],"responses":{"204":{"description":"Context successfully deleted."},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3444000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"3444010","message":"Invalid JWT."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3444030","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3444040","message":"Resource not found."}}}}}}},"/industries/contexts/{context_id}/values":{"post":{"tags":["Industries Contexts"],"summary":"Add context value","description":"Adds a new key/value pair to the given context.","operationId":"addIndustriesContextValue","security":[{"GA":["industries-contexts:write"]}],"parameters":[{"name":"context_id","in":"path","required":true,"description":"Context identifier.","schema":{"type":"string","minLength":1,"maxLength":256}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"A key/value pair stored in a context.","required":["id","value"],"properties":{"id":{"type":"string","description":"The key identifier.","minLength":1,"maxLength":250,"example":"customer_id"},"value":{"type":"string","description":"The stored value.","minLength":1,"maxLength":1048576,"example":"12345"}}},"example":{"id":"customer_id","value":"12345"}}}},"responses":{"201":{"description":"Value successfully created.","content":{"application/json":{"schema":{"type":"object","description":"A key/value pair stored in a context.","required":["id","value"],"properties":{"id":{"type":"string","description":"The key identifier.","minLength":1,"maxLength":250,"example":"customer_id"},"value":{"type":"string","description":"The stored value.","minLength":1,"maxLength":1048576,"example":"12345"}}},"example":{"id":"customer_id","value":"12345"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3444000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"3444010","message":"Invalid JWT."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3444030","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3444040","message":"Resource not found."}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3444090","message":"Conflict."}}}}}}},"/industries/contexts/{context_id}/values/{value_id}":{"delete":{"tags":["Industries Contexts"],"summary":"Delete context value","description":"Deletes a key/value pair from the given context.","operationId":"deleteIndustriesContextValue","security":[{"GA":["industries-contexts:write"]}],"parameters":[{"name":"context_id","in":"path","required":true,"description":"Context identifier.","schema":{"type":"string","minLength":1,"maxLength":256}},{"name":"value_id","in":"path","required":true,"description":"Key to delete.","schema":{"type":"string","minLength":1,"maxLength":250}}],"responses":{"204":{"description":"Value successfully deleted."},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3444000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"3444010","message":"Invalid JWT."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3444030","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3444040","message":"Resource not found."}}}}}},"put":{"tags":["Industries Contexts"],"summary":"Update context value","description":"Creates or updates the given key/value pair in the context.","operationId":"updateIndustriesContextValue","security":[{"GA":["industries-contexts:write"]}],"parameters":[{"name":"context_id","in":"path","required":true,"description":"Context identifier.","schema":{"type":"string","minLength":1,"maxLength":256}},{"name":"value_id","in":"path","required":true,"description":"Key to delete.","schema":{"type":"string","minLength":1,"maxLength":250}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"The updated context value.","required":["value"],"properties":{"value":{"type":"string","description":"The stored value.","minLength":1,"maxLength":1048576,"example":"12345"}}},"example":{"insurance_plan":"gold"}}}},"responses":{"200":{"description":"Value successfully updated.","content":{"application/json":{"schema":{"type":"object","description":"A key/value pair stored in a context.","required":["id","value"],"properties":{"id":{"type":"string","description":"The key identifier.","minLength":1,"maxLength":250,"example":"customer_id"},"value":{"type":"string","description":"The stored value.","minLength":1,"maxLength":1048576,"example":"12345"}}},"example":{"id":"customer_id","value":"12345"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3444000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"3444010","message":"Invalid JWT."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3444030","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3444040","message":"Resource not found."}}}}}}},"/builder/functions/executions":{"post":{"description":"Executes the code and the arguments given as parameters and returns the computed result.","x-namespace":"builder","security":[{"EarlyAccess":["functions:execute"]}],"tags":["Functions"],"parameters":[],"requestBody":{"description":"Function to execute","required":true,"content":{"application/json":{"schema":{"type":"object","required":["function_body","function_args"],"properties":{"function_body":{"type":"string"},"function_args":{"type":"object"}}},"example":{"function_body":"function space_code(args) { const { code } = args; const spacedCode = code.split(';').join(' '); return { spacedCode }; }","function_args":{"code":"abc"}}}}},"responses":{"200":{"description":"Function execution result","content":{"application/json":{"schema":{"type":"object"},"example":{"spacedCode":"a b c"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Example 0":{"value":{"code":"0590018","message":"Function body must not be empty/null"}},"Example 1":{"value":{"code":"0590013","message":"Error executing function"}},"Example 2":{"value":{"code":"0590504","message":"Function execution timeout."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0590401","message":"Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0590403","message":"Forbidden"}}}}}}},"/builder/functions/{function_id}/executions":{"post":{"description":"Executes an existent function with the arguments given as parameters and returns the computed result.","x-namespace":"builder","security":[{"EarlyAccess":["functions:execute"]}],"tags":["Functions"],"parameters":[{"name":"function_id","in":"path","description":"The Function ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Arguments for the function to be executed with","required":false,"content":{"application/json":{"schema":{"type":"object","required":["function_args"],"properties":{"function_args":{"type":"object"}}},"example":{"function_args":{"code":"abc"}}}}},"responses":{"200":{"description":"Function execution result","content":{"application/json":{"schema":{"type":"object"},"example":{"spacedCode":"a b c"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Example 0":{"value":{"code":"0590018","message":"Function body must not be empty/null"}},"Example 1":{"value":{"code":"0590013","message":"Error executing function"}},"Example 2":{"value":{"code":"0590504","message":"Function execution timeout."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0590401","message":"Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0590403","message":"Forbidden"}}}},"404":{"description":"Function not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0590004","message":"Function not found"}}}}}}},"/phone-labels":{"get":{"summary":"List phone labels configured for the given account","x-namespace":"/phone-labels","description":"Lists current phone labels associated with given account. Default labels are returned unless there are custom labels defined, which will be returned instead.","tags":["Phone Labels"],"security":[{"EarlyAccess":["record-lists:manage"]}],"parameters":[{"name":"page","in":"query","schema":{"type":"integer","default":1,"minimum":1}},{"name":"per_page","in":"query","schema":{"type":"integer","default":10,"minimum":1,"maximum":100}}],"responses":{"200":{"description":"List of phone labels that can be used in campaigns by account","content":{"application/json":{"schema":{"description":"List Phone Labels.","type":"object","properties":{"total":{"type":"integer"},"count":{"type":"integer"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string"}}}}},"_embedded":{"type":"object","properties":{"labels":{"type":"array","description":"Phone Labels per each phone type.","items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"type":{"type":"string","minLength":1},"name":{"type":"string","minLength":1,"maxLength":35},"default_name":{"type":"string","minLength":1}}}}}}},"required":["total","count","page","per_page","_embedded","_links"]},"example":{"total":6,"count":6,"page":1,"per_page":10,"total_pages":1,"_links":{"self":{"href":"https://api.talkdeskapp.com/phone-labels"}},"_embedded":{"labels":[{"id":"1","type":"HOME","default_name":"Home","name":"new name"},{"id":"2","type":"MOBILE","default_name":"Mobile","name":"Mobile PT"},{"id":"3","type":"OFFICE","default_name":"Office","name":"Office NY"},{"id":"4","type":"EXTRA_1","default_name":"Extra 1","name":"Extra - mobile"},{"id":"5","type":"EXTRA_2","default_name":"Extra 2","name":"Extra - Office LA"},{"id":"6","type":"EXTRA_3","default_name":"Extra 3","name":"Extra 3"}]}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530900","message":"Errors were found in the submitted data."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530901","message":"Missing or invalid authentication token."}}}},"403":{"description":"Forbidden access","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530902","message":"Insufficient scopes for the requested operation."}}}}}},"put":{"summary":"Updates custom phone labels for the given account","x-namespace":"/phone-labels","description":"Updates custom phone labels for the given account","tags":["Phone Labels"],"security":[{"EarlyAccess":["record-lists:manage"]}],"requestBody":{"description":"Every Phone Labels are required. Duplicates are not allowed.","required":true,"content":{"application/json":{"schema":{"description":"Change Phone Label for the account.","properties":{"labels":{"type":"array","description":"Group of Phone Labels","items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"type":{"type":"string","minLength":1},"default_name":{"type":"string","minLength":1},"name":{"type":"string","minLength":1,"maxLength":35}},"required":["id","type","name","default_name"]}}},"required":["labels"],"type":"object"},"example":{"labels":[{"id":1,"type":"HOME","default_name":"Home","name":"new name"},{"id":2,"type":"MOBILE","default_name":"Mobile","name":"Mobile PT"},{"id":3,"type":"OFFICE","default_name":"Office","name":"Office NY"},{"id":4,"type":"EXTRA_1","default_name":"Extra 1","name":"Extra - mobile"},{"id":5,"type":"EXTRA_2","default_name":"Extra 2","name":"Extra - Office LA"},{"id":6,"type":"EXTRA_3","default_name":"Extra 3","name":"Extra 3"}]}}}},"responses":{"200":{"description":"List of phone labels that can be used for outbound by the agent","content":{"application/json":{"schema":{"description":"List Phone Labels.","type":"object","properties":{"total":{"type":"integer"},"count":{"type":"integer"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string"}}}}},"_embedded":{"type":"object","properties":{"labels":{"type":"array","description":"Phone Labels per each phone type.","items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"type":{"type":"string","minLength":1},"name":{"type":"string","minLength":1,"maxLength":35},"default_name":{"type":"string","minLength":1}}}}}}},"required":["total","count","page","per_page","_embedded","_links"]},"example":{"total":6,"count":6,"page":1,"per_page":10,"total_pages":1,"_links":{"self":{"href":"https://api.talkdeskapp.com/phone-labels"}},"_embedded":{"labels":[{"id":"1","type":"HOME","default_name":"Home","name":"new name"},{"id":"2","type":"MOBILE","default_name":"Mobile","name":"Mobile PT"},{"id":"3","type":"OFFICE","default_name":"Office","name":"Office NY"},{"id":"4","type":"EXTRA_1","default_name":"Extra 1","name":"Extra - mobile"},{"id":"5","type":"EXTRA_2","default_name":"Extra 2","name":"Extra - Office LA"},{"id":"6","type":"EXTRA_3","default_name":"Extra 3","name":"Extra 3"}]}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530900","message":"Errors were found in the submitted data."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530901","message":"Missing or invalid authentication token."}}}},"403":{"description":"Forbidden access","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530902","message":"Insufficient scopes for the requested operation."}}}}}}},"/cm/core/va/cases":{"post":{"tags":["Cases"],"summary":"Creating a case","description":"Creating a case.","operationId":"CreatingACase","security":[{"GA":["cases-public:write"]}],"requestBody":{"description":"The case to be created.","required":true,"content":{"application/json":{"schema":{"type":"object","required":["title","description"],"properties":{"title":{"type":"string","description":"Case subject on the interface."},"description":{"type":"string","description":"When a contact submits a support request via email, the body of the email request is used as the description. The description becomes the first comment in the case."},"parent_id":{"type":"string","description":"Case id of parent case."},"owner_id":{"type":"string","description":"Assignee id.","minLength":0,"maxLength":255},"priority":{"type":"string","enum":["LOW","NORMAL","HIGH","URGENT"],"description":"Case priority. For details, please see Overview."},"custom_fields":{"type":"object","description":"Fields which added by users."},"notes":{"type":"array","description":"Case notes.","items":{"type":"object","properties":{"note_title":{"type":"string","description":"Note Title"},"note_body":{"type":"string","description":"Note Body"},"public":{"type":"boolean","description":"Set to true if the notes are public, otherwise false. Default is false."}}}},"requester_email":{"type":"string","description":"Case requester email."},"requester_type":{"type":"string","enum":["Contact"]},"requester_name":{"type":"string","description":"Case requester name."}}},"example":{"title":"test title","description":"test description","parent_id":"1","owner_id":"61036b508ff57b5578f25a10","priority":"LOW","requester_email":"example@example.talkdesk.com","requester_name":"example","requester_type":"Contact","custom_fields":{"checkbox1":true,"dropdown1":1,"text1":"text desc","dependent_field1":["3a20c48f-3e33-49b0-af22-63eba6fa4cc3","bbb2a5e7-6190-4eb1-b889-ec37e0badd0b","e9e3c93a-1b28-489a-96fe-6b3e9ca60976"],"date1":"2022-04-21T06:30:21Z","numeric1":1,"decimal1":1.2,"multi_line_text1":"Line1\\\\nLine2","multi_select1":["002","003"]},"notes":[{"note_title":"test subject","note_body":"test body","public":true}]}}}},"responses":{"201":{"description":"Success, return the case details after created.","content":{"application/json":{"schema":{"type":"object","required":["id","title","description","status","requester_id","requester_name","requester_email"],"properties":{"id":{"type":"string","description":"Case id, the unique numeric identifiers given to each case. Starting from 1."},"title":{"type":"string","description":"Case subject on the interface."},"description":{"type":"string","description":"When a contact submits a support request via email, the body of the email request is used as the description. The description becomes the first comment in the case."},"parent_id":{"type":"string","description":"Case id of parent."},"owner_id":{"type":"string","description":"Assignee id."},"status":{"type":"string","description":"Case status. For details, please see Overview."},"type":{"type":"string","description":"Case type. For details, please see Overview."},"priority":{"type":"string","description":"Case priority. For details, please see Overview."},"custom_fields":{"type":"object","description":"Fields which added by users."},"notes":{"type":"array","description":"Case notes.","items":{"type":"object","properties":{"id":{"type":"string","description":"Notes Id, the unique numeric identifiers given to each note."},"note_title":{"type":"string","description":"Note Title."},"note_body":{"type":"string","description":"Note Body."},"public":{"type":"boolean","description":"Set to true if the notes are public, otherwise false. Default is false."}}}},"requester_id":{"type":"string","description":"Case requester id."},"requester_name":{"type":"string","description":"Case requester name."},"requester_email":{"type":"string","description":"Case requester email."},"requester_type":{"type":"string","description":"Default value is Contact."}}},"example":{"id":"1","title":"test title","description":"test description","parent_id":"2","owner_id":"61036b508ff57b5578f25a10","status":"NEW","priority":"LOW","requester_id":"657bf2d85f676d001c329bd4","requester_name":"example","requester_email":"example@example.talkdesk.com","requester_type":"Contact","custom_fields":{"checkbox1":{"value":true},"drop_down1":{"label":"test dw12","value":"001"},"text1":{"value":"text desc"},"dependent_field1":{"label":["a","a1","a11"],"value":["3a20c48f-3e33-49b0-af22-63eba6fa4cc3","bbb2a5e7-6190-4eb1-b889-ec37e0badd0b","e9e3c93a-1b28-489a-96fe-6b3e9ca60976"]},"date1":{"value":"2022-04-21T06:30:21Z"},"numeric1":{"value":1},"decimal1":{"value":1.2},"multi_line_text1":{"value":"Line1\\\\nLine2"},"multi_select1":{"label":["1111","2222"],"value":["001","002"]}},"notes":[{"id":"10000001","note_title":"test subject","note_body":"test body","public":true}]}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1520005","message":"Bad Request."}}}},"401":{"description":"Unauthorized access - invalid or unverifiable JWT.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1520006","message":"Unauthorized."}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1520007","message":"Forbidden."}}}}}},"delete":{"tags":["Cases"],"summary":"Deleting cases softly","description":"Deleting cases softly.","operationId":"DeletingCasesSoftly","security":[{"GA":["cases-public:write"]}],"parameters":[{"name":"ids","in":"query","description":"Comma-separated list of case ids to be deleted softly.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success, return the list of case ids that were successfully deleted.","content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"type":"array","description":"List of case ids that were successfully deleted softly.","items":{"type":"integer"}}}},"example":{"ids":[826,827]}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1520005","message":"Bad Request."}}}},"401":{"description":"Unauthorized access - invalid or unverifiable JWT.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1520006","message":"Unauthorized."}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1520007","message":"Forbidden."}}}},"404":{"description":"Not Found.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1520008","message":"Connection not found."}}}}}},"get":{"tags":["Cases"],"summary":"Getting a list of cases","description":"Getting a list of cases.","operationId":"GettingAListOfCases","security":[{"GA":["cases-public:read"]}],"parameters":[{"name":"page","in":"query","description":"Page.","required":false,"schema":{"type":"integer","default":1,"minimum":1,"maximum":2147483647},"example":1},{"name":"per_page","in":"query","description":"Page size.","required":false,"schema":{"type":"integer","default":50,"minimum":1,"maximum":500},"example":50},{"name":"ids","in":"query","description":"Comma-separated list of case ids to be queried.","required":false,"schema":{"type":"array","items":{"type":"string"}},"example":["180","5432","1200875"]},{"name":"agent_id","in":"query","description":"Agent id, the unique numeric identifiers given to each agent.","required":false,"schema":{"type":"string","minLength":0,"maxLength":255},"example":"62ff04ae644bcb001ebbca67"},{"name":"agent_name","in":"query","description":"Agent name.","required":false,"schema":{"type":"string","minLength":0,"maxLength":125},"example":"doe"},{"name":"agent_email","in":"query","description":"Agent email.","required":false,"schema":{"type":"string","minLength":0,"maxLength":255},"example":"johndoe@talkdesk.com"},{"name":"requester_type","in":"query","description":"The requester contains both the agent and contact. If this parameter passes in, it distinguishes; If doesn't pass in, it includes both.","required":false,"schema":{"type":"string","minLength":0,"maxLength":255,"enum":["AGENT","CONTACT"]},"example":"AGENT"},{"name":"requester_id","in":"query","description":"The id of person who made the support request which can be a contact or an agent.","required":false,"schema":{"type":"string","minLength":0,"maxLength":255},"example":"612ee2aabbf8fd000e0ad917"},{"name":"requester_name","in":"query","description":"The name of person who made the support request which can be a contact or an agent.","required":false,"schema":{"type":"string","minLength":0,"maxLength":125},"example":"roe"},{"name":"requester_email","in":"query","description":"The email of person who made the support request which can be a contact or an agent.","required":false,"schema":{"type":"string","minLength":0,"maxLength":255},"example":"richardroe@talkdesk.com"},{"name":"requester_phone","in":"query","description":"The phone of person who made the support request which can be a contact or an agent.","required":false,"schema":{"type":"string","minLength":0,"maxLength":20},"example":"+16785828251"},{"name":"title","in":"query","description":"Case subject on the interface.","required":false,"schema":{"type":"string","minLength":0,"maxLength":255},"example":"Inbound call with +16505146407"},{"name":"description","in":"query","description":"When a contact submits a support request via email, the body of the email request is used as the description. The description becomes the first comment in the case.","required":false,"schema":{"type":"string","minLength":0,"maxLength":1000000000},"example":"call_answered Contact Phone: +16505146407"},{"name":"status","in":"query","description":"Case status. For details, please see Overview.","required":false,"schema":{"type":"array","minLength":0,"maxLength":255,"items":{"type":"string","minLength":0,"maxLength":31,"enum":["NEW","OPEN","PENDING","ON_HOLD","RESOLVED","CLOSED"]},"example":["NEW"]}},{"name":"priority","in":"query","description":"Case priority. For details, please see Overview.","required":false,"schema":{"type":"array","minLength":0,"maxLength":255,"items":{"type":"string","minLength":0,"maxLength":31,"enum":["LOW","NORMAL","HIGH","URGENT"]},"example":["LOW"]}},{"name":"type","in":"query","description":"Case type. For details, please see Overview.","required":false,"schema":{"type":"array","minLength":0,"maxLength":255,"items":{"type":"string","minLength":0,"maxLength":31,"enum":["QUESTION","INCIDENT","PROBLEM","TASK"]},"example":["QUESTION"]}},{"name":"about","in":"query","description":"Case about. For details, please see Overview.","required":false,"schema":{"type":"array","minLength":0,"maxLength":255,"items":{"type":"string","minLength":0,"maxLength":31},"example":"Area 1, Area 2"}},{"name":"create_at","in":"query","description":"Time when the case was created.","required":false,"schema":{"type":"array","minLength":0,"maxLength":1000,"items":{"type":"string","format":"date-time","minLength":0,"maxLength":255}},"example":["2022-09-01 00:00:00.000","2022-09-30 23:59:59.999"]},{"name":"update_at","in":"query","description":"Time when the case was updated.","required":false,"schema":{"type":"array","minLength":0,"maxLength":1000,"items":{"type":"string","format":"date-time","minLength":0,"maxLength":255}},"example":["2022-09-01 00:00:00.000","2022-09-30 23:59:59.999"]},{"name":"order_by","in":"query","description":"Which field to sort.","required":false,"schema":{"type":"string","minLength":0,"maxLength":255,"x-sorting_default_order":"desc","x-sorting_fields":["create_at"],"enum":["create_at","update_at"]},"example":"update_at"},{"name":"sort","in":"query","description":"In what order to sort.","required":false,"schema":{"type":"string","minLength":0,"maxLength":255,"enum":["ASC","DESC"],"default":"DESC"},"example":"ASC"},{"name":"custom_fields","in":"query","description":"Fields which added by users.","required":false,"schema":{"type":"object","properties":{"checkbox1":{"type":"object","description":"Custom Fields Value. Use the JSON structure, the JSON key is named string, and the key is JSON.If you want to query by custom field, you must pass in the key name of the outer JSON, so use checkbox1 as an example and as the required item.","properties":{"label":{"type":"string","description":"The field label, can be empty","minLength":0,"maxLength":255},"value":{"type":"boolean","description":"The field value, cannot be empty. Supports multiple types: boolean, string, array, date, number, decimal, multi-line text, etc. Used type boolean here as an example"},"name":{"type":"string","description":"The field agent display name","minLength":0,"maxLength":255}},"required":["value"]}},"required":["checkbox1"]},"example":[{"checkbox1":{"value":true,"name":"Test Check Box"},"drop_down1":{"label":"Cupertino","value":"001","name":"Test Drop Down"},"text1":{"value":"This is a line of test text","name":"Test Text"},"dependent_field1":{"label":["Cupertino","Santa Clara","California"],"value":["3a20c48f-3e33-49b0-af22-63eba6fa4cc3","bbb2a5e7-6190-4eb1-b889-ec37e0badd0b","e9e3c93a-1b28-489a-96fe-6b3e9ca60976"],"name":"Test Dependent Field"},"numeric1":{"value":1,"name":"Test Num"},"decimal1":{"value":1.2,"name":"Test Decimal"},"multi_line_text1":{"value":"This is a line of test text\\nThis is the second line of test text","name":"Test Text"},"multi_select1":{"label":["San Jose","Cupertino"],"value":["001","002"],"name":"Test Select"}}]}],"responses":{"200":{"description":"Success, return the list of cases.","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"type":"integer","minimum":1,"maximum":2147483647},"count":{"type":"integer","minimum":1,"maximum":2147483647},"page":{"type":"integer","default":1,"minimum":1,"maximum":2147483647},"per_page":{"type":"integer","default":50,"minimum":1,"maximum":500},"_links":{"type":"object","properties":{"prev":{"type":"object","properties":{"href":{"type":"string"}},"required":["href"]},"self":{"type":"object","properties":{"href":{"type":"string"}},"required":["href"]},"next":{"type":"object","properties":{"href":{"type":"string"}},"required":["href"]}},"required":["prev","self","next"]},"_embedded":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","required":["id","title","description","requester_id","requester_name","requester_integration","group_id","status","create_at","update_at"],"properties":{"id":{"type":"string","description":"Case id, the unique numeric identifiers given to each case. Starting from 1."},"title":{"type":"string","description":"Case subject on the interface."},"description":{"type":"string","description":"When a contact submits a support request via email, the body of the email request is used as the description. The description becomes the first comment in the case."},"requester_id":{"type":"string","description":"The id of person who made the support request which can be a contact or an agent."},"requester_name":{"type":"string","description":"The name of person who made the support request which can be a contact or an agent."},"requester_email":{"type":"string","description":"The email of person who made the support request which can be a contact or an agent."},"requester_integration":{"type":"object","properties":{"integration_id":{"type":"string","description":"Integration identifier."},"external_id":{"type":"string","description":"Contact identifier in integration"},"external_url":{"type":"string","description":"Contact URL in external integration."},"contact_type":{"type":"string","description":"Contact type in external integration."},"external_sync_state":{"type":"string","description":"Contact sync state in integration."}}},"requester_phone":{"type":"string","description":"The phone of person who made the support request which can be a contact or an agent."},"group_id":{"type":"string","description":"The agent group id. The unique numeric identifiers given to each group."},"group_name":{"type":"string","description":"The agent group name."},"agent_id":{"type":"string","description":"Agent id, the unique numeric identifiers given to each agent."},"agent_name":{"type":"string","description":"Agent name."},"form_name":{"type":"string","description":"Case form name."},"priority":{"type":"string","description":"Case priority. For details, please see Overview."},"status":{"type":"string","description":"Case status. For details, please see Overview."},"type":{"type":"string","description":"Case type. For details, please see Overview."},"about":{"type":"string","description":"Case about. For details, please see Overview."},"create_at":{"type":"string","description":"Time when the field was created.","format":"date-time"},"update_at":{"type":"string","description":"Time when the field was updated.","format":"date-time"},"custom_fields":{"type":"string","description":"Fields which added by users."},"notes":{"type":"array","description":"Case notes.","items":{"type":"object","properties":{"id":{"type":"string","description":"Notes Id, the unique numeric identifiers given to each note."},"notes_title":{"type":"string","description":"Notes Title."},"notes_body":{"type":"string","description":"Notes Body."},"public":{"type":"boolean","description":"Is true if any notes are public, false otherwise. Defaults to true."}}},"required":["id","public"]}}}}},"required":["data"]}},"required":["total","count","page","per_page","_links","_embedded"]},"example":{"total":493,"count":10,"page":1,"per_page":50,"_links":{"prev":{"href":"https://api-docs.talkdesk.org/cm/core/va/cases/lists/?page=1&per_page=50"},"self":{"href":"https://api-docs.talkdesk.org/cm/core/va/cases/lists/?page=2&per_page=50"},"next":{"href":"https://api-docs.talkdesk.org/cm/core/va/cases/lists/?page=3&per_page=50"}},"_embedded":{"required":["data"],"data":[{"id":"5432","title":"Inbound call with +16505146407","description":"call_answered Contact Phone: +16505146407","requester_id":"62ff04ae644bcb001ebbca67","requester_name":"roe","requester_email":"richardroe@talkdesk.com","requester_phone":"+16785828251","requester_integration":"{\\\"integration_id\\\":\\\"testforce\\\",\\\"external_id\\\":\\\"0038d000006y2ceAAA\\\",\\\"external_url\\\":\\\"https://talkdesk-1cf-dev-ed.my.testforce.com/0038d000006y2ceAAA\\\",\\\"contact_type\\\":\\\"contact\\\", \\\"external_sync_state\\\":\\\"1;623db0bfbe376200017f97bc;2022-03-25T12:08:32.458482160Z;1;0\\\"}","group_id":"agents","group_name":"agents","agent_id":"62feea698bb2e44234a9cd04","agent_name":"doe","form_name":"Default Case Form","priority":"Low","status":"New","type":"Question","about":"Area 1","create_at":"2022-09-08T06:46:00Z","update_at":"2022-09-08T06:46:00Z","custom_fields":"{\\\"date1\\\": {\\\"label\\\": \\\"2022-09-21T06:30:21Z\\\", \\\"value\\\": \\\"2022-09-21T06:30:21Z\\\",\\\"name\\\":\\\"Date\\\"}, \\\"text1\\\": {\\\"label\\\": null, \\\"value\\\": \\\"This is a line of test text\\\",\\\"name\\\":\\\"Test Text\\\"}, \\\"decimal1\\\": {\\\"label\\\": null, \\\"value\\\": 1.2,\\\"name\\\":\\\"Test Decimal\\\"}, \\\"numeric1\\\": {\\\"label\\\": null, \\\"value\\\": 1,\\\"name\\\":\\\"Num\\\"},\\\"checkbox1\\\": {\\\"label\\\": true, \\\"value\\\": true,\\\"name\\\":\\\"Test CheckBox\\\"}, \\\"drop_down1\\\": {\\\"label\\\": \\\"Cupertino\\\", \\\"value\\\": \\\"001\\\", \\\"name\\\":\\\"Test Drop Down\\\"}, \\\"multi_select1\\\": {\\\"label\\\": [\\\"San Jose\\\", \\\"Cupertino\\\"], \\\"value\\\": [\\\"001\\\", \\\"002\\\"],\\\"name\\\":\\\"Test Select\\\"}, \\\"dependent_field1\\\": {\\\"label\\\": [\\\"California\\\", \\\"Santa Clara\\\", \\\"California\\\"], \\\"value\\\": [\\\"3a20c48f-3e33-49b0-af22-63eba6fa4cc3\\\", \\\"bbb2a5e7-6190-4eb1-b889-ec37e0badd0b\\\", \\\"e9e3c93a-1b28-489a-96fe-6b3e9ca60976\\\"],\\\"name\\\":\\\"Test Dependent Field\\\"}, \\\"multi_line_text1\\\": {\\\"label\\\": null, \\\"value\\\": \\\"This is a line of test text\\\\\\\\nThis is the second line of test text\\\",\\\"name\\\":\\\"Test Text\\\"}}","notes":[{"id":"10000001","notes_title":"test subject","notes_body":"test body","public":true}]}]}}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1520005","message":"Bad Request."}}}},"401":{"description":"Unauthorized access - invalid or unverifiable JWT.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1520006","message":"Unauthorized."}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1520007","message":"Forbidden."}}}},"404":{"description":"Not Found.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1520008","message":"Connection not found."}}}}}}},"/cm/core/va/cases/{id}":{"get":{"tags":["Cases"],"summary":"Getting case details","description":"Getting case details.","operationId":"GettingCaseDetails","security":[{"GA":["cases-public:read"]}],"parameters":[{"name":"Authorization","in":"header","description":"Authorization header containing the JWT generated by API Gateway.","required":true,"schema":{"type":"string","minLength":1}},{"name":"id","in":"path","description":"Case id, the unique numeric identifiers given to each case. Starting from 1.","required":true,"schema":{"type":"string","minLength":0,"maxLength":9223372036854776000}}],"responses":{"200":{"description":"The case details.","content":{"application/json":{"schema":{"type":"object","required":["id","title","description","status"],"properties":{"id":{"type":"string","description":"Case id, the unique numeric identifiers given to each case. Starting from 1."},"title":{"type":"string","description":"Case subject on the interface."},"description":{"type":"string","description":"When a contact submits a support request via email, the body of the email request is used as the description. The description becomes the first comment in the case."},"owner_id":{"type":"string","description":"The id of Assignee."},"form_name":{"type":"string","description":"Case form name."},"priority":{"type":"string","description":"Case priority. For details, please see Overview."},"type":{"type":"string","description":"Case type. For details, please see Overview."},"status":{"type":"string","description":"Case status. For details, please see Overview."},"resolution":{"type":"string","description":"The resolution, required when solving a case."},"notes":{"type":"array","description":"Case notes.","items":{"type":"object","properties":{"id":{"type":"string","description":"Notes Id, the unique numeric identifiers given to each note."},"notes_title":{"type":"string","description":"Notes Title."},"notes_body":{"type":"string","description":"Notes Body."},"public":{"type":"boolean","description":"Is true if any notes are public, false otherwise. Defaults to true."}}}},"custom_fields":{"type":"string","description":"Fields which added by users."}}},"example":{"id":"1","title":"test title","description":"test description","owner_id":"61036b508ff57b5578f25a10","form_name":"Default Case Form","priority":"LOW","type":"QUESTION","status":"NEW","resolution":"solve successfully","notes":[{"id":"10000001","notes_title":"test subject","notes_body":"test body","public":true}],"custom_fields":"{\\\"date1\\\": {\\\"label\\\": \\\"2022-09-21T06:30:21Z\\\", \\\"value\\\": \\\"2022-09-21T06:30:21Z\\\"}, \\\"text1\\\": {\\\"label\\\": null, \\\"value\\\": \\\"This is a line of test text\\\"}, \\\"decimal1\\\": {\\\"label\\\": null, \\\"value\\\": 1.2}, \\\"numeric1\\\": {\\\"label\\\": null, \\\"value\\\": 1}, \\\"checkbox1\\\": {\\\"label\\\": true, \\\"value\\\": true}, \\\"drop_down1\\\": {\\\"label\\\": \\\"Cupertino\\\", \\\"value\\\": \\\"001\\\"}, \\\"multi_select1\\\": {\\\"label\\\": [\\\"San Jose\\\", \\\"Cupertino\\\"], \\\"value\\\": [\\\"001\\\", \\\"002\\\"]}, \\\"dependent_field1\\\": {\\\"label\\\": [\\\"California\\\", \\\"Santa Clara\\\", \\\"California\\\"], \\\"value\\\": [\\\"3a20c48f-3e33-49b0-af22-63eba6fa4cc3\\\", \\\"bbb2a5e7-6190-4eb1-b889-ec37e0badd0b\\\", \\\"e9e3c93a-1b28-489a-96fe-6b3e9ca60976\\\"]}, \\\"multi_line_text1\\\": {\\\"label\\\": null, \\\"value\\\": \\\"This is a line of test text\\\\\\\\nThis is the second line of test text\\\"}}"}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1520005","message":"Bad Request."}}}},"401":{"description":"Unauthorized access - invalid or unverifiable JWT.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1520006","message":"Unauthorized."}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1520007","message":"Forbidden."}}}},"404":{"description":"Not Found.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1520008","message":"Connection not found."}}}}}},"patch":{"tags":["Cases"],"summary":"Updating a case","description":"Updating a case.","operationId":"UpdatingACase","security":[{"GA":["cases-public:write"]}],"parameters":[{"name":"Authorization","in":"header","description":"Authorization header containing the JWT generated by API Gateway.","required":true,"schema":{"type":"string","minLength":1}},{"name":"id","in":"path","description":"Case id, the unique numeric identifiers given to each case. Pass in the id of the case you want to update.","required":true,"schema":{"type":"string","minLength":0}}],"requestBody":{"description":"The case to be updated.","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"parent_id":{"type":"string","description":"Case Id of parent case.","minLength":0,"maxLength":255},"title":{"type":"string","description":"Case subject.","minLength":0,"maxLength":150},"description":{"type":"string","description":"Case description.","minLength":0,"maxLength":2000},"owner_id":{"type":"string","description":"Assignee id.","minLength":0,"maxLength":255},"priority":{"type":"string","enum":["LOW","NORMAL","HIGH","URGENT"],"description":"Case priority.","minLength":0,"maxLength":255},"type":{"type":"string","enum":["QUESTION","INCIDENT","PROBLEM","TASK"],"description":"Case type.","minLength":0,"maxLength":255},"status":{"type":"string","enum":["NEW","OPEN","PENDING","ON_HOLD","RESOLVED","CLOSED"],"description":"Case status.","minLength":0,"maxLength":255},"resolution":{"type":"string","description":"The resolution, required when solving a case.","minLength":0,"maxLength":2000},"custom_fields":{"type":"object","description":"Fields added by agents.","minLength":0,"maxLength":1000000000},"notes":{"type":"array","description":"Case notes.","items":{"type":"object","properties":{"note_title":{"type":"string","description":"Note Title"},"note_body":{"type":"string","description":"Note Body"},"public":{"type":"boolean","description":"Set to true if the notes are public, otherwise false. Default is false."}}}},"group_id":{"type":"string","description":"Group id.","minLength":0,"maxLength":255}}},"example":{"parent_id":"2","title":"test title","description":"test description","owner_id":"61036b508ff57b5578f25a10","priority":"LOW","type":"QUESTION","status":"ON-HOLD","resolution":"solve successfully","custom_fields":{"checkbox1":{"value":true},"drop_down1":{"label":"test dw12","value":"001"},"text1":{"value":"text desc"},"dependent_field1":{"label":["a","a1","a11"],"value":["3a20c48f-3e33-49b0-af22-63eba6fa4cc3","bbb2a5e7-6190-4eb1-b889-ec37e0badd0b","e9e3c93a-1b28-489a-96fe-6b3e9ca60976"]},"date1":{"value":"2022-04-21T06:30:21Z"},"numeric1":{"value":1},"decimal1":{"value":1.2},"multi_line_text1":{"value":"Line1\\\\nLine2"},"multi_select1":{"label":["1111","2222"],"value":["001","002"]}},"notes":[{"note_title":"test subject","note_body":"test body","public":true}],"group_id":"group"}}}},"responses":{"200":{"description":"Success, return the case details after updated.","content":{"application/json":{"schema":{"type":"object","required":["id","title","description","status"],"properties":{"id":{"type":"string","description":"Case id, the unique numeric identifiers given to each case."},"parent_id":{"type":"string","description":"Case id of parent case."},"title":{"type":"string","description":"Case subject."},"description":{"type":"string","description":"Case description."},"owner_id":{"type":"string","description":"Assignee id."},"priority":{"type":"string","description":"Case priority."},"type":{"type":"string","description":"Case type."},"status":{"type":"string","description":"Case status."},"resolution":{"type":"string","description":"The resolution, required when solving a case."},"notes":{"type":"array","description":"Case notes.","items":{"type":"object","properties":{"id":{"type":"string","description":"Notes id, the unique numeric identifiers given to each note."},"note_title":{"type":"string","description":"Note title."},"note_body":{"type":"string","description":"Note body."},"public":{"type":"boolean","description":"Set to true if the notes are public, otherwise false. Default is false."}}}},"custom_fields":{"type":"object","description":"Fields which added by users."},"group_id":{"type":"string","description":"Group id.","minLength":0,"maxLength":255}}},"example":{"id":"1","parent_id":"2","title":"test title","description":"test description","owner_id":"61036b508ff57b5578f25a10","priority":"LOW","type":"QUESTION","status":"NEW","resolution":"solve successfully","notes":[{"id":"10000001","note_title":"test subject","note_body":"test body","public":true}],"custom_fields":{"checkbox1":{"value":true},"drop_down1":{"label":"test dw12","value":"001"},"text1":{"value":"text desc"},"dependent_field1":{"label":["a","a1","a11"],"value":["3a20c48f-3e33-49b0-af22-63eba6fa4cc3","bbb2a5e7-6190-4eb1-b889-ec37e0badd0b","e9e3c93a-1b28-489a-96fe-6b3e9ca60976"]},"date1":{"value":"2022-04-21T06:30:21Z"},"numeric1":{"value":1},"decimal1":{"value":1.2},"multi_line_text1":{"value":"Line1\\\\nLine2"},"multi_select1":{"label":["1111","2222"],"value":["001","002"]}},"group_id":"group"}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1520005","message":"Bad Request."}}}},"401":{"description":"Unauthorized access - invalid or unverifiable JWT.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1520006","message":"Unauthorized."}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1520007","message":"Forbidden."}}}},"404":{"description":"Not Found.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1520008","message":"Connection not found."}}}}}}},"/cm/core/va/cases/info":{"get":{"tags":["Cases"],"summary":"Getting newest case details by contact","description":"Getting newest case details by contact.","operationId":"GettingNewestCaseDetailsByContact","security":[{"GA":["cases-public:read"]}],"parameters":[{"name":"id","in":"query","description":"Contact id, one of the five parameters(id, name, email, phone, integration) must be passed.","required":true,"schema":{"type":"string","minLength":3,"maxLength":255},"example":"612ee2aabbf8fd000e0ad917"},{"name":"name","in":"query","description":"Contact name, one of the five parameters(id, name, email, phone, integration) must be passed.","required":true,"schema":{"type":"string","minLength":3,"maxLength":125},"example":"roe"},{"name":"email","in":"query","description":"Contact email, one of the five parameters(id, name, email, phone, integration) must be passed.","required":true,"schema":{"type":"string","minLength":3,"maxLength":255},"example":"richardroe@talkdesk.com"},{"name":"phone","in":"query","description":"Contact phone, one of the five parameters(id, name, email, phone, integration) must be passed.","required":true,"schema":{"type":"string","minLength":5,"maxLength":20},"example":"+16785828251"},{"name":"status","in":"query","description":"Case status, please note that the status here is different from the case in general.","required":false,"schema":{"type":"string","minLength":3,"maxLength":255,"enum":["ALL","UNRESOLVED","RESOLVED"],"default":"ALL"},"example":"ALL"},{"name":"integration","in":"query","description":"Contact integration, the format value is integration_id:external_id, one of the five parameters(id, name, email, phone, integration) must be passed.","required":true,"schema":{"type":"string","minLength":0,"maxLength":255},"example":"testforce:0038d0000071jjGAAQ"}],"responses":{"200":{"description":"The newest case details.","content":{"application/json":{"schema":{"type":"object","required":["id","title","description","requester_id","requester_name","requester_integration","group_id","status","create_at","update_at"],"properties":{"id":{"type":"string","description":"Case id, the unique numeric identifiers given to each case. Starting from 1."},"title":{"type":"string","description":"Case subject on the interface."},"description":{"type":"string","description":"When a contact submits a support request via email, the body of the email request is used as the description. The description becomes the first comment in the case."},"requester_id":{"type":"string","description":"The id of person who made the support request which can be a contact or an agent."},"requester_name":{"type":"string","description":"The name of person who made the support request which can be a contact or an agent."},"requester_email":{"type":"string","description":"The email of person who made the support request which can be a contact or an agent."},"requester_integration":{"type":"object","properties":{"integration_id":{"type":"string","description":"Integration identifier."},"external_id":{"type":"string","description":"Contact identifier in integration"},"external_url":{"type":"string","description":"Contact URL in external integration."},"contact_type":{"type":"string","description":"Contact type in external integration."},"external_sync_state":{"type":"string","description":"Contact sync state in integration."}}},"requester_phone":{"type":"string","description":"The phone of person who made the support request which can be a contact or an agent."},"group_id":{"type":"string","description":"The agent group id. The unique numeric identifiers given to each group."},"group_name":{"type":"string","description":"The agent group name."},"agent_id":{"type":"string","description":"Agent id, the unique numeric identifiers given to each agent."},"agent_name":{"type":"string","description":"Agent name."},"form_name":{"type":"string","description":"Case form name."},"priority":{"type":"string","description":"Case priority. For details, please see Overview."},"status":{"type":"string","description":"Case status. For details, please see Overview."},"type":{"type":"string","description":"Case type. For details, please see Overview."},"about":{"type":"string","description":"Case about. For details, please see Overview."},"create_at":{"type":"string","description":"Time when the field was created.","format":"date-time"},"update_at":{"type":"string","description":"Time when the field was updated.","format":"date-time"},"custom_fields":{"type":"string","description":"Fields which added by users."},"notes":{"type":"array","description":"Case notes.","items":{"type":"object","properties":{"id":{"type":"string","description":"Notes Id, the unique numeric identifiers given to each note."},"notes_title":{"type":"string","description":"Notes Title."},"notes_body":{"type":"string","description":"Notes Body."},"public":{"type":"boolean","description":"Is true if any notes are public, false otherwise. Defaults to true."}}},"required":["id","public"]}}},"example":{"id":"5432","title":"Inbound call with +16505146407","description":"call_answered Contact Phone: +16505146407","requester_id":"62ff04ae644bcb001ebbca67","requester_name":"roe","requester_email":"richardroe@talkdesk.com","requester_phone":"+16785828251","requester_integration":"{\\\"integration_id\\\":\\\"testforce\\\",\\\"external_id\\\":\\\"0038d000006y2ceAAA\\\",\\\"external_url\\\":\\\"https://talkdesk-1cf-dev-ed.my.testforce.com/0038d000006y2ceAAA\\\",\\\"contact_type\\\":\\\"contact\\\", \\\"external_sync_state\\\":\\\"1;623db0bfbe376200017f97bc;2022-03-25T12:08:32.458482160Z;1;0\\\"}","group_id":"agents","group_name":"agents","agent_id":"62feea698bb2e44234a9cd04","agent_name":"doe","form_name":"Default Case Form","priority":"Low","status":"New","type":"Question","about":"Area 1","create_at":"2022-09-08T06:46:00Z","update_at":"2022-09-08T06:46:00Z","custom_fields":"{\\\"date1\\\": {\\\"label\\\": \\\"2022-09-21T06:30:21Z\\\", \\\"value\\\": \\\"2022-09-21T06:30:21Z\\\",\\\"name\\\":\\\"Date\\\"}, \\\"text1\\\": {\\\"label\\\": null, \\\"value\\\": \\\"This is a line of test text\\\",\\\"name\\\":\\\"Test Text\\\"}, \\\"decimal1\\\": {\\\"label\\\": null, \\\"value\\\": 1.2,\\\"name\\\":\\\"Test Decimal\\\"}, \\\"numeric1\\\": {\\\"label\\\": null, \\\"value\\\": 1,\\\"name\\\":\\\"Num\\\"},\\\"checkbox1\\\": {\\\"label\\\": true, \\\"value\\\": true,\\\"name\\\":\\\"Test CheckBox\\\"}, \\\"drop_down1\\\": {\\\"label\\\": \\\"Cupertino\\\", \\\"value\\\": \\\"001\\\", \\\"name\\\":\\\"Test Drop Down\\\"}, \\\"multi_select1\\\": {\\\"label\\\": [\\\"San Jose\\\", \\\"Cupertino\\\"], \\\"value\\\": [\\\"001\\\", \\\"002\\\"],\\\"name\\\":\\\"Test Select\\\"}, \\\"dependent_field1\\\": {\\\"label\\\": [\\\"California\\\", \\\"Santa Clara\\\", \\\"California\\\"], \\\"value\\\": [\\\"3a20c48f-3e33-49b0-af22-63eba6fa4cc3\\\", \\\"bbb2a5e7-6190-4eb1-b889-ec37e0badd0b\\\", \\\"e9e3c93a-1b28-489a-96fe-6b3e9ca60976\\\"],\\\"name\\\":\\\"Test Dependent Field\\\"}, \\\"multi_line_text1\\\": {\\\"label\\\": null, \\\"value\\\": \\\"This is a line of test text\\\\\\\\nThis is the second line of test text\\\",\\\"name\\\":\\\"Test Text\\\"}}","notes":[{"id":"10000001","notes_title":"test subject","notes_body":"test body","public":true}]}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1520005","message":"Bad Request."}}}},"401":{"description":"Unauthorized access - invalid or unverifiable JWT.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1520006","message":"Unauthorized."}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1520007","message":"Forbidden."}}}},"404":{"description":"Not Found.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1520008","message":"Connection not found."}}}}}}},"/cm/core/va/cases/deleted-cases":{"delete":{"tags":["Cases"],"summary":"Deleting cases permanently","description":"Deleting cases permanently.","operationId":"DeletingCasesPermanently","security":[{"GA":["cases-public:write"]}],"parameters":[{"name":"ids","in":"query","description":"Comma-separated list of case ids to be deleted permanently.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success, return the list of case ids that were successfully deleted.","content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"type":"array","description":"List of case ids that were successfully deleted permanently.","items":{"type":"integer"}}}},"example":{"ids":[826,827]}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1520005","message":"Bad Request."}}}},"401":{"description":"Unauthorized access - invalid or unverifiable JWT.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1520006","message":"Unauthorized."}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1520007","message":"Forbidden."}}}},"404":{"description":"Not Found.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1520008","message":"Connection not found."}}}}}}},"/cm/core/va/notes/{note_id}":{"patch":{"tags":["Cases"],"summary":"Update a case note","description":"Update a case note.","operationId":"UpdateACaseNote","security":[{"GA":["case-notes-public:write"]}],"parameters":[{"name":"Authorization","in":"header","description":"Authorization header containing the JWT generated by API Gateway.","required":true,"schema":{"type":"string","minLength":1}},{"name":"note_id","in":"path","description":"The Case note id, which is the unique numeric identifier given to each case note. Pass in the id of the case note you want to update.","required":true,"schema":{"type":"string","minLength":1}}],"requestBody":{"description":"The request_body of the case note.","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"note_title":{"type":"string","description":"The note subject.","minLength":0,"maxLength":255},"note_body":{"type":"string","description":"The note body.","minLength":0}}},"example":{"note_title":"Here is the title of the case note.","note_body":"Here is the body of the case note."}}}},"responses":{"200":{"description":"Success, return the case note details after updating.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The Case note id, which is the unique numeric identifier given to each case note."},"note_title":{"type":"string","description":"The title of the case note."},"note_body":{"type":"string","description":"The body of the case note."},"public":{"type":"boolean","description":"If the case note is public, the default value is [true]"}}},"example":{"id":"1592529126028390402","note_title":"Here is the title of the case note.","note_body":"Here is the body of the case note.","public":true}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1520005","message":"Bad Request."}}}},"401":{"description":"Unauthorized access - invalid or unverifiable JWT.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1520006","message":"Unauthorized."}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1520007","message":"Forbidden."}}}},"404":{"description":"Not Found.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1520008","message":"Connection not found."}}}}}}},"/cm/meta/va/fields":{"get":{"tags":["Cases"],"summary":"Getting a list of case fields","description":"Getting a list of case fields.","operationId":"GettingAListOfCaseFields","security":[{"GA":["case-fields-public:read"]}],"responses":{"200":{"description":"The list of case fields.","content":{"application/json":{"schema":{"type":"object","required":["id","name","key","type","required","active","create_at","update_at"],"properties":{"id":{"type":"string","description":"Field id, the unique numeric identifiers given to each case field"},"name":{"type":"string","description":"The name given to each case field."},"key":{"type":"string","description":"The unique key given to each case field."},"type":{"type":"string","description":"Field type."},"description":{"type":"string","description":"A detailed description of the field"},"dict_list":{"type":"array","description":"For some fields, you may have a dictionary entry (such as a drop-down value, etc.) that is the list of the corresponding dictionary entry.","items":{"type":"object","properties":{"key":{"type":"string","description":"Dict key, the unique identifier of the dict."},"value":{"type":"string","description":"Dict value"},"children":{"type":"array","description":"Since dict is a nested array structure, children are an array of dictionary children, which also have properties of key, value, and children."}}}},"required":{"type":"boolean","description":"If true, agents must enter a value in the field to change the case status to solved."},"active":{"type":"boolean","description":"All fields are active by default and will be inactive if it is deactivated. All fields are active by default and will be inactive if it is deactivated."},"create_at":{"type":"string","format":"date-time","description":"Time when the field was created."},"update_at":{"type":"string","format":"date-time","description":"Time when the field was updated."}}},"example":{"id":"1397421734151344130","name":"Assign Reason","key":"assign_reason","type":"001","dict_list":[{"key":"001","value":"high","children":[]}],"description":"assign reason","required":false,"active":true,"create_at":"2021-05-26T13:17:58.000+00:00","update_at":"2021-05-26T13:17:58.000+00:00"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1520006","message":"Unauthorized."}}}},"403":{"description":"Forbidden Error.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1520007","message":"Forbidden."}}}},"404":{"description":"Not Found.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1520008","message":"Connection not found."}}}},"500":{"description":"Internal Server Error.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1520000","message":"System error."}}}}}}},"/digital-connect/conversations":{"post":{"description":"Create digital-connect conversations","summary":"Create digital-connect conversation","operationId":"create-digital-connect-conversations","security":[{"GA":["digital-connect:write"]}],"parameters":[{"name":"x-idempotency-key","in":"header","required":true,"description":"Idempotency key to insure no multiple creation of the same resource","schema":{"minLength":1,"maxLength":255,"type":"string"}}],"tags":["Digital-Connect-Conversations"],"requestBody":{"description":"The request body to create a new interaction via Digital Connect","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"touchpoint_id":{"type":"string","minLength":1,"maxLength":255,"description":"ID for the Touchpoint the conversation is to be created in"},"subject":{"type":"string","minLength":1,"maxLength":255,"description":"Description for interaction subject"},"contact_person":{"type":"object","required":["email"],"properties":{"email":{"type":"string","minLength":1,"maxLength":255}}},"context_parameters":{"type":"object","description":"The field that allows adding additional context information to the Conversation using a simple key - value mapping object","nullable":true,"additionalProperties":true},"previous_messages":{"type":"array","items":{"type":"object","required":["type","content","created_at"],"properties":{"type":{"type":"string","enum":["user","external"],"description":"Type of message","minLength":10},"content":{"type":"string","description":"Message content. Only plain text is accepted.","minLength":1,"maxLength":1600},"created_at":{"type":"string","format":"date-time","description":"The date and time when the message was created.","minLength":1,"maxLength":35}}}}},"required":["touchpoint_id","contact_person"],"example":{"touchpoint_id":"123","subject":"Congrats on the new amazing API","contact_person":{"email":"example@talkdesk.com"}}},"example":{"touchpoint_id":"my-touchpoint-id","subject":"This is the subject I need to talk about","contact_person":{"email":"contact@person.com"},"context_parameters":{"contact_name":"name","contact_phone":"+18445852205","contact_reason":"consulting products","website_location":"http://location.com"},"previous_messages":[{"type":"EXTERNAL","content":"How can I help you?","created_at":"2022-01-01T08:00:00+08:00"},{"type":"USER","content":"I want to reset my account.","created_at":"2022-01-01T09:00:00+08:00"}]}}}},"responses":{"201":{"description":"Success, creates a new conversation, or finds an existing one through its idempotency key, and return its id","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":255,"description":"ID for the created conversation"}}},"example":{"id":"my-conversation-id"}}}},"400":{"description":"Malformed Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"BadRequest":{"value":{"code":"3016000","message":"Malformed Request"}},"TouchpointNotAvailable":{"value":{"code":"3016005","message":"This touchpoint was not available, since it has been marked as inactive (active = false), id='123456789'"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3016001","message":"The credentials that were used do not have the authorization for this request"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3016003","message":"The requested action is forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3004041","message":"This digital connect touchpoint was not found, id='1234567890'"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3016009","message":"Action impossible due to data conflict, e.g.: duplicate keys"}}}},"500":{"description":"Internal Error","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3016100","message":"Internal error while processing the request"}}}}}}},"/digital-connect/conversations/{id}/messages":{"post":{"description":"Create digital-connect conversation inbound messages","summary":"Create digital-connect conversation","operationId":"create-digital-connect-messages","security":[{"GA":["digital-connect:write"]}],"parameters":[{"name":"x-idempotency-key","in":"header","required":false,"description":"Idempotency key to insure no multiple creation of the same resource","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"The ID of the designated conversation in which the message will be created","schema":{"minLength":1,"maxLength":255,"type":"string"}}],"tags":["Digital-Connect-Conversations"],"requestBody":{"description":"The request body to create a new message in the given Digital Connect conversation","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"content":{"type":"string","minLength":1,"maxLength":1600,"description":"Message body to be sent to TalkDesk, only plain text accepted"},"attachments":{"type":"array","items":{"type":"object","description":"attachment list","required":["id","name","type","size"],"properties":{"id":{"type":"string","description":"The file id of the attachment."},"name":{"type":"string","description":"The file name of the attachment."},"type":{"type":"string","description":"The file type of the attachment."},"size":{"type":"number","description":"The file size of the attachment, the unit is Byte."}}}}},"example":{"content":"I am a contact person in need of help! Help me, Ms. Agent!","attachments":[{"id":"my-mp3-id","name":"test.mp3","type":"audio/mpeg","size":"1048576"},{"id":"my-image-id","name":"test.jpg","type":"image/jpeg","size":"3145728"}]}},"example":{"content":"A cute message for the agent to read, with love: Contact Person","attachments":[{"id":"my-mp3-id","name":"test.mp3","type":"audio/mpeg","size":"1024"},{"id":"my-image-id","name":"test.jpg","type":"image/jpeg","size":"3072"}]}}}},"responses":{"201":{"description":"Success, creates a new message in the designated conversation","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":255,"description":"The identifier of the conversation"},"created_at":{"type":"string","minLength":24,"maxLength":24},"message_id":{"type":"string","minLength":1,"maxLength":255,"description":"The identifier of the outbound message."}}},"example":{"id":"my-conversation-id","created_at":"2012-12-11T10:10:22.4TZD","message_id":"08dead5b-ffc9-4593-a414-b0a3b37c9a25"}}}},"206":{"description":"Partial success, create message success but attachments have some problem","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":255,"description":"The identifier of the conversation"},"created_at":{"type":"string","minLength":24,"maxLength":24},"message_id":{"type":"string","minLength":1,"maxLength":255,"description":"The identifier of the outbound message."},"partial_fail_reason":{"type":"string","description":"The fail reason of the attachments."}}},"example":{"id":"my-conversation-id","created_at":"2012-12-11T10:10:22.4TZD","message_id":"08dead5b-ffc9-4593-a414-b0a3b37c9a25","partial_fail_reason":"Message send success, but the partial attachments send failed, reason: the quantity of the attachments exceeds the 10."}}}},"400":{"description":"Malformed Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"BadRequest":{"value":{"code":"3016000","message":"Malformed Request"}},"InvalidAttachments":{"value":{"code":"3016012","message":"The all attachments send failed, reason: the size of the attachment(id:my-mp3-id,name:test.mp3) is larger than the limit."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3016001","message":"The credentials that were used do not have the authorization for this request"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3016003","message":"The requested action is forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3016004","message":"Conversation does not exist."}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3016009","message":"Action impossible due to data conflict, e.g.: duplicate keys"}}}},"410":{"description":"Gone","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3016011","message":"Conversation is closed, id='1234567890'."}}}},"500":{"description":"Internal Error","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3016100","message":"Internal error while processing the request"}}}}}}},"/digital-connect/conversations/{id}":{"delete":{"description":"Delete Digital-Connect Conversation","summary":"delete digital-connect conversation","operationId":"delete-digital-connect-conversation","security":[{"GA":["digital-connect:write"]}],"tags":["Digital-Connect-Conversations"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization header containing the JWT generated by API Gateway","required":true,"schema":{"type":"string"}},{"in":"path","name":"id","schema":{"type":"string"},"description":"The DigitalConnect Conversation ID","required":true}],"responses":{"204":{"description":"Delete digital-connect conversation successfully"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"BadRequest":{"value":{"code":"3016000","message":"Malformed Request"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3016001","message":"The credentials that were used do not have the authorization for this request"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3016003","message":"The requested action is forbidden"}}}},"404":{"description":"Conversation Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3016004","message":"Conversation does not exist."}}}},"410":{"description":"Gone","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3016011","message":"Conversation is closed, id='1234567890'."}}}},"500":{"description":"Internal Error","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3016100","message":"Internal error while processing the request"}}}}}}},"/phone-details/outbound-numbers":{"get":{"description":"List phone numbers that can be used for outbound by the agent, including dedicated line and numbers belonging to an agent ring group.","security":[{"EarlyAccess":["outbound-numbers:read"]}],"parameters":[{"name":"page","in":"query","description":"Number of the desired page (minimum value of 1).","required":true,"schema":{"type":"integer","default":1,"minimum":1,"maximum":2147483647}},{"name":"per_page","in":"query","description":"Amount of phone numbers per page.","required":true,"schema":{"type":"integer","default":50,"minimum":1,"maximum":500}},{"name":"search","in":"query","description":"Search phone numbers by friendly name or phone number","required":false,"example":"*sales*","schema":{"type":"string","x-search_operators":["*"],"x-search_fields":["friendly_name","phone_number"]}},{"name":"search_fields","in":"query","required":false,"schema":{"type":"string","default":"friendly_name,phone_number"}},{"name":"capability","in":"query","description":"Filter phone number by capabiliy","required":false,"example":"SMS","schema":{"type":"string"}}],"tags":["Phone Details"],"responses":{"200":{"description":"List of phone numbers that can be used for outbound by the agent","content":{"application/json":{"schema":{"type":"object","required":["total","page","count","per_page","_embedded","_links"],"properties":{"total":{"type":"integer"},"page":{"type":"integer"},"per_page":{"type":"integer"},"count":{"type":"integer"},"_embedded":{"type":"object","required":["phone_numbers"],"properties":{"phone_numbers":{"type":"array","items":{"type":"object","required":["id","phone_number","friendly_name","dedicated_line","sip","vcid","capabilities"],"properties":{"id":{"type":"string","description":"the ID for the phone number"},"phone_number":{"type":"string","description":"the phone number in E.164 format"},"friendly_name":{"type":"string","description":"the friendly name for the phone number"},"dedicated_line":{"type":"boolean","description":"if the phone number is a dedicated line or not"},"dedicated_line_agent_id":{"type":"string","description":"the agent ID associated to the dedicated line"},"sip":{"type":"boolean","description":"if the phone number is SIP"},"vcid":{"type":"boolean","description":"if the phone number is a VCID (verified caller ID)"},"capabilities":{"type":"array","description":"The phone number's supported capabilities (e.g. SMS, Voice, MMS, etc.)"}}}}}},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}},"first":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}},"next":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}},"previous":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}},"last":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}}}}}},"example":{"total":2,"page":2,"count":2,"per_page":2,"_embedded":{"phone_numbers":[{"id":"59df62c81507b35a7cf2bbd3","phone_number":"+351233391919","friendly_name":"Phone Number Example 1","dedicated_line":false,"sip":false,"vcid":true,"capabilities":["mms","sms"]},{"id":"59df62cf1507b35a7cf2bbd4","phone_number":"+351213967870","friendly_name":"Phone Number Example 2","dedicated_line":true,"dedicated_line_agent_id":"61b85d571d503a77cf35b135","sip":true,"vcid":false,"capabilities":["fax","voice"]}]},"_links":{"self":{"href":"https://api-docs.talkdesk.org/phone-details/numbers?page=2&per_page=2"},"first":{"href":"https://api-docs.talkdesk.org/phone-details/numbers?page=1&per_page=2"},"next":{"href":"https://api-docs.talkdesk.org/phone-details/numbers?page=3&per_page=2"},"previous":{"href":"https://api-docs.talkdesk.org/phone-details/numbers?page=1&per_page=2"},"last":{"href":"https://api-docs.talkdesk.org/phone-details/numbers?page=3&per_page=2"}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1394000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1394001","message":"Invalid JWT."}}}},"403":{"description":"Forbidden access","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1394003","message":"Required scopes are missing."}}}}}}},"/phone-details/numbers":{"get":{"description":"Get numbers belonging to the account","security":[{"EarlyAccess":["phone-details:read"]}],"parameters":[{"in":"query","name":"page","description":"Number of the desired page (minimum value of 1).","required":true,"schema":{"type":"integer","default":1,"minimum":1}},{"in":"query","name":"per_page","description":"Amount of phone numbers per page.","required":true,"schema":{"type":"integer","default":50,"minimum":1,"maximum":500}},{"name":"sip","in":"query","description":"Filter phone numbers by SIP","required":false,"example":true,"schema":{"x-filterable":true,"type":"boolean"}},{"name":"vcid","in":"query","description":"Filter phone numbers by VCID","required":false,"example":true,"schema":{"x-filterable":true,"type":"boolean"}},{"name":"search","in":"query","description":"Search phone numbers by friendly name, phone number or dedicated line agent ID","required":false,"example":"*sales*","schema":{"type":"string","x-search_operators":["*"],"x-search_fields":["friendly_name","phone_number","dedicated_line_agent_id"]}},{"name":"search_fields","in":"query","required":false,"schema":{"type":"string","default":"friendly_name,phone_number"}},{"name":"order_by","in":"query","required":false,"schema":{"type":"string","default":"friendly_name:asc,phone_number:asc","x-sorting_default_order":"asc","x-sorting_fields":["friendly_name","phone_number"]}}],"tags":["Phone Details"],"responses":{"200":{"description":"List of numbers for the account","content":{"application/json":{"schema":{"type":"object","required":["total","page","count","per_page","_embedded","_links"],"properties":{"total":{"type":"integer"},"page":{"type":"integer"},"per_page":{"type":"integer"},"count":{"type":"integer"},"_embedded":{"type":"object","required":["phone_numbers"],"properties":{"phone_numbers":{"type":"array","items":{"type":"object","required":["id","phone_number","friendly_name","dedicated_line","sip","vcid","capabilities"],"properties":{"id":{"type":"string","description":"the ID for the phone number"},"phone_number":{"type":"string","description":"the phone number in E.164 format"},"friendly_name":{"type":"string","description":"the friendly name for the phone number"},"dedicated_line":{"type":"boolean","description":"if the phone number is a dedicated line or not"},"dedicated_line_agent_id":{"type":"string","description":"the agent ID associated to the dedicated line"},"sip":{"type":"boolean","description":"if the phone number is SIP"},"vcid":{"type":"boolean","description":"if the phone number is a VCID (verified caller ID)"},"capabilities":{"type":"array","description":"The phone number's supported capabilities (e.g. SMS, Voice, MMS, etc.)"}}}}}},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}},"first":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}},"next":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}},"previous":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}},"last":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}}}}}},"example":{"total":2,"page":2,"count":2,"per_page":2,"_embedded":{"phone_numbers":[{"id":"59df62c81507b35a7cf2bbd3","phone_number":"+351233391919","friendly_name":"Phone Number Example 1","dedicated_line":false,"sip":false,"vcid":true,"capabilities":["mms","sms"]},{"id":"59df62cf1507b35a7cf2bbd4","phone_number":"+351213967870","friendly_name":"Phone Number Example 2","dedicated_line":true,"dedicated_line_agent_id":"61b85d571d503a77cf35b135","sip":true,"vcid":false,"capabilities":["fax","voice"]}]},"_links":{"self":{"href":"https://api-docs.talkdesk.org/phone-details/numbers?page=2&per_page=2"},"first":{"href":"https://api-docs.talkdesk.org/phone-details/numbers?page=1&per_page=2"},"next":{"href":"https://api-docs.talkdesk.org/phone-details/numbers?page=3&per_page=2"},"previous":{"href":"https://api-docs.talkdesk.org/phone-details/numbers?page=1&per_page=2"},"last":{"href":"https://api-docs.talkdesk.org/phone-details/numbers?page=3&per_page=2"}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1394000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1394001","message":"Invalid JWT."}}}},"403":{"description":"Forbidden access","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1394003","message":"Required scopes are missing."}}}},"405":{"description":"Method not allowed","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1394005","message":"Method not allowed."}}}}}}},"/phone-details/numbers/{id}":{"get":{"description":"Retrieve a number details","security":[{"EarlyAccess":["phone-details:read"]}],"parameters":[{"name":"Authorization","in":"header","description":"Authorization header containing the JWT generated by API Gateway","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"The number id","required":true,"schema":{"type":"string"}}],"tags":["Phone Details"],"responses":{"200":{"description":"Successfully retrieved the requested number details","content":{"application/json":{"schema":{"type":"object","required":["id","phone_number","friendly_name","dedicated_line","sip","vcid","capabilities"],"properties":{"id":{"type":"string","description":"the ID for the phone number"},"phone_number":{"type":"string","description":"the phone number in E.164 format"},"friendly_name":{"type":"string","description":"the friendly name for the phone number"},"dedicated_line":{"type":"boolean","description":"if the phone number is a dedicated line or not"},"dedicated_line_agent_id":{"type":"string","description":"the agent ID associated to the dedicated line"},"sip":{"type":"boolean","description":"if the phone number is SIP"},"vcid":{"type":"boolean","description":"if the phone number is a VCID (verified caller ID)"},"capabilities":{"type":"array","description":"The phone number's supported capabilities (e.g. SMS, Voice, MMS, etc.)"}}},"example":{"id":"59df62c81507b35a7cf2bbd3","phone_number":"+351233391919","friendly_name":"Phone Number Example 1","dedicated_line":false,"sip":false,"vcid":true,"capabilities":["mms","sms"]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1394001","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1394003","message":"Required scopes are missing."}}}},"404":{"description":"Number was not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1394004","message":"The requested resource was not found. (Not Found)"}}}}}}},"/fsi-insurance-connections/automated-notifications":{"post":{"tags":["FSI Insurance Connections"],"summary":"Create and publish an event to the automated-notifications system.","description":"Create and publish an event to the automated-notifications system.","security":[{"GA":["fsi-insurance-connections-automated-notifications:write"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["type","external_system","primary_date","time_zone","contacts"],"type":"object","properties":{"external_id":{"description":"The external id of the Event.","type":"string","minLength":1},"correlation_id":{"description":"The id used to correlate multiple Events.","type":"string","minLength":1},"type":{"description":"The type of the Event.","type":"string","minLength":1},"external_system":{"description":"Name of the external system publising the Event.","type":"string","minLength":1},"time_zone":{"description":"The timezone offset of the Event. It is used for example with the Rule's calendar preferences.","type":"string","minLength":1},"primary_date":{"description":"A date in UTC to use to schedule the notifications. The primary date is required.","type":"string","format":"date-time","minLength":10},"secondary_date":{"description":"A secondary date in UTC to use to schedule the notifications (can be used for example to represent the end date). It is not required.","type":"string","format":"date-time","minLength":10},"contacts":{"description":"The list of Contacts associated with the Event.","type":"array","items":{"required":["name","preferred_channel","channels"],"type":"object","properties":{"name":{"description":"The name of the Contact.","type":"string","minLength":1,"example":"John Doe"},"preferred_channel":{"description":"The preferred channel to use when sending notifications.","type":"string","minLength":1,"example":"email"},"channels":{"description":"The list of channels of the Contact.","type":"array","items":{"required":["type","uri"],"type":"object","properties":{"type":{"description":"The type of channel.","type":"string","minLength":1,"enum":["EMAIL","SMS","VOICE"]},"uri":{"description":"The channel uri (for instance email address or phone number).","type":"string","minLength":1,"example":"mailto:john.doe@talkdesk.com"}}},"minItems":1}}},"minItems":1},"data":{"description":"Data with specific properties of the Event.","type":"object","additionalProperties":{}}}},"example":{"type":"appointment_booked","source":"ehr_epic","time_zone":"+00:00","primary_date":"2021-02-22T11:00:00.000Z","secondary_date":"2021-02-22T11:30:00.000Z","contacts":[{"name":"John Doe","preferred_channel":"email","channels":[{"type":"EMAIL","uri":"mailto:john.doe@talkdesk.com"}]}],"data":{"assigned_doctor":"Jane Doe"}}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1930001","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1930002","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1930003","message":"Required scopes are missing."}}}}}}},"/fsi-desktop-app/session":{"get":{"tags":["FSI Desktop App"],"summary":"Retrieves a session","description":"If a session exists for the given account ID and agent ID (both extracted from the JWT, aid and uid, respectively),\n - the agent nonce (encrypted with an the RSA public key (RSA public-private key pair generated when creating the session)) is returned;\n - otherwise a Not Found is thrown\n","security":[{"EarlyAccess":["fsi-desktop-app-session:read"]}],"responses":{"200":{"description":"The object with both agent ID and encrypted session nonce","content":{"application/json":{"schema":{"type":"object","description":"Session retrieved containing the agent ID and the nonce RSA encrypted.","required":["id","nonce"],"properties":{"id":{"type":"string","description":"The agent ID"},"nonce":{"type":"string","description":"The nonce RSA encrypted"}}},"example":{"id":"60ae0cb2dde6f620e0dc4af3","nonce":"ksrBPS1gjTEn44P+ba7T/LCWSkiR8hUG6cRr+w4G9at/Ko9hnGnMeYj2dx1YKiWGFgRq22xT5DcQ4nsj0A16rg=="}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2120400","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2120401","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2120403","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2120404","message":"Resource not found."}}}}}},"post":{"tags":["FSI Desktop App"],"summary":"Creates a session","description":"It creates a session for a given the session_key in the format ::::, where:\n - : uid\n - : account ID\n - : agent ID\nThe endpoint validates that both account ID and agent ID provided in sesseion_key match with account ID and agent ID extracted from JWT (aid and uid, respectively):\n - if yes, a RSA public-private key pair is generated and the nonce is saved encrypted with the public key, and returned the private_key, for later decode the nonce.\n - otherwise a Bad Request is thrown.\n","security":[{"EarlyAccess":["fsi-desktop-app-session:write"]}],"responses":{"200":{"description":"The object with the encrypted RSA private key","content":{"application/json":{"schema":{"type":"object","description":"Session created","required":["private_key"],"properties":{"private_key":{"type":"string","description":"The RSA private key"}}},"example":{"private_key":"MIIBVQIBADANBgkqhkiG9w0BAQEFAASCAT8wggE7AgEAAkEA1yhxGeHSlVlpMYMH0XLcjshnONeLjrpiEWHZza+QvAw2G"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2120400","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2120401","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2120403","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2120404","message":"Resource not found."}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"The session request body","required":["session_key"],"properties":{"session_key":{"type":"string","description":"The session key has to be in the format ::::"}}},"example":{"session_key":"abcdefgh::5fce39cfe2f4600001d3f625::60ae0cb2dde6f620e0dc4af3"}}}}}},"/cp/core/profiles":{"post":{"tags":["Cp"],"summary":"Create a Profile Data Record","description":"Create a Profile Data Record","operationId":"CreateAProfileDataRecord","security":[{"EarlyAccess":["profile-data:write"]}],"requestBody":{"description":"The profile data to be created.","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"customer_id":{"type":"string","description":"profile customer id"},"id_data":{"type":"array","description":"profile field ID data"},"custom_contact_data":{"type":"array","description":"profile field custom contact data"},"contact":{"type":"array","description":"contact data"}}},"example":{"customer_id":"61c28e0e4e20b0e45ed3a60a","id_data":{"patient_id":"00003","loyalty_id":"","ssn":"dfsdfsdd"},"custom_contact_data":{"name":"tony","dob":"2022-08-23 00:00:00"},"contact":{"name":"Kamasi","emails":[{"email":"Kamasi Washington7@foo.com"}],"phones":[{"number":"+35190129888"},{"number":"+35190129889"}],"company":"ACME","address":"1, ACME Street, Somewhere","photo_url":"http://acme.com/avatar.jpg","industry":"runner improvement","location":"ACME HQ","title":"Big Kahuna","tags":["test1"],"integrations":[{"integration_id":"zendesk012","external_id":"zd00001234","external_url":"http://zendesk/zd00001234","contact_type":"boss","external_sync_state":"some_state"}],"websites":[{"url":"http://acme.com"}],"social":[{"name":"twitter","handle":"ACME"},{"name":"twitter1","handle":"ACME1"}],"custom_fields":[{"key":"cv.pdf","value":"muitos_bytes"}],"scope":["57040de61507b33605000001"]}}}}},"responses":{"200":{"description":"create profile date succeeded","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"profile data id"},"is_deleted":{"type":"integer","format":"int32","description":"Field is deleted"},"create_at":{"type":"string","format":"date-time","description":"Create at"},"create_by":{"type":"string","description":"Create by"},"update_at":{"type":"string","format":"date-time","description":"Update at"},"update_by":{"type":"string","description":"Update by"},"master_id_event_type":{"type":"string","description":"master id event type"},"master_id":{"type":"string","description":"master id"},"user_id":{"type":"string","description":"user id"},"occur_at":{"type":"string","format":"date-time","description":"occur at"},"event_type":{"type":"string","description":"event type"},"customer_id":{"type":"string","description":"customer id"},"json_content":{"type":"string","description":"json content"}}},"example":{"id":"1559725321533366276","master_id_event_type":"ae4c7469af0a4c9d81c3444e03de9930_1559725321533366274","master_id":"ae4c7469af0a4c9d81c3444e03de9930","user_id":"","occur_at":"2022-08-19T09:43:04Z","event_type":"1559725321533366274","customer_id":"61c28e0e4e20b0e45ed3a60a","json_content":"{\"patient_id\":\"00003\",\"loyout_id\":\"00004\",\"ssn\":\"dfsdfsdd\",\"name\":\"tony\",\"dob\":\"2022-08-23 00:00:00\"}","create_at":"2022-08-19T09:43:04Z","create_by":"61d5ac03d5196f39bca3d161","is_deleted":0,"update_at":"2022-08-19T09:43:04Z","update_by":"61d5ac03d5196f39bca3d161"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3300100","message":"Bad Request"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3300101","message":"Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3300102","message":"Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3300103","message":"Not Found"}}}},"500":{"description":"Internal Server Error.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3300107","message":"Internal Server Error."}}}}}},"patch":{"tags":["Cp"],"summary":"edit profile data by id","operationId":"EditProfileDataById","description":"update profile data","security":[{"EarlyAccess":["profile-data:write"]}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"customer_id":{"type":"string","description":"profile customer id"},"profile_data":{"type":"array","description":"profile_data data"},"id_name":{"type":"string","description":"profile data id name"},"id_value":{"type":"string","description":"profile data id value"}}},"example":{"profile_data":{"patient_id":"003","loyout_id":"00004","ssn":"dfsdfsdd","name":"tom"},"id_name":"patient_id","id_value":"000001","customer_id":"61c28e0e4e20b0e45ed3a60a"}}},"required":true},"responses":{"200":{"description":"profile data","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"profile data id"},"is_deleted":{"type":"integer","format":"int32","description":"Field is deleted"},"create_at":{"type":"string","format":"date-time","description":"Create at"},"create_by":{"type":"string","description":"Create by"},"update_at":{"type":"string","format":"date-time","description":"Update at"},"update_by":{"type":"string","description":"Update by"},"master_id_event_type":{"type":"string","description":"master id event type"},"master_id":{"type":"string","description":"master id"},"user_id":{"type":"string","description":"user id"},"occur_at":{"type":"string","format":"date-time","description":"occur at"},"event_type":{"type":"string","description":"event type"},"customer_id":{"type":"string","description":"customer id"},"json_content":{"type":"string","description":"json content"}}},"example":{"id":"1559725321533366276","master_id_event_type":"ae4c7469af0a4c9d81c3444e03de9930_1559725321533366274","master_id":"ae4c7469af0a4c9d81c3444e03de9930","user_id":"","occur_at":"2022-08-19T09:43:04Z","event_type":"1559725321533366274","customer_id":"61c28e0e4e20b0e45ed3a60a","json_content":"{\"patient_id\":\"00003\",\"loyout_id\":\"00004\",\"ssn\":\"dfsdfsdd\",\"name\":\"tony\",\"dob\":\"2022-08-23 00:00:00\"}","create_at":"2022-08-19T09:43:04Z","create_by":"61d5ac03d5196f39bca3d161","is_deleted":0,"update_at":"2022-08-19T09:43:04Z","update_by":"61d5ac03d5196f39bca3d161"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3300100","message":"Bad Request"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3300101","message":"Unauthorized"}}}},"403":{"description":"Forbidden Error","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3300102","message":"Forbidden"}}}},"404":{"description":"Connection not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3300103","message":"Not Found"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3300107","message":"Internal Server Error."}}}}}},"delete":{"tags":["Cp"],"summary":"Delete a given contact profile within a tenant by providing ID type and ID value","description":"Delete a given contact profile within a tenant by providing ID type and ID value","operationId":"DeleteAGivenContactProfile","security":[{"EarlyAccess":["profile-data:write"]}],"parameters":[{"name":"Authorization","in":"header","description":"Authorization header containing the JWT generated by API Gateway","required":true,"schema":{"type":"string"}},{"name":"id_type","in":"query","description":"id type","required":false,"schema":{"type":"string"}},{"name":"id_value","in":"query","description":"id value","required":false,"schema":{"type":"string"}},{"name":"customer_id","in":"query","description":"customer id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Delete a given contact profile within a tenant by providing ID type and ID value successfully"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3300100","message":"Bad Request"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3300101","message":"Unauthorized"}}}},"403":{"description":"Forbidden Error","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3300102","message":"Forbidden"}}}},"404":{"description":"Connection not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3300103","message":"Not Found"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3300107","message":"Internal Server Error."}}}}}}},"/cp/core/profiles/batch":{"post":{"tags":["Cp"],"summary":"Batch Create a Profile Data Record","description":"Batch Create a Profile Data Record","operationId":"BatchCreateAProfileDataRecord","security":[{"EarlyAccess":["profile-data:write"]}],"requestBody":{"description":"The profile data to be batch created.","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"customer_id":{"type":"string","description":"profile customer id"},"data":{"type":"array","description":"batch profile data"}}},"example":{"customer_id":"61c28e0e4e20b0e45ed3a60a","data":[{"id_data":{"patient_id":"00003","loyout_id":"00004","ssn":"saddfs"},"custom_contact_data":{"name":"tony","dob":"2022-08-23 00:00:00"},"contact":{"name":"Kamasi Washington50","emails":[{"email":"Kamasi Washington7@foo.com"}],"phones":[{"number":"+35190129888"},{"number":"+35190129889"}],"company":"TD","address":"1, ACME Street, Somewhere","photo_url":"http://acme.com/avatar.jpg","industry":"Road","location":"ACME HQ","title":"Big Kahuna","tag":["test1"],"integrations":[{"integration_id":"zendesk012","external_id":"zd00001234","external_url":"http://zendesk/zd00001234","contact_type":"boss","external_sync_state":"some_state"}],"websites":[{"url":"http://acme.com"}],"social":[{"name":"twitter","handle":"ACME"},{"name":"twitter1","handle":"ACME1"}],"custom_fields":[{"key":"cv.pdf","value":"muitos_bytes"}],"scope":["57040de61507b33605000001"]}}]}}}},"responses":{"200":{"description":"batch create profile date succeeded","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"profile data create massage"},"success":{"type":"boolean","description":"is create ok"},"data":{"type":"object","description":"create response data"}}},"example":{"message":"Created successfully","success":true,"data":{"error_message_volist":null,"id":"1594525750766972930","customer_id":"61c28e0e4e20b0e45ed3a60a","code":"profile_batch_task","status":10,"is_deleted":0,"create_at":"2022-11-21T02:58:58Z","create_by":"61d5ac03d5196f39bca3d161","update_at":"2022-11-21T02:58:58Z","update_by":"61d5ac03d5196f39bca3d161","total_count":null,"success_count":null}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3300100","message":"Bad Request"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3300101","message":"Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3300102","message":"Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3300103","message":"Not Found"}}}},"500":{"description":"Internal Server Error.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3300107","message":"Internal Server Error."}}}}}}},"/cp/core/events":{"post":{"tags":["Cp"],"summary":"create event data","operationId":"CreateEventData","description":"create event data","security":[{"EarlyAccess":["event-data:write"]}],"parameters":[{"name":"Authorization","in":"header","description":"Authorization header containing the JWT generated by API Gateway","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"customer_id":{"type":"string","description":"customer id"},"entity_name":{"type":"string","description":"entity name"},"event_data":{"type":"object","description":"event data"}}},"example":{"customer_id":"61c28e0e4e20b0e45ed3a60a","entity_name":"test","event_data":{"genesimonis4":"00004","genesimonis5":"00005","genesimonis6":"00006"}}}},"required":true},"responses":{"201":{"description":"event schema","content":{"application/json":{"schema":{"type":"object","properties":{"master_id_event_type":{"type":"string","description":"master id event type"},"master_id":{"type":"string","description":"master id"},"id":{"type":"string","description":"id"},"user_id":{"type":"string","description":"user id"},"occur_at":{"type":"string","format":"date-time","description":"occur at"},"event_type":{"type":"string","description":"event type"},"customer_id":{"type":"string","description":"customer id"},"json_content":{"type":"string","description":"json content"},"create_at":{"type":"string","format":"date-time","description":"create at"},"create_by":{"type":"string","description":"create by"},"is_deleted":{"type":"integer","description":"is deleted"},"update_at":{"type":"string","format":"date-time","description":"update at"},"update_by":{"type":"string","description":"update by"}}},"example":{"id":"1559821923602231278","master_id_event_type":"ae4c7469af0a4c9d81c3444e03de9930_1559821923602231297","master_id":"ae4c7469af0a4c9d81c3444e03de9930","user_id":"00004","occur_at":"2022-08-19T10:09:24Z","event_type":"1559821923602231297","customer_id":"61c28e0e4e20b0e45ed3a60a","json_content":"{\"gene.simonis4\":\"00004\",\"gene.simonis6\":\"00007\",\"gene.simonis5\":\"test8\"}","create_at":"2022-08-19T10:09:24Z","create_by":"61d5ac03d5196f39bca3d161","is_deleted":0,"update_at":"2022-08-19T10:09:24Z","update_by":"61d5ac03d5196f39bca3d161"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3300100","message":"Bad Request"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3300101","message":"Unauthorized"}}}},"403":{"description":"Forbidden Error","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3300102","message":"Forbidden"}}}},"404":{"description":"Connection not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3300103","message":"Not Found"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3300107","message":"Internal Server Error."}}}}}},"delete":{"tags":["Cp"],"summary":"Delete Event Data","operationId":"DeleteEventData","description":"Delete Event Data","security":[{"EarlyAccess":["event-data:write"]}],"parameters":[{"name":"Authorization","in":"header","description":"Authorization header containing the JWT generated by API Gateway","required":true,"schema":{"type":"string"}},{"name":"id_type","in":"query","description":"id type","required":true,"schema":{"type":"string"}},{"name":"id_value","in":"query","description":"id value","required":true,"schema":{"type":"string"}},{"name":"event_name","in":"query","description":"event name","required":true,"schema":{"type":"string"}},{"name":"customer_id","in":"query","description":"customer id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Deleted event field successfully"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3300100","message":"Bad Request"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3300101","message":"Unauthorized"}}}},"403":{"description":"Forbidden Error","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3300102","message":"Forbidden"}}}},"404":{"description":"Connection not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3300103","message":"Not Found"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3300107","message":"Internal Server Error."}}}}}}},"/cp/core/events/batch":{"post":{"tags":["Cp"],"summary":"Batch Create a Event Data Record","description":"Batch Create a Event Data Record","operationId":"BatchCreateAEventDataRecord","security":[{"EarlyAccess":["event-data:write"]}],"requestBody":{"description":"The event data to be batch created.","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"customer_id":{"type":"string","description":"event customer id"},"data":{"type":"array","description":"batch event data"},"entity_name":{"type":"string","description":"event name"}}},"example":{"customer_id":"61c28e0e4e20b0e45ed3a60a","entity_name":"appointment_event","data":[{"occur_at":"1669282814665","create_time":"2022-11-21T02:58:58Z","location_test":"location1","insurance_test":"insurance1","patient_id":"0000000000"}]}}}},"responses":{"200":{"description":"batch create profile date succeeded","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"profile data create massage"},"success":{"type":"boolean","description":"is create ok"},"data":{"type":"object","description":"create response data"}}},"example":{"message":"Created successfully","success":true,"data":{"error_message_volist":null,"id":"1594525750766972930","customer_id":"61c28e0e4e20b0e45ed3a60a","code":"profile_batch_task","status":10,"is_deleted":0,"create_at":"2022-11-21T02:58:58Z","create_by":"61d5ac03d5196f39bca3d161","update_at":"2022-11-21T02:58:58Z","update_by":"61d5ac03d5196f39bca3d161","total_count":null,"success_count":null}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3300100","message":"Bad Request"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3300101","message":"Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3300102","message":"Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3300103","message":"Not Found"}}}},"500":{"description":"Internal Server Error.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3300107","message":"Internal Server Error."}}}}}}},"/cfm/flows/external/results":{"post":{"tags":["Cfm"],"summary":"Collect feedback data","description":"Collect feedback data","operationId":"CollectFeedbackData","security":[{"GA":["cfm-public:write"]}],"parameters":[{"name":"Authorization","in":"header","description":"Authorization header containing the JWT generated by API Gateway","required":true,"schema":{"type":"string","minLength":1}}],"requestBody":{"description":"Collect feedback survey data.","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"interaction_id":{"type":"string","minLength":1,"maxLength":100,"description":"talkdesk conversation id"},"survey_channel":{"type":"string","minLength":1,"maxLength":256,"description":"currently, only the Digital Connect channel is supported, no need to set it when calling api to end the survey"},"survey_name":{"type":"string","minLength":1,"maxLength":256,"description":"general name of the feedback survey, no need to set it when calling api to end the survey"},"question":{"type":"string","minLength":1,"maxLength":2048,"description":"feedback survey question by the system, no need to set it when calling api to end the survey"},"answer":{"type":"string","minLength":1,"maxLength":2048,"description":"user answer, no need to set it when calling api to end the survey"},"question_type":{"type":"string","minLength":1,"maxLength":256,"description":"currently contains 3 question types CSAT/NPS/OPEN_TEXT, no need to set it when calling api to end the survey"},"is_kpi":{"type":"boolean","description":"csat is kpi need to set true, nps is kpi need to set true, no need to set it when calling api to end the survey"},"survey_is_end":{"type":"boolean","description":"survey finish need to be set to true, if the survey is not finished, there's no need to set it."}}},"example":{"interaction_id":"digital-connect-ad11a072-aa1e-47d3-97e1-2c4b00a9ed3b","survey_channel":"CHAT","survey_name":"test-flow","question":"On a scale of 1 (least satisfied) to 5 (most satisfied) please rate your overall experience. To opt-out, please reply STOP.","answer":"4","question_type":"CSAT","is_kpi":true}}}},"responses":{"200":{"description":"collect feedback data succeeded"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"4300001","message":"Bad request - The request contains invalid field(s)."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"4300000","message":"Invalid authentication"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"4300003","message":"Invalid permissions"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"4300002","message":"Resource not found"}}}},"500":{"description":"Internal Server Error.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"4300004","message":"Internal Server Error"}}}}}}},"/campaigns":{"post":{"description":"Create or duplicate campaign","x-namespace":"/campaigns","tags":["Campaigns"],"security":[{"EarlyAccess":["campaigns:write","campaigns:read"]}],"parameters":[{"name":"source_id","in":"query","description":"Id of the campaign to be duplicated","required":false,"schema":{"type":"string","maxLength":36}}],"requestBody":{"description":"Campaign configuration parameters","required":true,"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string","maxLength":35,"description":"Campaign name"},"dialing_mode":{"description":"Type of dialing mode","type":"string","maxLength":35,"enum":["PREDICTIVE","PREVIEW"]},"priority":{"type":"integer","minimum":1,"maximum":10},"dialing_mode_configuration":{"type":"object","required":["max_ring_time_in_secs"],"properties":{"answering_machine_detection":{"type":"boolean","description":"The flag to decide if disconnects calls that reach answering machines or voicemails. Only to be used in Predictive mode."},"amd_metadata":{"type":"boolean","description":"The flag to decide if an additional in-house AMD layer based on Metadata that will improve the initial AMD decision in Dialer. Only to be used in Predictive mode."},"max_abandonment_rate":{"type":"integer","description":"Maximum rate of abandoned calls. Only to be used in Predictive mode.","minimum":1,"maximum":100},"max_dialing_ratio":{"type":"integer","description":"Maximum number of calls launched per agent. Only to be used in Predictive mode.","minimum":1,"maximum":3},"max_ring_time_in_secs":{"type":"integer","description":"The time in which if the calls are not answered they are disconnected","minimum":6,"maximum":120},"abandonment_timeout":{"type":"object","required":["amount"],"properties":{"amount":{"type":"integer","description":"The time in which automatically hangs up answered calls that haven't been connected to an agent. Unit in seconds. Only to be used in Predictive mode.","minimum":2,"maximum":30}}}}},"dialing_strategy":{"type":"object","required":["max_attempts","retry_period","retry_time_unit","calling_hours","dispositions"],"properties":{"max_skip_attempts":{"type":"integer","description":"The maximum number of times that an agent can skip a call.","minimum":0,"maximum":20},"strategy_type":{"type":"string","maxLength":35,"description":"The strategy on how the records will be dialed.","enum":["AUTOMATIC","MANUAL"]},"preview_timeout":{"type":"integer","description":"The time in seconds that the preview context will be available to the agent.","minimum":6,"maximum":300},"max_attempts":{"type":"integer","description":"The maximum number of non-final call attempts each record may receive.","minimum":1,"maximum":100},"retry_period":{"type":"integer","description":"Time between non-final call attempts.","minimum":1,"maximum":2592000},"retry_time_unit":{"type":"string","maxLength":35,"description":"The time unit for the retry_period","enum":["SECONDS","MINUTES","HOURS","DAYS"]},"calling_hours":{"type":"array","description":"Set of rules to be applied based on location of the records lists.","items":{"type":"object","required":["from","to","week_days"],"properties":{"from":{"type":"string","maxLength":8,"format":"time","description":"start time format hh:MM:ss"},"to":{"type":"string","maxLength":8,"format":"time","description":"end time format hh:MM:ss"},"week_days":{"type":"array","items":{"type":"string","maxLength":35,"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]}}}}},"dispositions":{"type":"object","description":"System Dispositions to be available for defined campaign","required":["busy","no_answer","invalid_number"],"properties":{"busy":{"type":"object","description":"busy disposition settings","required":["status_after_call","custom"],"properties":{"status_after_call":{"type":"string","maxLength":35,"enum":["FINAL","RETRY"]},"custom":{"type":"boolean"},"max_attempts":{"type":"integer","minimum":1,"maximum":100},"retry_period":{"type":"integer","minimum":1,"maximum":2592000},"retry_period_time_unit":{"type":"string","maxLength":35,"enum":["SECONDS","MINUTES","HOURS","DAYS"]}}},"no_answer":{"type":"object","description":"no_answer disposition settings","required":["status_after_call","custom"],"properties":{"status_after_call":{"type":"string","maxLength":35,"enum":["FINAL","RETRY"]},"custom":{"type":"boolean"},"max_attempts":{"type":"integer","minimum":1,"maximum":100},"retry_period":{"type":"integer","minimum":1,"maximum":2592000},"retry_period_time_unit":{"type":"string","maxLength":35,"enum":["SECONDS","MINUTES","HOURS","DAYS"]}}},"abandoned":{"type":"object","description":"abandonment disposition settings","required":["status_after_call","custom"],"properties":{"status_after_call":{"type":"string","maxLength":35,"enum":["FINAL","RETRY"]},"custom":{"type":"boolean"},"max_attempts":{"type":"integer","minimum":1,"maximum":100},"retry_period":{"type":"integer","minimum":1,"maximum":2592000},"retry_period_time_unit":{"type":"string","maxLength":35,"enum":["SECONDS","MINUTES","HOURS","DAYS"]}}},"hangup_before_connection":{"type":"object","description":"hangup_before_connection disposition settings","required":["status_after_call","custom"],"properties":{"status_after_call":{"type":"string","maxLength":35,"enum":["FINAL","RETRY"]},"custom":{"type":"boolean"},"max_attempts":{"type":"integer","minimum":1,"maximum":100},"retry_period":{"type":"integer","minimum":1,"maximum":2592000},"retry_period_time_unit":{"type":"string","maxLength":35,"enum":["SECONDS","MINUTES","HOURS","DAYS"]}}},"agent_hangup_before_connection":{"type":"object","description":"agent_hangup_before_connection disposition settings","required":["status_after_call","custom"],"properties":{"status_after_call":{"type":"string","maxLength":35,"enum":["FINAL","RETRY"]},"custom":{"type":"boolean"},"max_attempts":{"type":"integer","minimum":1,"maximum":100},"retry_period":{"type":"integer","minimum":1,"maximum":2592000},"retry_period_time_unit":{"type":"string","maxLength":35,"enum":["SECONDS","MINUTES","HOURS","DAYS"]}}},"answering_machine_detection":{"type":"object","description":"answering_machine_detection disposition settings","required":["status_after_call","custom"],"properties":{"status_after_call":{"type":"string","maxLength":35,"enum":["FINAL","RETRY"]},"custom":{"type":"boolean"},"max_attempts":{"type":"integer","minimum":1,"maximum":100},"retry_period":{"type":"integer","minimum":1,"maximum":2592000},"retry_period_time_unit":{"type":"string","maxLength":35,"enum":["SECONDS","MINUTES","HOURS","DAYS"]}}},"invalid_number":{"description":"invalid number disposition setting","type":"object","required":["status_after_call"],"properties":{"status_after_call":{"type":"string","maxLength":35,"enum":["FINAL"]}}}}},"record_chain":{"type":"array","description":"Set of rules to be applied based on the phone type. Must have exactly one of each phone type (see type enum).","items":{"description":"Record chaining settings for each phone type.","type":"object","required":["type","max_attempts"],"properties":{"type":{"type":"string","description":"Phone Type.","enum":["HOME","OFFICE","MOBILE","EXTRA_1","EXTRA_2","EXTRA_3"]},"max_attempts":{"type":"integer","minimum":1,"maximum":100,"description":"Number of attempts"},"retry_period":{"type":"integer","minimum":1,"maximum":2592000,"description":"Time between call attempts for phones of this type."},"retry_time_unit":{"type":"string","description":"The time unit for the retry_period.","enum":["SECONDS","MINUTES","HOURS","DAYS"]}}}},"lists_sorting_criteria":{"type":"string","maxLength":10,"description":"The config on how the records will be sorted","enum":["FIFO","LIFO"]}}}}},"example":{"name":"50% discount on culinary courses","dialing_mode":"PREDICTIVE","priority":5,"dialing_mode_configuration":{"answering_machine_detection":false,"amd_metadata":false,"max_abandonment_rate":2,"max_dialing_ratio":3,"max_ring_time_in_secs":6,"abandonment_timeout":{"amount":14}},"dialing_strategy":{"max_skip_attempts":4,"strategy_type":"AUTOMATIC","preview_timeout":100,"max_attempts":99,"retry_period":100,"retry_time_unit":"SECONDS","calling_hours":[{"from":"01:00:00","to":"02:00:00","week_days":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]}],"dispositions":{"busy":{"status_after_call":"RETRY","custom":false,"max_attempts":45,"retry_period":123,"retry_period_time_unit":"SECONDS"},"no_answer":{"status_after_call":"RETRY","custom":false,"max_attempts":45,"retry_period":123,"retry_period_time_unit":"SECONDS"},"abandoned":{"status_after_call":"RETRY","custom":false,"max_attempts":45,"retry_period":123,"retry_period_time_unit":"SECONDS"},"hangup_before_connection":{"status_after_call":"RETRY","custom":false,"max_attempts":45,"retry_period":123,"retry_period_time_unit":"SECONDS"},"agent_hangup_before_connection":{"status_after_call":"RETRY","custom":false,"max_attempts":45,"retry_period":123,"retry_period_time_unit":"SECONDS"},"answering_machine_detection":{"status_after_call":"RETRY","custom":false,"max_attempts":45,"retry_period":123,"retry_period_time_unit":"SECONDS"},"invalid_number":{"status_after_call":"FINAL"}},"record_chain":[{"type":"HOME","max_attempts":5,"retry_period":300,"retry_period_time_unit":"MINUTES"},{"type":"OFFICE","max_attempts":3,"retry_period":123,"retry_period_time_unit":"SECONDS"},{"type":"MOBILE","max_attempts":2,"retry_period":213,"retry_period_time_unit":"SECONDS"},{"type":"EXTRA_1","max_attempts":2,"retry_period":213,"retry_period_time_unit":"SECONDS"},{"type":"EXTRA_2","max_attempts":2,"retry_period":213,"retry_period_time_unit":"SECONDS"},{"type":"EXTRA_3","max_attempts":2,"retry_period":213,"retry_period_time_unit":"SECONDS"}],"ivr_enabled":true,"lists_sorting_criteria":"FIFO"}}}}},"responses":{"201":{"description":"Campaign created successfully","content":{"application/hal+json":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","maxLength":36},"name":{"type":"string","minLength":3,"maxLength":35},"dialing_mode":{"type":"string","maxLength":35,"enum":["PREDICTIVE","PREVIEW"]},"priority":{"type":"integer","minimum":1,"maximum":10},"run_once":{"type":"boolean"},"action_required":{"type":"boolean"},"status":{"type":"string","maxLength":35,"enum":["INCOMPLETE","READY","RUNNING","PAUSED"]},"dialing_mode_configuration":{"type":"object","required":["max_ring_time_in_secs"],"properties":{"answering_machine_detection":{"type":"boolean","description":"The flag to decide if disconnects calls that reach answering machines or voicemails. Only to be used in Predictive mode."},"amd_metadata":{"type":"boolean","description":"The flag to decide if an additional in-house AMD layer based on Metadata that will improve the initial AMD decision in Dialer. Only to be used in Predictive mode."},"max_abandonment_rate":{"type":"integer","description":"Maximum rate of abandoned calls. Only to be used in Predictive mode.","minimum":1,"maximum":100},"max_dialing_ratio":{"type":"integer","description":"Maximum number of calls launched per agent. Only to be used in Predictive mode.","minimum":1,"maximum":3},"max_ring_time_in_secs":{"type":"integer","description":"The time in which if the calls are not answered they are disconnected","minimum":6,"maximum":120},"abandonment_timeout":{"type":"object","required":["amount"],"properties":{"amount":{"type":"integer","description":"The time in which automatically hangs up answered calls that haven't been connected to an agent. Unit in seconds. Only to be used in Predictive mode.","minimum":2,"maximum":30}}}}},"dialing_strategy":{"type":"object","required":["max_attempts","retry_period","retry_time_unit","calling_hours","dispositions"],"properties":{"max_skip_attempts":{"type":"integer","description":"The maximum number of times that an agent can skip a call.","minimum":0,"maximum":20},"strategy_type":{"type":"string","maxLength":35,"description":"The strategy on how the records will be dialed.","enum":["AUTOMATIC","MANUAL"]},"preview_timeout":{"type":"integer","description":"The time in seconds that the preview context will be available to the agent.","minimum":6,"maximum":300},"max_attempts":{"type":"integer","description":"The maximum number of non-final call attempts each record may receive.","minimum":1,"maximum":100},"retry_period":{"type":"integer","description":"Time between non-final call attempts.","minimum":1,"maximum":2592000},"retry_time_unit":{"type":"string","maxLength":35,"description":"The time unit for the retry_period","enum":["SECONDS","MINUTES","HOURS","DAYS"]},"calling_hours":{"type":"array","description":"Set of rules to be applied based on location of the records lists.","items":{"type":"object","required":["from","to","week_days"],"properties":{"from":{"type":"string","maxLength":8,"format":"time","description":"start time format hh:MM:ss"},"to":{"type":"string","maxLength":8,"format":"time","description":"end time format hh:MM:ss"},"week_days":{"type":"array","items":{"type":"string","maxLength":35,"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]}}}}},"dispositions":{"type":"object","description":"System Dispositions to be available for defined campaign","required":["busy","no_answer","invalid_number"],"properties":{"busy":{"type":"object","description":"busy disposition settings","required":["status_after_call","custom"],"properties":{"status_after_call":{"type":"string","maxLength":35,"enum":["FINAL","RETRY"]},"custom":{"type":"boolean"},"max_attempts":{"type":"integer","minimum":1,"maximum":100},"retry_period":{"type":"integer","minimum":1,"maximum":2592000},"retry_period_time_unit":{"type":"string","maxLength":35,"enum":["SECONDS","MINUTES","HOURS","DAYS"]}}},"no_answer":{"type":"object","description":"no_answer disposition settings","required":["status_after_call","custom"],"properties":{"status_after_call":{"type":"string","maxLength":35,"enum":["FINAL","RETRY"]},"custom":{"type":"boolean"},"max_attempts":{"type":"integer","minimum":1,"maximum":100},"retry_period":{"type":"integer","minimum":1,"maximum":2592000},"retry_period_time_unit":{"type":"string","maxLength":35,"enum":["SECONDS","MINUTES","HOURS","DAYS"]}}},"abandoned":{"type":"object","description":"abandonment disposition settings","required":["status_after_call","custom"],"properties":{"status_after_call":{"type":"string","maxLength":35,"enum":["FINAL","RETRY"]},"custom":{"type":"boolean"},"max_attempts":{"type":"integer","minimum":1,"maximum":100},"retry_period":{"type":"integer","minimum":1,"maximum":2592000},"retry_period_time_unit":{"type":"string","maxLength":35,"enum":["SECONDS","MINUTES","HOURS","DAYS"]}}},"hangup_before_connection":{"type":"object","description":"hangup_before_connection disposition settings","required":["status_after_call","custom"],"properties":{"status_after_call":{"type":"string","maxLength":35,"enum":["FINAL","RETRY"]},"custom":{"type":"boolean"},"max_attempts":{"type":"integer","minimum":1,"maximum":100},"retry_period":{"type":"integer","minimum":1,"maximum":2592000},"retry_period_time_unit":{"type":"string","maxLength":35,"enum":["SECONDS","MINUTES","HOURS","DAYS"]}}},"agent_hangup_before_connection":{"type":"object","description":"agent_hangup_before_connection disposition settings","required":["status_after_call","custom"],"properties":{"status_after_call":{"type":"string","maxLength":35,"enum":["FINAL","RETRY"]},"custom":{"type":"boolean"},"max_attempts":{"type":"integer","minimum":1,"maximum":100},"retry_period":{"type":"integer","minimum":1,"maximum":2592000},"retry_period_time_unit":{"type":"string","maxLength":35,"enum":["SECONDS","MINUTES","HOURS","DAYS"]}}},"answering_machine_detection":{"type":"object","description":"answering_machine_detection disposition settings","required":["status_after_call","custom"],"properties":{"status_after_call":{"type":"string","maxLength":35,"enum":["FINAL","RETRY"]},"custom":{"type":"boolean"},"max_attempts":{"type":"integer","minimum":1,"maximum":100},"retry_period":{"type":"integer","minimum":1,"maximum":2592000},"retry_period_time_unit":{"type":"string","maxLength":35,"enum":["SECONDS","MINUTES","HOURS","DAYS"]}}},"invalid_number":{"description":"invalid number disposition setting","type":"object","required":["status_after_call"],"properties":{"status_after_call":{"type":"string","maxLength":35,"enum":["FINAL"]}}}}},"record_chain":{"type":"array","description":"Set of rules to be applied based on the phone type. Must have exactly one of each phone type (see type enum).","items":{"description":"Record chaining settings for each phone type.","type":"object","required":["type","max_attempts"],"properties":{"type":{"type":"string","description":"Phone Type.","enum":["HOME","OFFICE","MOBILE","EXTRA_1","EXTRA_2","EXTRA_3"]},"max_attempts":{"type":"integer","minimum":1,"maximum":100,"description":"Number of attempts"},"retry_period":{"type":"integer","minimum":1,"maximum":2592000,"description":"Time between call attempts for phones of this type."},"retry_time_unit":{"type":"string","description":"The time unit for the retry_period.","enum":["SECONDS","MINUTES","HOURS","DAYS"]}}}},"lists_sorting_criteria":{"type":"string","maxLength":10,"description":"The config on how the records will be sorted","enum":["FIFO","LIFO"]}}},"created_at":{"type":"string","format":"date-time"}},"required":["name"]}],"properties":{"_links":{"type":"object","description":"HAL API related links.","properties":{"self":{"type":"object","description":"Link to fetch the detail of the Campaign","properties":{"href":{"type":"string","maxLength":2083,"description":"Address of the resource"}},"required":["href"]},"campaigns":{"type":"object","description":"Link to fetch a list of all the campaigns","properties":{"href":{"type":"string","maxLength":2083,"description":"Address of the resources"}},"required":["href"]}},"required":["self","campaigns"]}},"required":["id","_links"]},"example":{"id":"123e4567-e89b-12d3-a456-426655440000","name":"50% discount on culinary courses","dialing_mode":"PREDICTIVE","priority":5,"run_once":true,"action_required":false,"status":"READY","dialing_mode_configuration":{"answering_machine_detection":false,"amd_metadata":false,"max_abandonment_rate":2,"max_dialing_ratio":3,"max_ring_time_in_secs":6,"abandonment_timeout":{"amount":14}},"dialing_strategy":{"max_skip_attempts":4,"strategy_type":"AUTOMATIC","preview_timeout":100,"max_attempts":99,"retry_period":100,"retry_time_unit":"SECONDS","calling_hours":[{"from":"01:00:00","to":"02:00:00","week_days":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]}],"dispositions":{"busy":{"status_after_call":"RETRY","custom":false,"max_attempts":45,"retry_period":123,"retry_period_time_unit":"SECONDS"},"no_answer":{"status_after_call":"RETRY","custom":false,"max_attempts":45,"retry_period":123,"retry_period_time_unit":"SECONDS"},"abandoned":{"status_after_call":"RETRY","custom":false,"max_attempts":45,"retry_period":123,"retry_period_time_unit":"SECONDS"},"hangup_before_connection":{"status_after_call":"RETRY","custom":false,"max_attempts":45,"retry_period":123,"retry_period_time_unit":"SECONDS"},"agent_hangup_before_connection":{"status_after_call":"RETRY","custom":false,"max_attempts":45,"retry_period":123,"retry_period_time_unit":"SECONDS"},"answering_machine_detection":{"status_after_call":"RETRY","custom":false,"max_attempts":45,"retry_period":123,"retry_period_time_unit":"SECONDS"},"invalid_number":{"status_after_call":"FINAL"}},"record_chain":[{"type":"HOME","max_attempts":5,"retry_period":300,"retry_period_time_unit":"MINUTES"},{"type":"OFFICE","max_attempts":3,"retry_period":123,"retry_period_time_unit":"SECONDS"},{"type":"MOBILE","max_attempts":2,"retry_period":213,"retry_period_time_unit":"SECONDS"},{"type":"EXTRA_1","max_attempts":2,"retry_period":213,"retry_period_time_unit":"SECONDS"},{"type":"EXTRA_2","max_attempts":2,"retry_period":213,"retry_period_time_unit":"SECONDS"},{"type":"EXTRA_3","max_attempts":2,"retry_period":213,"retry_period_time_unit":"SECONDS"}],"ivr_enabled":true,"lists_sorting_criteria":"FIFO"},"_links":{"self":{"href":"http://api-docs.talkdesk.org/campaigns/123e4567-e89b-12d3-a456-426655440000"},"campaigns":{"href":"http://api-docs.talkdesk.org/campaigns"}}}}}},"400":{"description":"Errors were found in the submitted data.","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530001","message":"Errors were found in the submitted data"}}}},"401":{"description":"Unauthorized","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530004","message":"Missing or invalid authentication token"}}}},"403":{"description":"Forbidden","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530003","message":"Insufficient scopes for the requested operation"}}}}}},"get":{"description":"List campaigns","x-namespace":"/campaigns","tags":["Campaigns"],"security":[{"EarlyAccess":["campaigns:read"]}],"parameters":[{"name":"fields","in":"query","description":"Allows to request the sub entities of the campaign

    • dialing_mode_configuration -> Return the campaign's dialing mode configuration.
    • dialing_strategy -> Return the campaign's dialing strategy.
    • teams -> Return the campaign's teams information.
    ","required":false,"schema":{"type":"string","maxLength":2083}},{"name":"page","in":"query","schema":{"type":"integer","default":1,"minimum":1}},{"name":"per_page","in":"query","schema":{"type":"integer","default":50,"minimum":1,"maximum":100}},{"name":"name","in":"query","description":"Filter by campaign name","schema":{"type":"string","maxLength":35,"x-filterable":true}},{"name":"user_id","in":"query","description":"Filter by user id.","schema":{"type":"string","maxLength":36}},{"name":"team_id","in":"query","description":"Filter Campaigns by team id.","required":false,"schema":{"type":"string"}},{"name":"do_no_call_list_id","in":"query","description":"Filter by 'Do Not Call List Id'.","schema":{"type":"string","maxLength":36}},{"name":"record_list_id","in":"query","description":"Filter by 'Record list id'.","schema":{"type":"string","maxLength":36}},{"name":"search","in":"query","schema":{"type":"string","default":"","x-search_operators":["*"],"maxLength":35,"x-search_fields":["name"]},"description":"Search campaigns with total and partial matches of a given search string, this will be case insensitive and accent/diacritics insensitive.\n\nThe search will be done on the following fields: `name`\n"},{"description":"Order campaigns by name, dialing mode or created at in an ascending or descending order.","in":"query","name":"order_by","schema":{"default":"created_at:desc","x-sorting_default_order":"asc","x-sorting_fields":["name","dialing_mode","created_at","priority"],"enum":["created_at","created_at:asc","created_at:desc","name","name:asc","name:desc","dialing_mode","dialing_mode:asc","dialing_mode:desc","priority","priority:asc","priority:desc"],"type":"string","maxLength":35}},{"description":"Allows filtering by dialing_mode","in":"query","name":"dialing_mode","schema":{"enum":["PREDICTIVE","PREVIEW"],"type":"string","x-filterable":true,"maxLength":35}},{"description":"Allows filtering by status","in":"query","name":"status","schema":{"enum":["incomplete","ready","running","paused"],"type":"string","x-filterable":true,"maxLength":35}},{"description":"Allows filtering by action_required","in":"query","name":"action_required","schema":{"type":"boolean","x-filterable":true}},{"description":"Allows filtering by priority","in":"query","name":"priority","schema":{"type":"integer","minimum":1,"maximum":10}},{"description":"Allows filtering by created_at, the oldest date.","in":"query","name":"created_at_from","schema":{"type":"string","format":"date-time","maxLength":35}},{"description":"Allows filtering by created_at, the lastest date.","in":"query","name":"created_at_to","schema":{"type":"string","format":"date-time","maxLength":35}}],"responses":{"200":{"description":"successful operation","content":{"application/hal+json":{"schema":{"type":"object","properties":{"total":{"type":"integer"},"count":{"type":"integer"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"_embedded":{"type":"object","properties":{"campaigns":{"type":"array","description":"The list of campaigns","items":{"type":"object","allOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","maxLength":36},"name":{"type":"string","minLength":3,"maxLength":35},"dialing_mode":{"type":"string","maxLength":35,"enum":["PREDICTIVE","PREVIEW"]},"priority":{"type":"integer","minimum":1,"maximum":10},"run_once":{"type":"boolean"},"action_required":{"type":"boolean"},"status":{"type":"string","maxLength":35,"enum":["INCOMPLETE","READY","RUNNING","PAUSED"]},"created_at":{"type":"string","format":"date-time"}},"required":["name"]}],"properties":{"_links":{"type":"object","description":"HAL API related links.","properties":{"self":{"type":"object","description":"Link to fetch the detail of the Campaign","properties":{"href":{"type":"string","maxLength":2083,"description":"Address of the resource"}},"required":["href"]},"campaigns":{"type":"object","description":"Link to fetch a list of all the campaigns","properties":{"href":{"type":"string","maxLength":2083,"description":"Address of the resources"}},"required":["href"]}},"required":["self","campaigns"]}},"required":["id","_links"]}}},"required":["campaigns"]},"_links":{"type":"object","description":"HAL API related links.","properties":{"self":{"type":"object","description":"Link to fetch a list of all the campaigns","properties":{"href":{"type":"string","maxLength":2083,"description":"Address of the resources"}},"required":["href"]},"prev":{"type":"object","properties":{"href":{"type":"string","maxLength":2083}},"required":["href"]},"next":{"type":"object","properties":{"href":{"type":"string","maxLength":2083}},"required":["href"]},"first":{"type":"object","properties":{"href":{"type":"string","maxLength":2083}},"required":["href"]},"last":{"type":"object","properties":{"href":{"type":"string","maxLength":2083}},"required":["href"]}},"required":["self","prev","next","first","last"]}},"required":["total","count","page","per_page","total_pages","_embedded","_links"]},"example":{"total":54,"count":4,"page":6,"per_page":10,"total_pages":6,"_embedded":{"campaigns":[{"id":"123e4567-e89b-12d3-a456-426655440000","name":"50% discount on culinary courses","dialing_mode":"PREDICTIVE","priority":5,"run_once":true,"action_required":false,"status":"READY","created_at":"2022-03-10T16:16:49.405Z","_links":{"self":{"href":"http://api-docs.talkdesk.org/campaigns/123e4567-e89b-12d3-a456-426655440000"},"campaigns":{"href":"http://api-docs.talkdesk.org/campaigns"}}}]},"_links":{"self":{"href":"http://api-docs.talkdesk.org/campaigns?page=3"},"prev":{"href":"http://api-docs.talkdesk.org/campaigns?page=2"},"next":{"href":"http://api-docs.talkdesk.org/campaigns?page=4"},"first":{"href":"http://api-docs.talkdesk.org/campaigns?page=1"},"last":{"href":"http://api-docs.talkdesk.org/campaigns?page=5"}}}}}},"400":{"description":"Errors were found in the submitted data.","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530001","message":"Errors were found in the submitted data"}}}},"401":{"description":"Unauthorized","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530004","message":"Missing or invalid authentication token"}}}},"403":{"description":"Forbidden","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530003","message":"Insufficient scopes for the requested operation"}}}}}}},"/campaigns/{id}":{"get":{"description":"Get campaign","x-namespace":"/campaigns","tags":["Campaigns"],"security":[{"EarlyAccess":["campaigns:read","role-permissions:skip"]}],"parameters":[{"name":"id","in":"path","description":"Id of the campaign to return","required":true,"schema":{"type":"string","maxLength":26}},{"name":"fields","in":"query","description":"Allows to request the sub entities of the campaign

    • dialing_mode_configuration -> Return the campaign's dialing mode configuration.
    • dialing_strategy -> Return the campaign's dialing strategy.
    ","required":false,"schema":{"type":"string","maxLength":2083}}],"responses":{"200":{"description":"Campaign returned successfully","content":{"application/hal+json":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","maxLength":36},"name":{"type":"string","minLength":3,"maxLength":35},"dialing_mode":{"type":"string","maxLength":35,"enum":["PREDICTIVE","PREVIEW"]},"priority":{"type":"integer","minimum":1,"maximum":10},"run_once":{"type":"boolean"},"action_required":{"type":"boolean"},"status":{"type":"string","maxLength":35,"enum":["INCOMPLETE","READY","RUNNING","PAUSED"]},"dialing_mode_configuration":{"type":"object","required":["max_ring_time_in_secs"],"properties":{"answering_machine_detection":{"type":"boolean","description":"The flag to decide if disconnects calls that reach answering machines or voicemails. Only to be used in Predictive mode."},"amd_metadata":{"type":"boolean","description":"The flag to decide if an additional in-house AMD layer based on Metadata that will improve the initial AMD decision in Dialer. Only to be used in Predictive mode."},"max_abandonment_rate":{"type":"integer","description":"Maximum rate of abandoned calls. Only to be used in Predictive mode.","minimum":1,"maximum":100},"max_dialing_ratio":{"type":"integer","description":"Maximum number of calls launched per agent. Only to be used in Predictive mode.","minimum":1,"maximum":3},"max_ring_time_in_secs":{"type":"integer","description":"The time in which if the calls are not answered they are disconnected","minimum":6,"maximum":120},"abandonment_timeout":{"type":"object","required":["amount"],"properties":{"amount":{"type":"integer","description":"The time in which automatically hangs up answered calls that haven't been connected to an agent. Unit in seconds. Only to be used in Predictive mode.","minimum":2,"maximum":30}}}}},"dialing_strategy":{"type":"object","required":["max_attempts","retry_period","retry_time_unit","calling_hours","dispositions"],"properties":{"max_skip_attempts":{"type":"integer","description":"The maximum number of times that an agent can skip a call.","minimum":0,"maximum":20},"strategy_type":{"type":"string","maxLength":35,"description":"The strategy on how the records will be dialed.","enum":["AUTOMATIC","MANUAL"]},"preview_timeout":{"type":"integer","description":"The time in seconds that the preview context will be available to the agent.","minimum":6,"maximum":300},"max_attempts":{"type":"integer","description":"The maximum number of non-final call attempts each record may receive.","minimum":1,"maximum":100},"retry_period":{"type":"integer","description":"Time between non-final call attempts.","minimum":1,"maximum":2592000},"retry_time_unit":{"type":"string","maxLength":35,"description":"The time unit for the retry_period","enum":["SECONDS","MINUTES","HOURS","DAYS"]},"calling_hours":{"type":"array","description":"Set of rules to be applied based on location of the records lists.","items":{"type":"object","required":["from","to","week_days"],"properties":{"from":{"type":"string","maxLength":8,"format":"time","description":"start time format hh:MM:ss"},"to":{"type":"string","maxLength":8,"format":"time","description":"end time format hh:MM:ss"},"week_days":{"type":"array","items":{"type":"string","maxLength":35,"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]}}}}},"dispositions":{"type":"object","description":"System Dispositions to be available for defined campaign","required":["busy","no_answer","invalid_number"],"properties":{"busy":{"type":"object","description":"busy disposition settings","required":["status_after_call","custom"],"properties":{"status_after_call":{"type":"string","maxLength":35,"enum":["FINAL","RETRY"]},"custom":{"type":"boolean"},"max_attempts":{"type":"integer","minimum":1,"maximum":100},"retry_period":{"type":"integer","minimum":1,"maximum":2592000},"retry_period_time_unit":{"type":"string","maxLength":35,"enum":["SECONDS","MINUTES","HOURS","DAYS"]}}},"no_answer":{"type":"object","description":"no_answer disposition settings","required":["status_after_call","custom"],"properties":{"status_after_call":{"type":"string","maxLength":35,"enum":["FINAL","RETRY"]},"custom":{"type":"boolean"},"max_attempts":{"type":"integer","minimum":1,"maximum":100},"retry_period":{"type":"integer","minimum":1,"maximum":2592000},"retry_period_time_unit":{"type":"string","maxLength":35,"enum":["SECONDS","MINUTES","HOURS","DAYS"]}}},"abandoned":{"type":"object","description":"abandonment disposition settings","required":["status_after_call","custom"],"properties":{"status_after_call":{"type":"string","maxLength":35,"enum":["FINAL","RETRY"]},"custom":{"type":"boolean"},"max_attempts":{"type":"integer","minimum":1,"maximum":100},"retry_period":{"type":"integer","minimum":1,"maximum":2592000},"retry_period_time_unit":{"type":"string","maxLength":35,"enum":["SECONDS","MINUTES","HOURS","DAYS"]}}},"hangup_before_connection":{"type":"object","description":"hangup_before_connection disposition settings","required":["status_after_call","custom"],"properties":{"status_after_call":{"type":"string","maxLength":35,"enum":["FINAL","RETRY"]},"custom":{"type":"boolean"},"max_attempts":{"type":"integer","minimum":1,"maximum":100},"retry_period":{"type":"integer","minimum":1,"maximum":2592000},"retry_period_time_unit":{"type":"string","maxLength":35,"enum":["SECONDS","MINUTES","HOURS","DAYS"]}}},"agent_hangup_before_connection":{"type":"object","description":"agent_hangup_before_connection disposition settings","required":["status_after_call","custom"],"properties":{"status_after_call":{"type":"string","maxLength":35,"enum":["FINAL","RETRY"]},"custom":{"type":"boolean"},"max_attempts":{"type":"integer","minimum":1,"maximum":100},"retry_period":{"type":"integer","minimum":1,"maximum":2592000},"retry_period_time_unit":{"type":"string","maxLength":35,"enum":["SECONDS","MINUTES","HOURS","DAYS"]}}},"answering_machine_detection":{"type":"object","description":"answering_machine_detection disposition settings","required":["status_after_call","custom"],"properties":{"status_after_call":{"type":"string","maxLength":35,"enum":["FINAL","RETRY"]},"custom":{"type":"boolean"},"max_attempts":{"type":"integer","minimum":1,"maximum":100},"retry_period":{"type":"integer","minimum":1,"maximum":2592000},"retry_period_time_unit":{"type":"string","maxLength":35,"enum":["SECONDS","MINUTES","HOURS","DAYS"]}}},"invalid_number":{"description":"invalid number disposition setting","type":"object","required":["status_after_call"],"properties":{"status_after_call":{"type":"string","maxLength":35,"enum":["FINAL"]}}}}},"record_chain":{"type":"array","description":"Set of rules to be applied based on the phone type. Must have exactly one of each phone type (see type enum).","items":{"description":"Record chaining settings for each phone type.","type":"object","required":["type","max_attempts"],"properties":{"type":{"type":"string","description":"Phone Type.","enum":["HOME","OFFICE","MOBILE","EXTRA_1","EXTRA_2","EXTRA_3"]},"max_attempts":{"type":"integer","minimum":1,"maximum":100,"description":"Number of attempts"},"retry_period":{"type":"integer","minimum":1,"maximum":2592000,"description":"Time between call attempts for phones of this type."},"retry_time_unit":{"type":"string","description":"The time unit for the retry_period.","enum":["SECONDS","MINUTES","HOURS","DAYS"]}}}},"lists_sorting_criteria":{"type":"string","maxLength":10,"description":"The config on how the records will be sorted","enum":["FIFO","LIFO"]}}},"created_at":{"type":"string","format":"date-time"}},"required":["name"]}],"properties":{"_links":{"type":"object","description":"HAL API related links.","properties":{"self":{"type":"object","description":"Link to fetch the detail of the Campaign","properties":{"href":{"type":"string","maxLength":2083,"description":"Address of the resource"}},"required":["href"]},"campaigns":{"type":"object","description":"Link to fetch a list of all the campaigns","properties":{"href":{"type":"string","maxLength":2083,"description":"Address of the resources"}},"required":["href"]}},"required":["self","campaigns"]}},"required":["id","_links"]},"example":{"id":"123e4567-e89b-12d3-a456-426655440000","name":"50% discount on culinary courses","dialing_mode":"PREDICTIVE","priority":5,"run_once":true,"action_required":false,"status":"READY","dialing_mode_configuration":{"answering_machine_detection":false,"amd_metadata":false,"max_abandonment_rate":2,"max_dialing_ratio":3,"max_ring_time_in_secs":6,"abandonment_timeout":{"amount":14}},"dialing_strategy":{"max_skip_attempts":4,"strategy_type":"AUTOMATIC","preview_timeout":100,"max_attempts":99,"retry_period":100,"retry_time_unit":"SECONDS","calling_hours":[{"from":"01:00:00","to":"02:00:00","week_days":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]}],"dispositions":{"busy":{"status_after_call":"RETRY","custom":false,"max_attempts":45,"retry_period":123,"retry_period_time_unit":"SECONDS"},"no_answer":{"status_after_call":"RETRY","custom":false,"max_attempts":45,"retry_period":123,"retry_period_time_unit":"SECONDS"},"abandoned":{"status_after_call":"RETRY","custom":false,"max_attempts":45,"retry_period":123,"retry_period_time_unit":"SECONDS"},"hangup_before_connection":{"status_after_call":"RETRY","custom":false,"max_attempts":45,"retry_period":123,"retry_period_time_unit":"SECONDS"},"agent_hangup_before_connection":{"status_after_call":"RETRY","custom":false,"max_attempts":45,"retry_period":123,"retry_period_time_unit":"SECONDS"},"answering_machine_detection":{"status_after_call":"RETRY","custom":false,"max_attempts":45,"retry_period":123,"retry_period_time_unit":"SECONDS"},"invalid_number":{"status_after_call":"FINAL"}},"record_chain":[{"type":"HOME","max_attempts":5,"retry_period":300,"retry_period_time_unit":"MINUTES"},{"type":"OFFICE","max_attempts":3,"retry_period":123,"retry_period_time_unit":"SECONDS"},{"type":"MOBILE","max_attempts":2,"retry_period":213,"retry_period_time_unit":"SECONDS"},{"type":"EXTRA_1","max_attempts":2,"retry_period":213,"retry_period_time_unit":"SECONDS"},{"type":"EXTRA_2","max_attempts":2,"retry_period":213,"retry_period_time_unit":"SECONDS"},{"type":"EXTRA_3","max_attempts":2,"retry_period":213,"retry_period_time_unit":"SECONDS"}],"ivr_enabled":true,"lists_sorting_criteria":"FIFO"},"_links":{"self":{"href":"http://api-docs.talkdesk.org/campaigns/123e4567-e89b-12d3-a456-426655440000"},"campaigns":{"href":"http://api-docs.talkdesk.org/campaigns"}}}}}},"400":{"description":"Errors were found in the submitted data.","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530001","message":"Errors were found in the submitted data"}}}},"401":{"description":"Unauthorized","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530004","message":"Missing or invalid authentication token"}}}},"403":{"description":"Forbidden","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530003","message":"Insufficient scopes for the requested operation"}}}},"404":{"description":"Campaign not found","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530002","message":"The requested resource could not be found"}}}}}},"delete":{"description":"Delete campaign","x-namespace":"/campaigns","tags":["Campaigns"],"security":[{"EarlyAccess":["campaigns:write"]}],"parameters":[{"name":"id","in":"path","description":"Campaign id","required":true,"schema":{"type":"string","maxLength":36}}],"responses":{"204":{"description":"Campaign deleted successfully"},"401":{"description":"Unauthorized","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530004","message":"Missing or invalid authentication token"}}}},"403":{"description":"Forbidden","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530003","message":"Insufficient scopes for the requested operation"}}}},"404":{"description":"Campaign not found","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530002","message":"The requested resource could not be found"}}}},"409":{"description":"Request conflict with current state of the campaign","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530005","message":"The request could not be completed due to a conflict with the current state of the target resource."}}}}}},"patch":{"description":"Patch campaign for an account","x-namespace":"/campaigns","tags":["Campaigns"],"security":[{"EarlyAccess":["campaigns:write"]}],"parameters":[{"name":"id","in":"path","description":"campaign id","required":true,"schema":{"type":"string","maxLength":36}}],"requestBody":{"description":"Campaign configuration parameters","required":true,"content":{"application/json":{"schema":{"type":"object","description":"JSON Patch requests","properties":{"op":{"type":"string","maxLength":35,"enum":["REPLACE"]},"path":{"type":"string","maxLength":2083,"enum":["status","name","priority"],"description":"Path of resource to be patched"},"value":{"type":"string","maxLength":35,"description":"
    • if path is state , value is running or paused.
    • if path is name, maxLength less than 35.
    • if path is priority, must be number, min value is 1 and max value is 10.
    "}},"required":["op","path","value"]},"example":{"op":"REPLACE","path":"/status","value":"paused"}}}},"responses":{"200":{"description":"Campaign updated successfully","content":{"application/hal+json":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","maxLength":36},"name":{"type":"string","minLength":3,"maxLength":35},"dialing_mode":{"type":"string","maxLength":35,"enum":["PREDICTIVE","PREVIEW"]},"priority":{"type":"integer","minimum":1,"maximum":10},"run_once":{"type":"boolean"},"action_required":{"type":"boolean"},"status":{"type":"string","maxLength":35,"enum":["INCOMPLETE","READY","RUNNING","PAUSED"]},"dialing_mode_configuration":{"type":"object","required":["max_ring_time_in_secs"],"properties":{"answering_machine_detection":{"type":"boolean","description":"The flag to decide if disconnects calls that reach answering machines or voicemails. Only to be used in Predictive mode."},"amd_metadata":{"type":"boolean","description":"The flag to decide if an additional in-house AMD layer based on Metadata that will improve the initial AMD decision in Dialer. Only to be used in Predictive mode."},"max_abandonment_rate":{"type":"integer","description":"Maximum rate of abandoned calls. Only to be used in Predictive mode.","minimum":1,"maximum":100},"max_dialing_ratio":{"type":"integer","description":"Maximum number of calls launched per agent. Only to be used in Predictive mode.","minimum":1,"maximum":3},"max_ring_time_in_secs":{"type":"integer","description":"The time in which if the calls are not answered they are disconnected","minimum":6,"maximum":120},"abandonment_timeout":{"type":"object","required":["amount"],"properties":{"amount":{"type":"integer","description":"The time in which automatically hangs up answered calls that haven't been connected to an agent. Unit in seconds. Only to be used in Predictive mode.","minimum":2,"maximum":30}}}}},"dialing_strategy":{"type":"object","required":["max_attempts","retry_period","retry_time_unit","calling_hours","dispositions"],"properties":{"max_skip_attempts":{"type":"integer","description":"The maximum number of times that an agent can skip a call.","minimum":0,"maximum":20},"strategy_type":{"type":"string","maxLength":35,"description":"The strategy on how the records will be dialed.","enum":["AUTOMATIC","MANUAL"]},"preview_timeout":{"type":"integer","description":"The time in seconds that the preview context will be available to the agent.","minimum":6,"maximum":300},"max_attempts":{"type":"integer","description":"The maximum number of non-final call attempts each record may receive.","minimum":1,"maximum":100},"retry_period":{"type":"integer","description":"Time between non-final call attempts.","minimum":1,"maximum":2592000},"retry_time_unit":{"type":"string","maxLength":35,"description":"The time unit for the retry_period","enum":["SECONDS","MINUTES","HOURS","DAYS"]},"calling_hours":{"type":"array","description":"Set of rules to be applied based on location of the records lists.","items":{"type":"object","required":["from","to","week_days"],"properties":{"from":{"type":"string","maxLength":8,"format":"time","description":"start time format hh:MM:ss"},"to":{"type":"string","maxLength":8,"format":"time","description":"end time format hh:MM:ss"},"week_days":{"type":"array","items":{"type":"string","maxLength":35,"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]}}}}},"dispositions":{"type":"object","description":"System Dispositions to be available for defined campaign","required":["busy","no_answer","invalid_number"],"properties":{"busy":{"type":"object","description":"busy disposition settings","required":["status_after_call","custom"],"properties":{"status_after_call":{"type":"string","maxLength":35,"enum":["FINAL","RETRY"]},"custom":{"type":"boolean"},"max_attempts":{"type":"integer","minimum":1,"maximum":100},"retry_period":{"type":"integer","minimum":1,"maximum":2592000},"retry_period_time_unit":{"type":"string","maxLength":35,"enum":["SECONDS","MINUTES","HOURS","DAYS"]}}},"no_answer":{"type":"object","description":"no_answer disposition settings","required":["status_after_call","custom"],"properties":{"status_after_call":{"type":"string","maxLength":35,"enum":["FINAL","RETRY"]},"custom":{"type":"boolean"},"max_attempts":{"type":"integer","minimum":1,"maximum":100},"retry_period":{"type":"integer","minimum":1,"maximum":2592000},"retry_period_time_unit":{"type":"string","maxLength":35,"enum":["SECONDS","MINUTES","HOURS","DAYS"]}}},"abandoned":{"type":"object","description":"abandonment disposition settings","required":["status_after_call","custom"],"properties":{"status_after_call":{"type":"string","maxLength":35,"enum":["FINAL","RETRY"]},"custom":{"type":"boolean"},"max_attempts":{"type":"integer","minimum":1,"maximum":100},"retry_period":{"type":"integer","minimum":1,"maximum":2592000},"retry_period_time_unit":{"type":"string","maxLength":35,"enum":["SECONDS","MINUTES","HOURS","DAYS"]}}},"hangup_before_connection":{"type":"object","description":"hangup_before_connection disposition settings","required":["status_after_call","custom"],"properties":{"status_after_call":{"type":"string","maxLength":35,"enum":["FINAL","RETRY"]},"custom":{"type":"boolean"},"max_attempts":{"type":"integer","minimum":1,"maximum":100},"retry_period":{"type":"integer","minimum":1,"maximum":2592000},"retry_period_time_unit":{"type":"string","maxLength":35,"enum":["SECONDS","MINUTES","HOURS","DAYS"]}}},"agent_hangup_before_connection":{"type":"object","description":"agent_hangup_before_connection disposition settings","required":["status_after_call","custom"],"properties":{"status_after_call":{"type":"string","maxLength":35,"enum":["FINAL","RETRY"]},"custom":{"type":"boolean"},"max_attempts":{"type":"integer","minimum":1,"maximum":100},"retry_period":{"type":"integer","minimum":1,"maximum":2592000},"retry_period_time_unit":{"type":"string","maxLength":35,"enum":["SECONDS","MINUTES","HOURS","DAYS"]}}},"answering_machine_detection":{"type":"object","description":"answering_machine_detection disposition settings","required":["status_after_call","custom"],"properties":{"status_after_call":{"type":"string","maxLength":35,"enum":["FINAL","RETRY"]},"custom":{"type":"boolean"},"max_attempts":{"type":"integer","minimum":1,"maximum":100},"retry_period":{"type":"integer","minimum":1,"maximum":2592000},"retry_period_time_unit":{"type":"string","maxLength":35,"enum":["SECONDS","MINUTES","HOURS","DAYS"]}}},"invalid_number":{"description":"invalid number disposition setting","type":"object","required":["status_after_call"],"properties":{"status_after_call":{"type":"string","maxLength":35,"enum":["FINAL"]}}}}},"record_chain":{"type":"array","description":"Set of rules to be applied based on the phone type. Must have exactly one of each phone type (see type enum).","items":{"description":"Record chaining settings for each phone type.","type":"object","required":["type","max_attempts"],"properties":{"type":{"type":"string","description":"Phone Type.","enum":["HOME","OFFICE","MOBILE","EXTRA_1","EXTRA_2","EXTRA_3"]},"max_attempts":{"type":"integer","minimum":1,"maximum":100,"description":"Number of attempts"},"retry_period":{"type":"integer","minimum":1,"maximum":2592000,"description":"Time between call attempts for phones of this type."},"retry_time_unit":{"type":"string","description":"The time unit for the retry_period.","enum":["SECONDS","MINUTES","HOURS","DAYS"]}}}},"lists_sorting_criteria":{"type":"string","maxLength":10,"description":"The config on how the records will be sorted","enum":["FIFO","LIFO"]}}},"created_at":{"type":"string","format":"date-time"}},"required":["name"]}],"properties":{"_links":{"type":"object","description":"HAL API related links.","properties":{"self":{"type":"object","description":"Link to fetch the detail of the Campaign","properties":{"href":{"type":"string","maxLength":2083,"description":"Address of the resource"}},"required":["href"]},"campaigns":{"type":"object","description":"Link to fetch a list of all the campaigns","properties":{"href":{"type":"string","maxLength":2083,"description":"Address of the resources"}},"required":["href"]}},"required":["self","campaigns"]}},"required":["id","_links"]},"example":{"id":"123e4567-e89b-12d3-a456-426655440000","name":"50% discount on culinary courses","dialing_mode":"PREDICTIVE","priority":5,"run_once":true,"action_required":false,"status":"READY","dialing_mode_configuration":{"answering_machine_detection":false,"amd_metadata":false,"max_abandonment_rate":2,"max_dialing_ratio":3,"max_ring_time_in_secs":6,"abandonment_timeout":{"amount":14}},"dialing_strategy":{"max_skip_attempts":4,"strategy_type":"AUTOMATIC","preview_timeout":100,"max_attempts":99,"retry_period":100,"retry_time_unit":"SECONDS","calling_hours":[{"from":"01:00:00","to":"02:00:00","week_days":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]}],"dispositions":{"busy":{"status_after_call":"RETRY","custom":false,"max_attempts":45,"retry_period":123,"retry_period_time_unit":"SECONDS"},"no_answer":{"status_after_call":"RETRY","custom":false,"max_attempts":45,"retry_period":123,"retry_period_time_unit":"SECONDS"},"abandoned":{"status_after_call":"RETRY","custom":false,"max_attempts":45,"retry_period":123,"retry_period_time_unit":"SECONDS"},"hangup_before_connection":{"status_after_call":"RETRY","custom":false,"max_attempts":45,"retry_period":123,"retry_period_time_unit":"SECONDS"},"agent_hangup_before_connection":{"status_after_call":"RETRY","custom":false,"max_attempts":45,"retry_period":123,"retry_period_time_unit":"SECONDS"},"answering_machine_detection":{"status_after_call":"RETRY","custom":false,"max_attempts":45,"retry_period":123,"retry_period_time_unit":"SECONDS"},"invalid_number":{"status_after_call":"FINAL"}},"record_chain":[{"type":"HOME","max_attempts":5,"retry_period":300,"retry_period_time_unit":"MINUTES"},{"type":"OFFICE","max_attempts":3,"retry_period":123,"retry_period_time_unit":"SECONDS"},{"type":"MOBILE","max_attempts":2,"retry_period":213,"retry_period_time_unit":"SECONDS"},{"type":"EXTRA_1","max_attempts":2,"retry_period":213,"retry_period_time_unit":"SECONDS"},{"type":"EXTRA_2","max_attempts":2,"retry_period":213,"retry_period_time_unit":"SECONDS"},{"type":"EXTRA_3","max_attempts":2,"retry_period":213,"retry_period_time_unit":"SECONDS"}],"ivr_enabled":true,"lists_sorting_criteria":"FIFO"},"_links":{"self":{"href":"http://api-docs.talkdesk.org/campaigns/123e4567-e89b-12d3-a456-426655440000"},"campaigns":{"href":"http://api-docs.talkdesk.org/campaigns"}}}}}},"400":{"description":"Errors were found in the submitted data.","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530001","message":"Errors were found in the submitted data"}}}},"401":{"description":"Unauthorized","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530004","message":"Missing or invalid authentication token"}}}},"403":{"description":"Forbidden","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530003","message":"Insufficient scopes for the requested operation"}}}},"404":{"description":"Campaign not found","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530002","message":"The requested resource could not be found"}}}},"422":{"description":"Unprocessable Entity","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530008","message":"Resource is not available for this operation"}}}}}}},"/campaigns/{id}/do-not-call-lists":{"get":{"description":"Get Do Not Call Lists assigned to a campaign","x-namespace":"/campaigns","tags":["Campaigns"],"security":[{"EarlyAccess":["campaigns:read"]}],"parameters":[{"name":"id","in":"path","description":"Campaign id","required":true,"schema":{"type":"string","maxLength":36}},{"in":"query","name":"page","schema":{"type":"integer","default":1,"minimum":1,"maximum":4611686018427388000}},{"in":"query","name":"per_page","schema":{"type":"integer","default":50,"minimum":1,"maximum":100}},{"in":"query","name":"filter","description":"Allows filtering by user ids. Beware of the limit of the url's length.
    Example:
    • filter=id eq '3c3671b2-bf96-4cd9-8ec8-8359911d3d5c' or id eq '9404df4e-bac2-44c2-bc2c-efbabb3fccc4'
    ","schema":{"type":"string","minLength":2,"maxLength":2,"x-operators":["eq","or"]}}],"responses":{"200":{"description":"Campaign returned successfully","content":{"application/hal+json":{"schema":{"type":"object","properties":{"total":{"type":"integer","minimum":0,"maximum":4611686018427388000},"count":{"type":"integer","minimum":0,"maximum":4611686018427388000},"page":{"type":"integer","minimum":1,"maximum":4611686018427388000},"per_page":{"type":"integer","minimum":1,"maximum":250},"total_pages":{"type":"integer","minimum":1,"maximum":4611686018427388000},"_embedded":{"type":"object","properties":{"do_not_call_lists":{"type":"array","description":"The list of record lists","items":{"type":"object","allOf":[{"type":"object","properties":{"id":{"type":"string","maxLength":36}},"required":["id"]}],"properties":{"_links":{"type":"object","description":"HAL API related links.","required":["self"],"properties":{"self":{"type":"object","description":"Link to fetch the detail of the Campaign","required":["href"],"properties":{"href":{"type":"string","minLength":83,"maxLength":83,"description":"Address of the resource"}}},"do_not_call_lists":{"type":"object","description":"Link to fetch a list of all the campaigns","required":["href"],"properties":{"href":{"type":"string","minLength":46,"maxLength":46,"description":"Address of the resources"}}}}}},"required":["_links"]}}},"required":["do_not_call_lists"]},"_links":{"type":"object","description":"HAL API related links.","required":["self"],"properties":{"self":{"type":"object","description":"Link to fetch a list of all the campaigns","required":["href"],"properties":{"href":{"type":"string","minLength":93,"maxLength":2083,"description":"Address of the resources"}}},"prev":{"type":"object","required":["href"],"properties":{"href":{"type":"string","minLength":100,"maxLength":2083}}},"next":{"type":"object","required":["href"],"properties":{"href":{"type":"string","minLength":100,"maxLength":2083}}},"first":{"type":"object","required":["href"],"properties":{"href":{"type":"string","minLength":100,"maxLength":2083}}},"last":{"type":"object","required":["href"],"properties":{"href":{"type":"string","minLength":100,"maxLength":2083}}}}}},"required":["total","count","page","per_page","total_pages","_embedded","_links"]},"example":{"total":54,"count":4,"page":6,"per_page":10,"total_pages":6,"_embedded":{"do_not_call_lists":[{"id":"88b69bad-8f19-4543-b38e-8e7c121ae04e","_links":{"self":{"href":"http://api-docs.talkdesk.org/do-not-call-lists/88b69bad-8f19-4543-b38e-8e7c121ae04e"},"do_not_call_lists":{"href":"http://api-docs.talkdesk.org/do-not-call-lists"}}}]},"_links":{"self":{"href":"http://api-docs.talkdesk.org/campaigns/123e4567-e89b-12d3-a456-426655440000/do-not-call-lists?page=3"},"prev":{"href":"http://api-docs.talkdesk.org/campaigns/123e4567-e89b-12d3-a456-426655440000/do-not-call-lists?page=2"},"next":{"href":"http://api-docs.talkdesk.org/campaigns/123e4567-e89b-12d3-a456-426655440000/do-not-call-lists?page=4"},"first":{"href":"http://api-docs.talkdesk.org/campaigns/123e4567-e89b-12d3-a456-426655440000/do-not-call-lists?page=1"},"last":{"href":"http://api-docs.talkdesk.org/campaigns/123e4567-e89b-12d3-a456-426655440000/do-not-call-lists?page=5"}}}}}},"400":{"description":"Errors were found in the submitted data.","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530001","message":"Errors were found in the submitted data"}}}},"401":{"description":"Unauthorized","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530004","message":"Missing or invalid authentication token"}}}},"403":{"description":"Forbidden","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530003","message":"Insufficient scopes for the requested operation"}}}},"404":{"description":"Campaign not found","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530002","message":"The requested resource could not be found"}}}}}},"post":{"description":"Assign a Do Not Call List to a campaign","x-namespace":"/campaigns","tags":["Campaigns"],"security":[{"EarlyAccess":["campaigns:write"]}],"parameters":[{"name":"id","in":"path","description":"Campaign id","required":true,"schema":{"type":"string","maxLength":36}}],"requestBody":{"description":"Campaign configuration parameters","required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","maxLength":36}},"required":["id"]},"minItems":1,"maxItems":1},"example":[{"id":"88b69bad-8f19-4543-b38e-8e7c121ae04e"}]}}},"responses":{"204":{"description":"Do Not Call Lists successfully assigned to Campaign"},"400":{"description":"Errors were found in the submitted data.","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530001","message":"Errors were found in the submitted data"}}}},"401":{"description":"Unauthorized","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530004","message":"Missing or invalid authentication token"}}}},"403":{"description":"Forbidden","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530003","message":"Insufficient scopes for the requested operation"}}}},"404":{"description":"Campaign not found","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530002","message":"The requested resource could not be found"}}}}}},"delete":{"description":"Unassign a DNCL from a campaign","x-namespace":"/campaigns","tags":["Campaigns"],"security":[{"EarlyAccess":["campaigns:write"]}],"parameters":[{"name":"id","in":"path","description":"Campaign id","required":true,"schema":{"type":"string","maxLength":36}}],"requestBody":{"description":"Campaign configuration parameters","required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","maxLength":36}},"required":["id"]},"minItems":1,"maxItems":1},"example":[{"id":"88b69bad-8f19-4543-b38e-8e7c121ae04e"}]}}},"responses":{"204":{"description":"Do Not Call List successfully unassigned from a Campaign"},"400":{"description":"Errors were found in the submitted data.","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530001","message":"Errors were found in the submitted data"}}}},"401":{"description":"Unauthorized","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530004","message":"Missing or invalid authentication token"}}}},"403":{"description":"Forbidden","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530003","message":"Insufficient scopes for the requested operation"}}}},"404":{"description":"Campaign not found","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530002","message":"The requested resource could not be found"}}}}}}},"/campaigns/{id}/record-lists":{"get":{"description":"Get record lists assigned to a campaign","x-namespace":"/campaigns","tags":["Campaigns"],"security":[{"EarlyAccess":["campaigns:read"]}],"parameters":[{"name":"id","in":"path","description":"Campaign id","required":true,"schema":{"type":"string","maxLength":36}},{"in":"query","name":"page","schema":{"type":"integer","default":1,"minimum":1,"maximum":4611686018427388000}},{"in":"query","name":"per_page","schema":{"type":"integer","default":50,"minimum":1,"maximum":100}},{"in":"query","name":"filter","description":"Allows filtering by user ids. Beware of the limit of the url's length.
    Example:
    • filter=id eq '3c3671b2-bf96-4cd9-8ec8-8359911d3d5c' or id eq '9404df4e-bac2-44c2-bc2c-efbabb3fccc4'
    ","schema":{"type":"string","minLength":2,"maxLength":2,"x-operators":["eq","or"]}}],"responses":{"200":{"description":"Assigned record lists returned successfully","content":{"application/hal+json":{"schema":{"type":"object","properties":{"total":{"type":"integer","minimum":0,"maximum":4611686018427388000},"count":{"type":"integer","minimum":0,"maximum":4611686018427388000},"page":{"type":"integer","minimum":1,"maximum":4611686018427388000},"per_page":{"type":"integer","minimum":1,"maximum":250},"total_pages":{"type":"integer","minimum":1,"maximum":4611686018427388000},"_embedded":{"type":"object","properties":{"record_lists":{"type":"array","description":"The list of record lists","items":{"type":"object","allOf":[{"type":"object","properties":{"id":{"type":"string","maxLength":36}},"required":["id"]}],"properties":{"_links":{"type":"object","description":"HAL API related links.","required":["self"],"properties":{"self":{"type":"object","description":"Link to fetch the detail of the Campaign","required":["href"],"properties":{"href":{"type":"string","minLength":78,"maxLength":78,"description":"Address of the resource"}}},"record_lists":{"type":"object","description":"Link to fetch a list of all the campaigns","required":["href"],"properties":{"href":{"type":"string","minLength":41,"maxLength":41,"description":"Address of the resources"}}}}}},"required":["id","_links"]}}},"required":["record_lists"]},"_links":{"type":"object","description":"HAL API related links.","required":["self"],"properties":{"self":{"type":"object","description":"Link to fetch a list of all the campaigns","required":["href"],"properties":{"href":{"type":"string","minLength":88,"maxLength":2083,"description":"Address of the resources"}}},"prev":{"type":"object","required":["href"],"properties":{"href":{"type":"string","minLength":95,"maxLength":2083}}},"next":{"type":"object","required":["href"],"properties":{"href":{"type":"string","minLength":95,"maxLength":2083}}},"first":{"type":"object","required":["href"],"properties":{"href":{"type":"string","minLength":95,"maxLength":2083}}},"last":{"type":"object","required":["href"],"properties":{"href":{"type":"string","minLength":95,"maxLength":2083}}}}}},"required":["total","count","page","per_page","total_pages","_embedded","_links"]},"example":{"total":54,"count":4,"page":6,"per_page":10,"total_pages":6,"_embedded":{"record_lists":[{"id":"123e4567-e89b-12d3-a456-426655440000","_links":{"self":{"href":"http://api-docs.talkdesk.org/record-lists/88b69bad-8f19-4543-b38e-8e7c121ae04e"},"record_lists":{"href":"http://api-docs.talkdesk.org/record-lists"}}}]},"_links":{"self":{"href":"http://api-docs.talkdesk.org/campaigns/123e4567-e89b-12d3-a456-426655440000/record-lists?page=3"},"prev":{"href":"http://api-docs.talkdesk.org/campaigns/123e4567-e89b-12d3-a456-426655440000/record-lists?page=2"},"next":{"href":"http://api-docs.talkdesk.org/campaigns/123e4567-e89b-12d3-a456-426655440000/record-lists?page=4"},"first":{"href":"http://api-docs.talkdesk.org/campaigns/123e4567-e89b-12d3-a456-426655440000/record-lists?page=1"},"last":{"href":"http://api-docs.talkdesk.org/campaigns/123e4567-e89b-12d3-a456-426655440000/record-lists?page=5"}}}}}},"400":{"description":"Errors were found in the submitted data.","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530001","message":"Errors were found in the submitted data"}}}},"401":{"description":"Unauthorized","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530004","message":"Missing or invalid authentication token"}}}},"403":{"description":"Forbidden","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530003","message":"Insufficient scopes for the requested operation"}}}},"404":{"description":"Campaign not found","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530002","message":"The requested resource could not be found"}}}}}},"post":{"description":"Assign record lists to a campaign","x-namespace":"/campaigns","tags":["Campaigns"],"security":[{"EarlyAccess":["campaigns:write"]}],"parameters":[{"name":"id","in":"path","description":"Campaign id","required":true,"schema":{"type":"string","maxLength":36}}],"requestBody":{"description":"List of record lists to be assigned","required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","maxLength":36}},"required":["id"]},"minItems":1,"maxItems":100},"example":[{"id":"123e4567-e89b-12d3-a456-426655440000"}]}}},"responses":{"204":{"description":"Record lists successfully assigned to campaign"},"400":{"description":"Errors were found in the submitted data.","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530001","message":"Errors were found in the submitted data"}}}},"401":{"description":"Unauthorized","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530004","message":"Missing or invalid authentication token"}}}},"403":{"description":"Forbidden","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530003","message":"Insufficient scopes for the requested operation"}}}},"404":{"description":"Campaign not found","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530002","message":"The requested resource could not be found"}}}}}},"delete":{"description":"Unassign record lists from a campaign","x-namespace":"/campaigns","tags":["Campaigns"],"security":[{"EarlyAccess":["campaigns:write"]}],"parameters":[{"name":"id","in":"path","description":"Campaign id","required":true,"schema":{"type":"string","maxLength":36}}],"requestBody":{"description":"Campaign configuration parameters","required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","maxLength":36}},"required":["id"]},"minItems":1,"maxItems":100},"example":[{"id":"123e4567-e89b-12d3-a456-426655440000"}]}}},"responses":{"204":{"description":"Record lists successfully unassigned from campaign"},"400":{"description":"Errors were found in the submitted data.","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530001","message":"Errors were found in the submitted data"}}}},"401":{"description":"Unauthorized","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530004","message":"Missing or invalid authentication token"}}}},"403":{"description":"Forbidden","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530003","message":"Insufficient scopes for the requested operation"}}}},"404":{"description":"Campaign not found","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530002","message":"The requested resource could not be found"}}}}}}},"/campaigns/{id}/users":{"get":{"description":"Get Users assigned to a campaign","x-namespace":"/campaigns","tags":["Campaigns"],"security":[{"EarlyAccess":["campaigns:read"]}],"parameters":[{"name":"id","in":"path","description":"Campaign id","required":true,"schema":{"type":"string","minLength":1,"maxLength":32}},{"in":"query","name":"page","schema":{"type":"integer","default":1,"minimum":1,"maximum":4611686018427388000}},{"in":"query","name":"per_page","schema":{"type":"integer","default":50,"minimum":1,"maximum":100}},{"in":"query","name":"filter","description":"Allows filtering by user ids. Beware of the limit of the url's length.
    Example:
    • filter=id eq '3c3671b2-bf96-4cd9-8ec8-8359911d3d5c' or id eq '9404df4e-bac2-44c2-bc2c-efbabb3fccc4'
    ","schema":{"type":"string","minLength":1,"maxLength":2083,"x-operators":["eq","or"]}}],"responses":{"200":{"description":"Assigned Users returned successfully","content":{"application/hal+json":{"schema":{"type":"object","properties":{"total":{"type":"integer","minimum":0,"maximum":4611686018427388000},"count":{"type":"integer","minimum":0,"maximum":4611686018427388000},"page":{"type":"integer","minimum":1,"maximum":4611686018427388000},"per_page":{"type":"integer","minimum":1,"maximum":250},"total_pages":{"type":"integer","minimum":1,"maximum":4611686018427388000},"_embedded":{"type":"object","properties":{"users":{"type":"array","description":"The list of users","items":{"type":"object","allOf":[{"type":"object","properties":{"id":{"type":"string","description":"The uuid of the user"}},"required":["id"]}],"properties":{"_links":{"type":"object","description":"HAL API related links.","required":["self"],"properties":{"self":{"type":"object","description":"Link to fetch the detail of the Campaign","required":["href"],"properties":{"href":{"type":"string","description":"Address of the resource"}}},"users":{"type":"object","description":"Link to fetch a list of all the campaigns","required":["href"],"properties":{"href":{"type":"string","description":"Address of the resources"}}}}}},"required":["_links"]}}},"required":["users"]},"_links":{"type":"object","description":"HAL API related links.","required":["self"],"properties":{"self":{"type":"object","description":"Link to fetch a list of all the users","required":["href"],"properties":{"href":{"type":"string","description":"Address of the resources"}}},"prev":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}},"next":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}},"first":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}},"last":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}}}}},"required":["total","count","page","per_page","total_pages","_embedded","_links"]},"example":{"total":54,"count":4,"page":6,"per_page":10,"total_pages":6,"_embedded":{"users":[{"id":"88b69bad-8f19-4543-b38e-8e7c121ae04e","_links":{"self":{"href":"http://api-docs.talkdesk.org/users/88b69bad-8f19-4543-b38e-8e7c121ae04e"},"users":{"href":"http://api-docs.talkdesk.org/users"}}}]},"_links":{"self":{"href":"http://api-docs.talkdesk.org/campaigns/123e4567-e89b-12d3-a456-426655440000/users?page=3"},"prev":{"href":"http://api-docs.talkdesk.org/campaigns/123e4567-e89b-12d3-a456-426655440000/users?page=2"},"next":{"href":"http://api-docs.talkdesk.org/campaigns/123e4567-e89b-12d3-a456-426655440000/users?page=4"},"first":{"href":"http://api-docs.talkdesk.org/campaigns/123e4567-e89b-12d3-a456-426655440000/users?page=1"},"last":{"href":"http://api-docs.talkdesk.org/campaigns/123e4567-e89b-12d3-a456-426655440000/users?page=5"}}}}}},"400":{"description":"Errors were found in the submitted data.","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530001","message":"Errors were found in the submitted data"}}}},"401":{"description":"Unauthorized","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530004","message":"Missing or invalid authentication token"}}}},"403":{"description":"Forbidden","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530003","message":"Insufficient scopes for the requested operation"}}}},"404":{"description":"Campaign not found","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530002","message":"The requested resource could not be found"}}}}}},"post":{"description":"Assign a user to a campaign","x-namespace":"/campaigns","tags":["Campaigns"],"security":[{"EarlyAccess":["campaigns:write"]}],"parameters":[{"name":"id","in":"path","description":"Campaign id","required":true,"schema":{"type":"string","maxLength":36}}],"requestBody":{"description":"List of users to be assigned, the max of the user-ids array size is 50.","required":true,"content":{"application/json":{"schema":{"type":"array","minItems":1,"maxItems":50,"items":{"type":"object","properties":{"id":{"type":"string","description":"users identifier.","maxLength":36}},"required":["id"]}},"example":[{"id":"88b69bad-8f19-4543-b38e-8e7c121ae04e"}]}}},"responses":{"204":{"description":"Users successfully assigned to campaign"},"400":{"description":"Errors were found in the submitted data.","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530001","message":"Errors were found in the submitted data"}}}},"401":{"description":"Unauthorized","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530004","message":"Missing or invalid authentication token"}}}},"403":{"description":"Forbidden","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530003","message":"Insufficient scopes for the requested operation"}}}},"404":{"description":"Campaign not found","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530002","message":"The requested resource could not be found"}}}}}},"delete":{"description":"Unassign a user from a campaign","x-namespace":"/campaigns","tags":["Campaigns"],"security":[{"EarlyAccess":["campaigns:write"]}],"parameters":[{"name":"id","in":"path","description":"Campaign id","required":true,"schema":{"type":"string","maxLength":36}}],"requestBody":{"description":"Campaign configuration parameters","required":true,"content":{"application/json":{"schema":{"type":"array","minItems":1,"maxItems":50,"items":{"type":"object","properties":{"id":{"type":"string","description":"users identifier.","maxLength":36}},"required":["id"]}},"example":[{"id":"88b69bad-8f19-4543-b38e-8e7c121ae04e"}]}}},"responses":{"204":{"description":"User successfully unassigned from campaign"},"400":{"description":"Errors were found in the submitted data.","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530001","message":"Errors were found in the submitted data"}}}},"401":{"description":"Unauthorized","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530004","message":"Missing or invalid authentication token"}}}},"403":{"description":"Forbidden","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530003","message":"Insufficient scopes for the requested operation"}}}},"404":{"description":"Campaign not found","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530002","message":"The requested resource could not be found"}}}}}}},"/campaigns/{id}/numbers":{"get":{"description":"Get Numbers assigned to a campaign","x-namespace":"/campaigns","tags":["Campaigns"],"security":[{"EarlyAccess":["campaigns:read"]}],"parameters":[{"name":"id","in":"path","description":"Campaign id","required":true,"schema":{"type":"string","minLength":1,"maxLength":36}},{"in":"query","name":"page","schema":{"type":"integer","default":1,"minimum":1,"maximum":4611686018427388000}},{"in":"query","name":"per_page","schema":{"type":"integer","default":50,"minimum":1,"maximum":100}},{"in":"query","name":"filter","description":"Allows filtering by user ids. Beware of the limit of the url's length.
    Example:
    • filter=id eq '3c3671b2-bf96-4cd9-8ec8-8359911d3d5c' or id eq '9404df4e-bac2-44c2-bc2c-efbabb3fccc4'
    ","schema":{"type":"string","minLength":1,"maxLength":2083,"x-operators":["eq","or"]}}],"responses":{"200":{"description":"Assigned Numbers returned successfully","content":{"application/hal+json":{"schema":{"type":"object","properties":{"total":{"type":"integer","minimum":0,"maximum":4611686018427388000},"count":{"type":"integer","minimum":0,"maximum":4611686018427388000},"page":{"type":"integer","minimum":1,"maximum":4611686018427388000},"per_page":{"type":"integer","minimum":1,"maximum":250},"total_pages":{"type":"integer","minimum":1,"maximum":4611686018427388000},"_embedded":{"type":"object","properties":{"numbers":{"type":"array","description":"The list of numbers","items":{"type":"object","allOf":[{"type":"object","required":["id","phone_number"],"properties":{"id":{"type":"string","description":"The uuid of the number","maxLength":36},"phone_number":{"type":"string","description":"The phone number in E.164 format","maxLength":15}}}],"properties":{"_links":{"type":"object","description":"HAL API related links.","required":["self"],"properties":{"self":{"type":"object","description":"Link to fetch the detail of the Campaign","required":["href"],"properties":{"href":{"type":"string","description":"Address of the resource"}}},"numbers":{"type":"object","description":"Link to fetch a list of all the campaigns","required":["href"],"properties":{"href":{"type":"string","description":"Address of the resources"}}}}}},"required":["_links"]}}},"required":["numbers"]},"_links":{"type":"object","description":"HAL API related links.","required":["self"],"properties":{"self":{"type":"object","description":"Link to fetch a list of all the numbers","required":["href"],"properties":{"href":{"type":"string","description":"Address of the resources"}}},"prev":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}},"next":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}},"first":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}},"last":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}}}}},"required":["total","count","page","per_page","total_pages","_embedded","_links"]},"example":{"total":54,"count":4,"page":6,"per_page":10,"total_pages":6,"_embedded":{"numbers":[{"id":"88b69bad-8f19-4543-b38e-8e7c121ae04e","phone_number":"+44207183875044","_links":{"self":{"href":"http://api-docs.talkdesk.org/numbers/88b69bad-8f19-4543-b38e-8e7c121ae04e"},"numbers":{"href":"http://api-docs.talkdesk.org/numbers"}}}]},"_links":{"self":{"href":"http://api-docs.talkdesk.org/campaigns/123e4567-e89b-12d3-a456-426655440000/numbers?page=3"},"prev":{"href":"http://api-docs.talkdesk.org/campaigns/123e4567-e89b-12d3-a456-426655440000/numbers?page=2"},"next":{"href":"http://api-docs.talkdesk.org/campaigns/123e4567-e89b-12d3-a456-426655440000/numbers?page=4"},"first":{"href":"http://api-docs.talkdesk.org/campaigns/123e4567-e89b-12d3-a456-426655440000/numbers?page=1"},"last":{"href":"http://api-docs.talkdesk.org/campaigns/123e4567-e89b-12d3-a456-426655440000/numbers?page=5"}}}}}},"400":{"description":"Errors were found in the submitted data.","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530001","message":"Errors were found in the submitted data"}}}},"401":{"description":"Unauthorized","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530004","message":"Missing or invalid authentication token"}}}},"403":{"description":"Forbidden","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530003","message":"Insufficient scopes for the requested operation"}}}},"404":{"description":"Campaign not found","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530002","message":"The requested resource could not be found"}}}}}},"post":{"description":"Assign a number to a campaign","x-namespace":"/campaigns","tags":["Campaigns"],"security":[{"EarlyAccess":["campaigns:write"]}],"parameters":[{"name":"id","in":"path","description":"Campaign id","required":true,"schema":{"type":"string","maxLength":36}}],"requestBody":{"description":"List of numbers to be assigned","required":true,"content":{"application/json":{"schema":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"object","properties":{"id":{"type":"string","description":"numbers identifier.","maxLength":36},"phone_number":{"type":"string","description":"The phone number from the account, in E.164 format","maxLength":15}}}},"example":[{"id":"88b69bad-8f19-4543-b38e-8e7c121ae04e"}]}}},"responses":{"204":{"description":"Numbers successfully assigned to campaign"},"400":{"description":"Errors were found in the submitted data.","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530001","message":"Errors were found in the submitted data"}}}},"401":{"description":"Unauthorized","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530004","message":"Missing or invalid authentication token"}}}},"403":{"description":"Forbidden","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530003","message":"Insufficient scopes for the requested operation"}}}},"404":{"description":"Campaign not found","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530002","message":"The requested resource could not be found"}}}}}},"delete":{"description":"Unassign a number from a campaign","x-namespace":"/campaigns","tags":["Campaigns"],"security":[{"EarlyAccess":["campaigns:write"]}],"parameters":[{"name":"id","in":"path","description":"Campaign id","required":true,"schema":{"type":"string","maxLength":36}}],"requestBody":{"description":"Campaign configuration parameters","required":true,"content":{"application/json":{"schema":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"object","properties":{"id":{"type":"string","description":"numbers identifier.","maxLength":36},"phone_number":{"type":"string","description":"The phone number from the account, in E.164 format","maxLength":15}}}},"example":[{"id":"88b69bad-8f19-4543-b38e-8e7c121ae04e"}]}}},"responses":{"204":{"description":"Number successfully unassigned from campaign"},"400":{"description":"Errors were found in the submitted data.","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530001","message":"Errors were found in the submitted data"}}}},"401":{"description":"Unauthorized","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530004","message":"Missing or invalid authentication token"}}}},"403":{"description":"Forbidden","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530003","message":"Insufficient scopes for the requested operation"}}}},"404":{"description":"Campaign not found","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530002","message":"The requested resource could not be found"}}}}}}},"/schedule-callbacks":{"get":{"description":"query callback list and count callback","summary":"query callback list and count callback","x-namespace":"/schedule-callbacks","tags":["Schedule Callback"],"security":[{"GA":["schedule-callbacks:read"]}],"parameters":[{"name":"page","in":"query","description":"page","required":false,"schema":{"type":"integer","default":1,"minimum":1,"maximum":500}},{"name":"per_page","in":"query","description":"per page","required":false,"schema":{"type":"integer","default":1,"minimum":1,"maximum":500}},{"name":"time_to_call","in":"query","description":"The time the callback is scheduled","required":false,"schema":{"type":"string","format":"date-time","maxLength":35}},{"name":"phone_number","in":"query","description":"The phone number that is scheduled to be called.","required":false,"schema":{"type":"string","maxLength":35}},{"name":"contact_id","in":"query","description":"The id of the contact that is scheduled to be called.","required":false,"schema":{"type":"string","maxLength":35}},{"name":"record_id","in":"query","description":"The id of the record that is scheduled to be called.","required":false,"schema":{"type":"string","maxLength":36}},{"name":"status","in":"query","description":"The status of callback","required":false,"schema":{"type":"string","maxLength":35,"x-filterable":true}},{"name":"next_time_to_call_end","in":"query","description":"End of next time to call when status is 'UNATTEMPTED' or 'TO_BE_RETRIED'","required":false,"schema":{"type":"string","format":"date-time","maxLength":35}},{"name":"agent_id","in":"query","description":"The assigned agent id of schedule callback. Return the callbacks which are specifically assigned to an agent (Myself only, Myself if available), or assigned to specific agents including her/him.\nif want to filter by multiple agent id, agent_id=agent_id1,agent_id2\n","required":false,"schema":{"type":"string","minLength":1,"maxLength":50}},{"name":"campaign_id","in":"query","description":"The campaign id of where the callback originates from.","required":false,"schema":{"type":"string","maxLength":35}},{"name":"start_time","in":"query","description":"Start of next time to call","required":false,"schema":{"type":"string","format":"date-time","maxLength":35}},{"name":"end_time","in":"query","description":"End of next time to call","required":false,"schema":{"type":"string","format":"date-time","maxLength":35}},{"name":"ring_group","in":"query","description":"The name of Ring Group, if want to filter by multiple ring group, ring_group=group1,group2","required":false,"schema":{"type":"string","minLength":1,"maxLength":100}},{"name":"team_id","in":"query","description":"The ids of team, if want to filter by multiple team, team_id=123,345","required":false,"schema":{"type":"string","minLength":1,"maxLength":100}},{"name":"from_call_type","in":"query","description":"Describes what call type is this related to, if want to filter by multiple call type, from_call_type=INBOUND,MANUAL_OUTBOUND","required":false,"schema":{"type":"string","maxLength":64}}],"responses":{"200":{"description":"query callback list and count callback","content":{"application/hal+json":{"schema":{"type":"object","properties":{"total_pages":{"type":"integer","minimum":0,"description":"Total of pages"},"total":{"type":"integer","minimum":0,"description":"Total of elements"},"page":{"type":"integer","minimum":1,"description":"Number of the requested page. Defaults to 0 when not provided witch is first page."},"per_page":{"type":"integer","minimum":1,"description":"The maximum amount of items per page. Defaults to 50 when not provided."},"count":{"type":"integer","minimum":0,"description":"Number of elements in the current page."},"_links":{"type":"object","properties":{"self":{"description":"The link to the current page","type":"object","properties":{"href":{"description":"The hypertext reference describing this link","type":"string"}},"required":["href"]},"first":{"description":"The link to the first page","type":"object","properties":{"href":{"description":"The hypertext reference describing this link","type":"string"}},"required":["href"]},"last":{"description":"The link to the last page","type":"object","properties":{"href":{"description":"The hypertext reference describing this link","type":"string"}},"required":["href"]},"prev":{"description":"The link to the prev page","type":"object","properties":{"href":{"description":"The hypertext reference describing this link","type":"string"}},"required":["href"]}},"required":["self","first","last","prev"]},"_embedded":{"properties":{"callbacks":{"description":"List of callbacks","items":{"description":"Callback with HAL object","readOnly":true,"type":"object","required":["callback_id"],"properties":{"callback_id":{"type":"string","description":"Id of the callback"},"account_id":{"type":"string","description":"Id of the account"},"interaction_id":{"type":"string","description":"The interaction id of where the callback originates from."},"caller_id":{"type":"string","description":"The number that will be shown as the caller"},"scheduled_time_to_call":{"type":"string","format":"date-time","description":"The time the callback is scheduled"},"timezone":{"type":"string","description":"The timezone in which the callback is scheduled"},"preferred_start_time":{"type":"string","format":"date-time","description":"The started preferred time window on the preview screen inside conversation-app to schedule the callback"},"preferred_end_time":{"type":"string","format":"date-time","description":"The ended preferred time window on the preview screen inside conversation-app to schedule the callback"},"processed_time":{"type":"string","format":"date-time","description":"The time to process the callback"},"created_at":{"type":"string","format":"date-time","description":"The time to create the callback"},"created_by":{"type":"string","description":"The user who created the callback"},"contact_id":{"type":"string","description":"The contact id"},"root_interaction_id":{"type":"string","description":"The root interaction id of where the callback originates from."},"teams":{"type":"array","items":{"type":"object","required":["team_id"],"properties":{"team_id":{"type":"string"}}},"description":"Describes what teams the callback is assigned to"},"assign_type":{"type":"string","description":"Describes what assign type is this related to","enum":["MYSELF_ONLY","SPECIFIC_AGENT","SPECIFIC_RING_GROUP","MYSELF_IF_AVAILABLE","ANY_ELIGIBLE_AGENT"]},"from_call_type":{"type":"string","description":"Describes what call type is this related to","enum":["INBOUND","MANUAL_OUTBOUND","PROACTIVE_OUTBOUND"]},"dialing_model":{"type":"string","description":"Describes what dialing model is this related to","enum":["PREDICTIVE","PREVIEW"]},"ring_groups":{"type":"array","items":{"type":"object","required":["ring_group"],"properties":{"ring_group":{"type":"string"}}},"description":"Describes what ring groups the callback is assigned to, when assign_type = specific ring groups."},"agents":{"type":"array","items":{"type":"object","required":["agent_id"],"properties":{"agent_id":{"type":"string"}}},"description":"Describes who are the agents the callback is assigned to, , when assign_type = specific agents."},"campaign_id":{"type":"string","description":"The campaign id of where the callback originates from."},"record_id":{"type":"string","description":"The id of the record list where the record comes from."},"record_list_id":{"type":"string","description":"the id of the record list that is scheduled to be called"},"phone_number":{"type":"string","description":"The phone number that is scheduled to be called"},"record_first_name":{"type":"string","description":"First name of the record that is scheduled to be called"},"record_last_name":{"type":"string","description":"Last name of the record that is scheduled to be called"},"record_extra_data":{"type":"object","description":"Extra Data from the record that is scheduled to be called"},"next_time_to_call":{"type":"string","format":"date-time","description":"The next time the callback will be retried."},"status":{"type":"string","description":"The status of callback","enum":["UNATTEMPTED,","TO_BE_RETRIED,","EXHAUSTED,","SUCCESS,","CANCELED,","INVALID_NUMBER"]},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}}}}}},"type":"array"}},"required":["callbacks"],"type":"object"}},"required":["total","count","page","per_page","total_pages","_embedded","_links"]},"example":{"total":9,"page":1,"per_page":2,"total_pages":5,"count":2,"_links":{"self":{"href":"https://api.talkdeskapp.com/schedule-callbacks/?per_page=2&page=1&time_to_call=2022-03-25T16:00:00Z&phone_number=18888888888"},"first":{"href":"https://api.talkdeskapp.com/schedule-callbacks/?per_page=2&page=1&time_to_call=2022-03-25T16:00:00Z&phone_number=18888888888"},"last":{"href":"https://api.talkdeskapp.com/schedule-callbacks/?per_page=2&page=5&time_to_call=2022-03-25T16:00:00Z&phone_number=18888888888"},"prev":{"href":"https://api.talkdeskapp.com/schedule-callbacks/?per_page=2&page=2&time_to_call=2022-03-25T16:00:00Z&phone_number=18888888888"}},"_embedded":{"callbacks":[{"callback_id":"2da8a248-4b77-463e-9a36-d724f5792971","account_id":"6142f79f738eb0e4a44b18c4","interaction_id":"03e5c6f0-53c5-4b76-86ef-8d89ac67cdc6","caller_id":"+155598754214","scheduled_time_to_call":"2021-03-24T11:48:40.500Z","timezone":"Europe/Lisbon","preferred_start_time":"2000-01-01T12:00:00.000Z","preferred_end_time":"2000-01-01T18:00:00.000Z","processed_time":"2021-03-24T11:48:40.500Z","created_at":"2021-03-24T11:40:40.500Z","created_by":"Chandler","contact_id":"4028814076d8250c0176d826d90f0000","root_interaction_id":"13e5c6f0-53c5-4b76-86ef-8d89ac67cdc2","teams":[{"team_id":"5b34eb0cdcba1b000bdbd321"}],"assign_type":"MYSELF_ONLY","from_call_type":"PROACTIVE_OUTBOUND","dialing_model":"PREDICTIVE","ring_groups":[{"ring_group":"61935f5904147e334756017d"}],"agents":[{"agent_id":"5252g4504147e334756017d"}],"campaign_id":"8c86a8f4-da30-41ac-a09d-148e7690c330","record_id":"2b56abbb-1bb2-40de-9b88-243a4773b518","record_list_id":"c9798bc0-4f5d-474f-afb7-88bf6e543c94","phone_number":"+351910000000","record_first_name":"Chandler","record_last_name":"Bing","next_time_to_call":"2023-03-24T11:48:40Z","status":"UNATTEMPTED","record_extra_data":{"job":"statistical analysis and data reconfiguration.","address":"Apartment #19 in Greenwich Village, Manhattan"},"_links":{"self":{"href":"https://api.talkdeskapp.com/callbacks/2da8a248-4b77-463e-9a36-d724f5792971"}}}]}}}}},"400":{"description":"Errors were found in the submitted data","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0532006","message":"Errors were found in the submitted data."}}}},"401":{"description":"Unauthorized","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0011003","message":"Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0532003","message":"Insufficient scopes for the requested operation"}}}}}}},"/schedule-callbacks/{id}":{"delete":{"summary":"Cancel a callback","description":"Cancel a callback","x-namespace":"/schedule-callbacks","tags":["Schedule Callback"],"security":[{"GA":["schedule-callbacks:write"]}],"parameters":[{"name":"id","in":"path","description":"Callback id","required":true,"schema":{"type":"string","maxLength":26}}],"responses":{"204":{"description":"Callback successfully cancel"},"401":{"description":"Unauthorized","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0011003","message":"Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0532003","message":"Insufficient scopes for the requested operation"}}}},"404":{"description":"Callback not found","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0532002","message":"The requested resource could not be found"}}}}}},"patch":{"summary":"patch update a callback","description":"patch update a callback","x-namespace":"/schedule-callbacks","tags":["Schedule Callback"],"security":[{"GA":["schedule-callbacks:write"]}],"parameters":[{"name":"id","in":"path","description":"Callback id","required":true,"schema":{"type":"string","maxLength":26}}],"requestBody":{"description":"Array of replace operations to edit a callback","required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"op":{"type":"string","description":"The operation to be performed","maxLength":35},"path":{"type":"string","description":"A JSON-Pointer","maxLength":35},"value":{"type":"object","description":"The value to be used within the operations."}},"required":["op","path","value"]}},"examples":{"sample1":{"value":[{"op":"replace","path":"/timeToCall","value":"2022-02-10T09:39:19Z"},{"op":"replace","path":"/phoneNumber","value":"+8613036130259"},{"op":"replace","path":"/timezone","value":"Asia/Shanghai"},{"op":"replace","path":"/assignType","value":"SPECIFIC_AGENT"},{"op":"replace","path":"/agents","value":["6af3b4f4-c962-4c37-80bd-bfec579bfd2c","0957ff2e-6e8b-42d3-9c4a-d7cf1b013aa7"]}]},"sample2":{"value":[{"op":"replace","path":"/timeToCall","value":"2022-02-10T09:39:19Z"},{"op":"replace","path":"/phoneNumber","value":"+8613036130259"},{"op":"replace","path":"/timezone","value":"Asia/Shanghai"},{"op":"replace","path":"/assignType","value":"SPECIFIC_RING_GROUP"},{"op":"replace","path":"/ringGroups","value":["ring_group1","ring_group2"]}]},"sample3":{"value":[{"op":"replace","path":"/timeToCall","value":"2022-02-10T09:39:19Z"},{"op":"replace","path":"/phoneNumber","value":"+8613036130259"},{"op":"replace","path":"/timezone","value":"Asia/Shanghai"},{"op":"replace","path":"/assignType","value":"ANY_ELIGIBLE_AGENT"}]}}}}},"responses":{"200":{"description":"return the updated callback","content":{"application/hal+json":{"schema":{"type":"object","required":["callback_id"],"properties":{"callback_id":{"type":"string","description":"Id of the callback"},"account_id":{"type":"string","description":"Id of the account"},"interaction_id":{"type":"string","description":"The interaction id of where the callback originates from."},"caller_id":{"type":"string","description":"The number that will be shown as the caller"},"scheduled_time_to_call":{"type":"string","format":"date-time","description":"The time the callback is scheduled"},"timezone":{"type":"string","description":"The timezone in which the callback is scheduled"},"preferred_start_time":{"type":"string","format":"date-time","description":"The started preferred time window on the preview screen inside conversation-app to schedule the callback"},"preferred_end_time":{"type":"string","format":"date-time","description":"The ended preferred time window on the preview screen inside conversation-app to schedule the callback"},"processed_time":{"type":"string","format":"date-time","description":"The time to process the callback"},"created_at":{"type":"string","format":"date-time","description":"The time to create the callback"},"created_by":{"type":"string","description":"The user who created the callback"},"contact_id":{"type":"string","description":"The contact id"},"root_interaction_id":{"type":"string","description":"The root interaction id of where the callback originates from."},"teams":{"type":"array","items":{"type":"object","required":["team_id"],"properties":{"team_id":{"type":"string"}}},"description":"Describes what teams the callback is assigned to"},"assign_type":{"type":"string","description":"Describes what assign type is this related to","enum":["MYSELF_ONLY","SPECIFIC_AGENT","SPECIFIC_RING_GROUP","MYSELF_IF_AVAILABLE","ANY_ELIGIBLE_AGENT"]},"from_call_type":{"type":"string","description":"Describes what call type is this related to","enum":["INBOUND","MANUAL_OUTBOUND","PROACTIVE_OUTBOUND"]},"dialing_model":{"type":"string","description":"Describes what dialing model is this related to","enum":["PREDICTIVE","PREVIEW"]},"ring_groups":{"type":"array","items":{"type":"object","required":["ring_group"],"properties":{"ring_group":{"type":"string"}}},"description":"Describes what ring groups the callback is assigned to, when assign_type = specific ring groups."},"agents":{"type":"array","items":{"type":"object","required":["agent_id"],"properties":{"agent_id":{"type":"string"}}},"description":"Describes who are the agents the callback is assigned to, , when assign_type = specific agents."},"campaign_id":{"type":"string","description":"The campaign id of where the callback originates from."},"record_id":{"type":"string","description":"The id of the record list where the record comes from."},"record_list_id":{"type":"string","description":"the id of the record list that is scheduled to be called"},"phone_number":{"type":"string","description":"The phone number that is scheduled to be called"},"record_first_name":{"type":"string","description":"First name of the record that is scheduled to be called"},"record_last_name":{"type":"string","description":"Last name of the record that is scheduled to be called"},"record_extra_data":{"type":"object","description":"Extra Data from the record that is scheduled to be called"},"next_time_to_call":{"type":"string","format":"date-time","description":"The next time the callback will be retried."},"status":{"type":"string","description":"The status of callback","enum":["UNATTEMPTED,","TO_BE_RETRIED,","EXHAUSTED,","SUCCESS,","CANCELED,","INVALID_NUMBER"]},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}}}}}},"example":{"callback_id":"2da8a248-4b77-463e-9a36-d724f5792971","account_id":"6142f79f738eb0e4a44b18c4","interaction_id":"03e5c6f0-53c5-4b76-86ef-8d89ac67cdc6","caller_id":"+155598754214","scheduled_time_to_call":"2021-03-24T11:48:40.500Z","timezone":"Europe/Lisbon","preferred_start_time":"2000-01-01T12:00:00.000Z","preferred_end_time":"2000-01-01T18:00:00.000Z","processed_time":"2021-03-24T11:48:40.500Z","created_at":"2021-03-24T11:40:40.500Z","created_by":"Chandler","contact_id":"4028814076d8250c0176d826d90f0000","root_interaction_id":"13e5c6f0-53c5-4b76-86ef-8d89ac67cdc2","teams":[{"team_id":"5b34eb0cdcba1b000bdbd321"}],"assign_type":"MYSELF_ONLY","from_call_type":"PROACTIVE_OUTBOUND","dialing_model":"PREDICTIVE","ring_groups":[{"ring_group":"61935f5904147e334756017d"}],"agents":[{"agent_id":"5252g4504147e334756017d"}],"campaign_id":"8c86a8f4-da30-41ac-a09d-148e7690c330","record_id":"2b56abbb-1bb2-40de-9b88-243a4773b518","record_list_id":"c9798bc0-4f5d-474f-afb7-88bf6e543c94","phone_number":"+351910000000","record_first_name":"Chandler","record_last_name":"Bing","next_time_to_call":"2023-03-24T11:48:40Z","status":"UNATTEMPTED","record_extra_data":{"job":"statistical analysis and data reconfiguration.","address":"Apartment #19 in Greenwich Village, Manhattan"},"_links":{"self":{"href":"https://api.talkdeskapp.com/callbacks/2da8a248-4b77-463e-9a36-d724f5792971"}}}}}},"400":{"description":"Errors were found in the submitted data","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0532006","message":"Errors were found in the submitted data."}}}},"401":{"description":"Unauthorized","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0011003","message":"Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0532003","message":"Insufficient scopes for the requested operation"}}}},"404":{"description":"Callback not found","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0532002","message":"The requested resource could not be found"}}}}}},"get":{"description":"Get a callback entry","summary":"Returns the full details (including status, timestamps, and metadata) of a specific scheduled callback.","x-namespace":"/schedule-callbacks","tags":["Schedule Callback"],"security":[{"GA":["schedule-callbacks:read"]}],"parameters":[{"name":"id","in":"path","description":"The identifier of the callback.","required":true,"schema":{"type":"string","minLength":1,"maxLength":36}}],"responses":{"200":{"description":"Get a callback entry","content":{"application/hal+json":{"schema":{"type":"object","required":["callback_id"],"properties":{"callback_id":{"type":"string","description":"Id of the callback"},"account_id":{"type":"string","description":"Id of the account"},"interaction_id":{"type":"string","description":"The interaction id of where the callback originates from."},"caller_id":{"type":"string","description":"The number that will be shown as the caller"},"scheduled_time_to_call":{"type":"string","format":"date-time","description":"The time the callback is scheduled"},"timezone":{"type":"string","description":"The timezone in which the callback is scheduled"},"preferred_start_time":{"type":"string","format":"date-time","description":"The started preferred time window on the preview screen inside conversation-app to schedule the callback"},"preferred_end_time":{"type":"string","format":"date-time","description":"The ended preferred time window on the preview screen inside conversation-app to schedule the callback"},"processed_time":{"type":"string","format":"date-time","description":"The time to process the callback"},"created_at":{"type":"string","format":"date-time","description":"The time to create the callback"},"created_by":{"type":"string","description":"The user who created the callback"},"contact_id":{"type":"string","description":"The contact id"},"root_interaction_id":{"type":"string","description":"The root interaction id of where the callback originates from."},"teams":{"type":"array","items":{"type":"object","required":["team_id"],"properties":{"team_id":{"type":"string"}}},"description":"Describes what teams the callback is assigned to"},"assign_type":{"type":"string","description":"Describes what assign type is this related to","enum":["MYSELF_ONLY","SPECIFIC_AGENT","SPECIFIC_RING_GROUP","MYSELF_IF_AVAILABLE","ANY_ELIGIBLE_AGENT"]},"from_call_type":{"type":"string","description":"Describes what call type is this related to","enum":["INBOUND","MANUAL_OUTBOUND","PROACTIVE_OUTBOUND"]},"dialing_model":{"type":"string","description":"Describes what dialing model is this related to","enum":["PREDICTIVE","PREVIEW"]},"ring_groups":{"type":"array","items":{"type":"object","required":["ring_group"],"properties":{"ring_group":{"type":"string"}}},"description":"Describes what ring groups the callback is assigned to, when assign_type = specific ring groups."},"agents":{"type":"array","items":{"type":"object","required":["agent_id"],"properties":{"agent_id":{"type":"string"}}},"description":"Describes who are the agents the callback is assigned to, , when assign_type = specific agents."},"campaign_id":{"type":"string","description":"The campaign id of where the callback originates from."},"record_id":{"type":"string","description":"The id of the record list where the record comes from."},"record_list_id":{"type":"string","description":"the id of the record list that is scheduled to be called"},"record_list_name":{"type":"string","description":"the name of the record list that is scheduled to be called"},"phone_number":{"type":"string","description":"The phone number that is scheduled to be called"},"record_first_name":{"type":"string","description":"First name of the record that is scheduled to be called"},"record_last_name":{"type":"string","description":"Last name of the record that is scheduled to be called"},"record_extra_data":{"type":"object","description":"Extra Data from the record that is scheduled to be called"},"time_to_call":{"type":"string","format":"date-time","description":"The time the callback is scheduled"},"next_time_to_call":{"type":"string","format":"date-time","description":"The next time the callback will be retried."},"current_retry_attempts":{"type":"integer","description":"The current retry times of this callback."},"current_rescheduled_attempts":{"type":"integer","description":"The current rescheduled times of this callback."},"max_rescheduled_attempts":{"type":"integer","description":"The max rescheduled times of this callback."},"status":{"type":"string","description":"The status of callback","enum":["UNATTEMPTED,","TO_BE_RETRIED,","EXHAUSTED,","SUCCESS,","CANCELED,","INVALID_NUMBER"]},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}}}}}},"example":{"callback_id":"2da8a248-4b77-463e-9a36-d724f5792971","account_id":"6142f79f738eb0e4a44b18c4","interaction_id":"03e5c6f0-53c5-4b76-86ef-8d89ac67cdc6","caller_id":"+155598754214","scheduled_time_to_call":"2021-03-24T11:48:40.500Z","timezone":"Europe/Lisbon","preferred_start_time":"2000-01-01T12:00:00.000Z","preferred_end_time":"2000-01-01T18:00:00.000Z","processed_time":"2021-03-24T11:48:40.500Z","created_at":"2021-03-24T11:40:40.500Z","created_by":"Chandler","contact_id":"4028814076d8250c0176d826d90f0000","root_interaction_id":"13e5c6f0-53c5-4b76-86ef-8d89ac67cdc2","teams":[{"team_id":"5b34eb0cdcba1b000bdbd321"}],"assign_type":"MYSELF_ONLY","from_call_type":"PROACTIVE_OUTBOUND","dialing_model":"PREDICTIVE","ring_groups":[{"ring_group":"61935f5904147e334756017d"}],"agents":[{"agent_id":"5252g4504147e334756017d"}],"campaign_id":"8c86a8f4-da30-41ac-a09d-148e7690c330","record_id":"2b56abbb-1bb2-40de-9b88-243a4773b518","record_list_id":"c9798bc0-4f5d-474f-afb7-88bf6e543c94","record_list_name":"TEST","phone_number":"+351910000000","record_first_name":"Chandler","record_last_name":"Bing","time_to_call":"2023-03-24T11:48:40.500Z","next_time_to_call":"2023-03-24T11:48:40Z","current_retry_attempts":0,"current_rescheduled_attempts":0,"max_rescheduled_attempts":3,"status":"UNATTEMPTED","record_extra_data":{"job":"statistical analysis and data reconfiguration.","address":"Apartment #19 in Greenwich Village, Manhattan"},"_links":{"self":{"href":"https://api.talkdeskapp.com/callbacks/2da8a248-4b77-463e-9a36-d724f5792971"}}}}}},"400":{"description":"Bad Request - Invalid query parameters","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0532006","message":"Errors were found in the submitted data."}}}},"401":{"description":"Unauthorized","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0011003","message":"Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0532003","message":"Insufficient scopes for the requested operation"}}}},"404":{"description":"Callback entry not found","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0532002","message":"The requested resource could not be found"}}}}}}},"/do-not-call-lists/{id}/entries/queries":{"post":{"summary":"Search do not call list Entries by phone numbers and timezone","tags":["Do Not Call Lists"],"description":"Returns a list of entries from a do not call list object filtering by phone numbers and timezones","x-namespace":"/do-not-call-lists","security":[{"EarlyAccess":["do-not-call-lists:manage"]}],"parameters":[{"name":"id","in":"path","description":"Do not call list id","required":true,"schema":{"type":"string","maxLength":35}}],"requestBody":{"description":"List of phone numbers and timezones that will be used to check expiration date","required":true,"content":{"application/hal+json":{"schema":{"example":{"phone_numbers":[{"phone_number":"+351987890987","timezone":"Europe/Lisbon"},{"phone_number":"+351911890987","timezone":"Europe/Lisbon"}]},"type":"object","description":"Phone number with timezone item object","properties":{"phone_numbers":{"description":"List of paginated phone numbers","type":"array","items":{"description":"Phone number with timzeone object","type":"object","properties":{"phone_number":{"type":"string","minLength":1,"maxLength":20,"description":"phone number of the record"},"timezone":{"type":"string","description":"timezone of the phone number"}},"required":["phone_number","timezone"]}}},"required":["phone_numbers"]}}}},"responses":{"200":{"description":"Returns the list of entries filtered by phone numbers and timezone","content":{"application/hal+json":{"schema":{"description":"List with the paginated samples","required":["total","count","page","per_page","_links","_embedded"],"properties":{"per_page":{"description":"The number of items per page","type":"integer"},"total":{"description":"The total number of items.","type":"integer"},"count":{"description":"The number of items in the page","type":"integer"},"page":{"description":"The number of the current page","type":"integer"},"total_pages":{"description":"The total number of pages","type":"integer"},"_links":{"type":"object","description":"HAL API related links.","required":["self","first","prev","next","last"],"properties":{"next":{"description":"Link of the next page","type":"object","properties":{"href":{"description":"Address of the resource","type":"string"}}},"last":{"description":"Link of the last page","type":"object","properties":{"href":{"description":"Address of the resource","type":"string"}}},"prev":{"description":"Link of the previous page","type":"object","properties":{"href":{"description":"Address of the resource","type":"string"}}},"self":{"description":"Link of the current page","type":"object","properties":{"href":{"description":"Address of the resource","type":"string"}}},"first":{"description":"Link of the first page","type":"object","properties":{"href":{"description":"Address of the resource","type":"string"}}}}},"_embedded":{"properties":{"entries":{"description":"List of entries paginated.","items":{"description":"Record HAL object.","readOnly":true,"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"entry id"},"do_not_call_list_id":{"type":"string","format":"uuid","description":"Do not call list id (optional)"},"phone_number":{"type":"string","description":"phone number of the record"},"reason":{"type":"string","description":"reason for the phone number is being added to do not call list"},"expiration_date":{"type":"string","description":"date where the dncl entry expires"},"created_at":{"type":"string","description":"Record creation date"},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}}}}}},"type":"array"}},"type":"object","required":["entries"]}},"type":"object"},"example":{"page":2,"total_pages":3,"per_page":1,"total":3,"count":1,"_links":{"self":{"href":"https://api.talkdeskapp.com/do-not-call-lists/594ba829-8b1c-4ec2-bfc5-d5a26bafdf1c/entries?page=2&per_page=2"},"next":{"href":"https://api.talkdeskapp.com/do-not-call-lists/594ba829-8b1c-4ec2-bfc5-d5a26bafdf1c/entries?page=3&per_page=3"},"prev":{"href":"https://api.talkdeskapp.com/do-not-call-lists/594ba829-8b1c-4ec2-bfc5-d5a26bafdf1c/entries?page=1&per_page=1"},"first":{"href":"https://api.talkdeskapp.com/do-not-call-lists/594ba829-8b1c-4ec2-bfc5-d5a26bafdf1c/entries?page=1&per_page=1"},"last":{"href":"https://api.talkdeskapp.com/do-not-call-lists/594ba829-8b1c-4ec2-bfc5-d5a26bafdf1c/entries?page=3&per_page=3"}},"_embedded":{"entries":[{"id":"27b197c0-4a66-49e4-becb-50eff2be97b5","phone_number":"+351929312312","reason":"customer request","expiration_date":"2021-12-31","created_at":"2020-03-24T11:48:40.503Z","_links":{"self":{"href":"https://api.talkdeskapp.com/do-not-call-lists/594ba829-8b1c-4ec2-bfc5-d5a26bafdf1c/entries/queries"},"do-not-call-list":{"href":"https://api.talkdeskapp.com/do-not-call-lists/594ba829-8b1c-4ec2-bfc5-d5a26bafdf1c"}}}]}}}}},"400":{"description":"Errors were found in the submitted data","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"General bad request":{"value":{"code":"0531500","message":"Errors were found in the submitted data."}}}}}},"401":{"description":"Unauthorized","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0531501","message":"Missing or invalid authentication token."}}}},"403":{"description":"Forbidden","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0531502","message":"Insufficient scopes for the requested operation."}}}},"404":{"description":"Do not call list not found.","content":{"application/hal+json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0531510","message":"Do Not Call List not found."}}}}}}},"/healthcare/payers/contacts/members/{member_id}":{"put":{"tags":["HLS Payers"],"summary":"Update contact","description":"Updates contact by member id and by phone number.","operationId":"upsertContact","security":[{"GA":["hls-payers-connections:write"]}],"parameters":[{"name":"member_id","in":"path","description":"The id of the Member.","required":true,"schema":{"type":"string","minLength":1,"example":"82ba9989-f98a-4aa5-8388-d75138629a76"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["phone_number"],"properties":{"phone_number":{"type":"string","minLength":1,"description":"The phone number of the contact."}}},"example":{"phone_number":"+351911111111"}}},"required":true},"responses":{"200":{"description":"Contact successfully updated"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484010","message":"Invalid JWT token."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484030","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484040","message":"Resource not found."}}}}}}},"/healthcare/payers/connections/members/{member_id}":{"get":{"tags":["HLS Payers"],"summary":"Find Member by id","description":"Find Member by id","operationId":"healthcareConnectionsGetMemberById","security":[{"GA":["hls-payers-connections:read"]}],"parameters":[{"name":"member_id","in":"path","description":"The id of the Member.","required":true,"schema":{"type":"string","minLength":1,"example":"82ba9989-f98a-4aa5-8388-d75138629a76"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","required":["id","full_name","date_of_birth","ssn"],"properties":{"id":{"type":"string","minLength":1,"description":"The Member's id."},"full_name":{"type":"string","minLength":1,"description":"The Member's full name."},"date_of_birth":{"type":"string","minLength":1,"description":"The Member's date of birth. Date format is yyyy-MM-dd."},"gender":{"type":"string","minLength":1,"description":"The Member's gender.","enum":["MALE","FEMALE","NOT_SPECIFIED","UNDEFINED"]},"marital_status":{"type":"string","minLength":1,"description":"The Member's marital status.","enum":["SINGLE","MARRIED","OTHER","NOT_SPECIFIED","UNDEFINED"]},"phone_numbers":{"type":"array","description":"List of the Member's phone numbers.","items":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","minLength":1,"description":"The phone number type.","enum":["HOME","WORK","MOBILE"]},"value":{"type":"string","minLength":1,"description":"The phone number."}}}},"emails":{"type":"array","description":"List of the Member's emails.","items":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","minLength":1,"description":"The email type.","enum":["HOME","WORK"]},"value":{"type":"string","minLength":1,"description":"The email address."}}}},"address":{"type":"string","minLength":1,"description":"The Member's address."},"preferred_language":{"type":"string","minLength":1,"description":"The Member's preferred language."},"ssn":{"type":"string","minLength":1,"description":"The Member's Social Security Number."},"primary_care_provider":{"type":"string","minLength":1,"description":"The Member's primary care provider."},"medical_group":{"type":"string","minLength":1,"description":"The Member's medical group."},"member_since":{"type":"string","minLength":1,"description":"The date they became a Member. Date format is yyyy-MM-dd."},"medicare_beneficiary_identifier":{"type":"string","minLength":1,"description":"The Member's medicare beneficiary identifier."},"primary_plan":{"description":"The primary plan of the Member.","type":"object","required":["id","plan_name","plan_group_id","member_id","plan_status"],"properties":{"id":{"type":"string","minLength":1,"description":"The id of the Plan."},"plan_name":{"type":"string","minLength":1,"description":"The name of the Plan."},"plan_group_id":{"type":"string","minLength":1,"description":"The id of the plan group."},"member_id":{"type":"string","minLength":1,"description":"The id of the Member."},"plan_status":{"type":"string","minLength":1,"description":"The status of the Plan.","enum":["ACTIVE","INACTIVE"]}}},"other_plans":{"type":"array","items":{"type":"object","required":["id","plan_name","plan_group_id","member_id","plan_status"],"properties":{"id":{"type":"string","minLength":1,"description":"The id of the Plan."},"plan_name":{"type":"string","minLength":1,"description":"The name of the Plan."},"plan_group_id":{"type":"string","minLength":1,"description":"The id of the plan group."},"member_id":{"type":"string","minLength":1,"description":"The id of the Member."},"plan_status":{"type":"string","minLength":1,"description":"The status of the Plan.","enum":["ACTIVE","INACTIVE"]}}},"description":"The list of the other plans of the Member."},"screen_popup_url":{"type":"string","minLength":1,"description":"The url of the screen popup."}}},"example":{"id":"82ba9989-f98a-4aa5-8388-d75138629a76","full_name":"John Doe","date_of_birth":"1980-01-20","gender":"MALE","marital_status":"SINGLE","phone_numbers":[{"type":"HOME","value":"+351911111111"}],"emails":[{"type":"HOME","value":"johndoe@mail.com"}],"address":"First Street","preferred_language":"EN","ssn":"1234","primary_care_provider":"Care Provider","medical_group":"Medical Group","member_since":"2016-02-15","medicare_beneficiary_identifier":"3SI3-GA2-NM84","primary_plan":{"id":"700fca3d-848e-4af7-bc74-3c0a1193510b","plan_name":"Plan name","plan_group_id":"plangroup1234","member_id":"member1234","plan_status":"ACTIVE"},"other_plans":[{"id":"2b69063d-5596-4d59-966d-a488982affbf","plan_name":"Plan name 2","plan_group_id":"plangroup1234","member_id":"member1234","plan_status":"INACTIVE"},{"id":"1b12e412-985e-4ccc-a384-4ab34dd036c4","plan_name":"Plan name 3","plan_group_id":"plangroup1234","member_id":"member1234","plan_status":"ACTIVE"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484010","message":"Invalid JWT token."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484030","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484040","message":"Resource not found."}}}}}}},"/healthcare/payers/connections/members":{"get":{"tags":["HLS Payers"],"summary":"Member lookup connections","description":"Retrieves the best matching member searched by query parameters.","operationId":"memberLookup","security":[{"GA":["hls-payers-connections:read"]}],"parameters":[{"name":"full_name","in":"query","description":"The Member's full name.","required":false,"schema":{"type":"string","minLength":1,"example":"John Doe"}},{"name":"date_of_birth","in":"query","description":"The Member's date of birth. Date format is yyyy-MM-dd.","required":false,"schema":{"type":"string","minLength":1,"example":"1980-01-20"}},{"name":"phone_number","in":"query","description":"The Member's phone number.","required":false,"schema":{"type":"string","minLength":1,"example":"+351911111111"}},{"name":"email","in":"query","description":"The Member's email.","required":false,"schema":{"type":"string","minLength":1,"example":"johndoe@mail.com"}},{"name":"ssn","in":"query","description":"The Member's Social Security Number.","required":false,"schema":{"type":"string","minLength":1,"example":"1234"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","required":["id","full_name","date_of_birth","ssn","count"],"properties":{"id":{"type":"string","minLength":1,"description":"The Member's id."},"full_name":{"type":"string","minLength":1,"description":"The Member's full name."},"date_of_birth":{"type":"string","minLength":1,"description":"The Member's date of birth. Date format is yyyy-MM-dd."},"home_phone_number":{"type":"string","minLength":1,"description":"The Member's home phone number."},"mobile_phone_number":{"type":"string","minLength":1,"description":"The Member's mobile phone number."},"home_email":{"type":"string","minLength":1,"description":"The Member's home email."},"work_email":{"type":"string","minLength":1,"description":"The Member's work email."},"address":{"type":"string","minLength":1,"description":"The Member's address."},"preferred_language":{"type":"string","minLength":1,"description":"The Member's preferred language."},"ssn":{"type":"string","minLength":1,"description":"The Member's social security number."},"medicare_beneficiary_identifier":{"type":"string","minLength":1,"description":"The Member's medicare beneficiary identifier."},"count":{"type":"integer","minLength":1,"description":"The total members found."}}},"example":{"id":"82ba9989-f98a-4aa5-8388-d75138629a76","full_name":"John Doe","date_of_birth":"1980-01-20","home_phone_number":"+351911111111","work_phone_number":"+18654128824","home_email":"john.doe@mail.com","work_email":"john.doe@workmail.com","address":"First Street","preferred_language":"en-US","ssn":"1234","medicare_beneficiary_identifier":"3SI3-GA2-NM84","count":1}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484010","message":"Invalid JWT token."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484030","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484040","message":"Resource not found."}}}}}}},"/healthcare/payers/connections/claims/{claim_id}/status":{"get":{"tags":["HLS Payers"],"summary":"Get a claim status by its id","description":"Retrieves the status of a claim, given its id","operationId":"get_claim_status_by_id_public","security":[{"GA":["hls-payers-connections:read"]}],"parameters":[{"name":"claim_id","description":"Identifier if the claim from which we'll get the status","in":"path","required":true,"schema":{"type":"string","minLength":1,"example":"98675264"}},{"name":"date_of_service","description":"Date of the claim","required":false,"in":"query","schema":{"type":"string","minLength":10,"example":"2023-02-22"}},{"name":"organization_unit","description":"Organization where the claim were registered","required":false,"in":"query","schema":{"type":"string","minLength":1,"example":"p93n3u58"}},{"name":"provider_id","description":"Provider were the claim was registered","required":false,"in":"query","schema":{"type":"string","minLength":1,"example":"25"}},{"name":"member_id","description":"Member that did the claim","required":false,"in":"query","schema":{"type":"string","minLength":1,"example":"75"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","required":["status"],"properties":{"status":{"description":"The current state of the job. Can be one of `APPROVED`, `DENIED` or `PENDING`","type":"string","minLength":6}}},"example":{"status":"APPROVED"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484010","message":"Invalid JWT token."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484030","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484040","message":"Resource not found."}}}}}}},"/healthcare/payers/connections/prior-authorizations/{prior_authorization_id}/status":{"get":{"tags":["HLS Payers"],"summary":"Get a prior authorization status by its id","description":"Retrieves the status of a prior authorization, given its id","operationId":"get_prior_authorization_status_by_id_public","security":[{"GA":["hls-payers-connections:read"]}],"parameters":[{"name":"prior_authorization_id","description":"Identifier if the prior authorization from which we'll get the status","in":"path","required":true,"schema":{"type":"string","minLength":1,"example":"98675264"}},{"name":"dos","description":"Date of the prior authorization","required":false,"in":"query","schema":{"type":"string","minLength":10,"example":"2023-02-22"}},{"name":"organization_unit","description":"Organization where the prior authorization were registered","required":false,"in":"query","schema":{"type":"string","minLength":1,"example":"p93n3u58"}},{"name":"pre_authorization_referring_provider_id","description":"Provider that did the reference","required":false,"in":"query","schema":{"type":"string","minLength":1,"example":"25"}},{"name":"pre_authorization_referring_to_provider_id","description":"Provider which the member was referred to","required":false,"in":"query","schema":{"type":"string","minLength":1,"example":"25"}},{"name":"pcp_provider_id","description":"Primary care provider","required":false,"in":"query","schema":{"type":"string","minLength":1,"example":"25"}},{"name":"member_id","description":"Member that did the prior authorization","required":false,"in":"query","schema":{"type":"string","minLength":1,"example":"75"}},{"name":"pre_authorization_referring_provider_first_name","description":"First name of the provider that did the reference","required":false,"in":"query","schema":{"type":"string","minLength":1,"example":"75"}},{"name":"pre_authorization_referring_provider_last_name","description":"Last name of the provider that did the reference","required":false,"in":"query","schema":{"type":"string","minLength":1,"example":"75"}},{"name":"pre_authorization_referring_to_provider_first_name","description":"First name of the provider which the member was referred to","required":false,"in":"query","schema":{"type":"string","minLength":1,"example":"75"}},{"name":"pre_authorization_referring_to_provider_last_name","description":"Last name of the provider which the member was referred to","required":false,"in":"query","schema":{"type":"string","minLength":1,"example":"75"}},{"name":"pcp_provider_first_name","description":"Primary care provider first name","required":false,"in":"query","schema":{"type":"string","minLength":1,"example":"75"}},{"name":"pcp_provider_last_name","description":"Primary care provider last name","required":false,"in":"query","schema":{"type":"string","minLength":1,"example":"75"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","required":["status"],"properties":{"status":{"description":"The current state of the job. Can be one of `APPROVED`, `DENIED` or `PENDING`","type":"string","minLength":6}}},"example":{"status":"APPROVED"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484010","message":"Invalid JWT token."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484030","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484040","message":"Resource not found."}}}}}}},"/healthcare/payers/connections/providers":{"get":{"tags":["HLS Payers"],"summary":"Provider lookup connections","description":"Retrieves the best matching provider searched by query parameters.","operationId":"providerLookupConnections","security":[{"GA":["hls-payers-connections:read"]}],"parameters":[{"name":"phone_number","in":"query","description":"The Provider's phone number.","required":false,"schema":{"type":"string","minLength":1,"example":"+351911111111"}},{"name":"date_of_birth","in":"query","description":"The Provider's date of birth.","required":false,"schema":{"type":"string","minLength":1,"example":"1980-01-20"}},{"name":"npi","in":"query","description":"The Provider's npi.","required":false,"schema":{"type":"string","minLength":1,"example":"1234"}},{"name":"provider_id","in":"query","description":"The Provider's id.","required":false,"schema":{"type":"string","minLength":1,"example":"1234"}},{"name":"organization_unit","in":"query","description":"The Provider's organization unit.","required":false,"schema":{"type":"string","minLength":1,"example":"1234"}},{"name":"name","in":"query","description":"The provider's name","required":false,"schema":{"type":"string","minLength":1,"example":"1234"}},{"name":"related_member_id","in":"query","description":"The related member id of a provider","required":false,"schema":{"type":"string","minLength":1,"example":"1234"}},{"name":"tax_id","in":"query","description":"The provider's Tax ID","required":false,"schema":{"type":"string","minLength":1,"example":"999-99-9999"}},{"name":"skip","in":"query","description":"The start index to fetch the providers.","required":false,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":2147483647,"default":0,"example":0}},{"name":"limit","in":"query","description":"The total amount of providers to be fetched.","required":false,"schema":{"type":"integer","format":"int32","minimum":1,"maximum":100,"default":50,"example":50}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","required":["id","full_name","date_of_birth","npi"],"properties":{"id":{"type":"string","minLength":1,"description":"The Provider's id."},"full_name":{"type":"string","minLength":1,"description":"The Provider's full name."},"date_of_birth":{"type":"string","minLength":1,"description":"The Provider's date of birth."},"phone_number":{"type":"string","minLength":1,"description":"The Provider's phone number."},"npi":{"type":"string","minLength":1,"description":"The Provider's npi."},"organization_unit":{"type":"string","minLength":1,"description":"The Provider's organization unit."},"medical_group_id":{"type":"string","minLength":1,"description":"The Provider's medical group id."},"medical_group_name":{"type":"string","minLength":1,"description":"The Provider's medical group name."},"pcp_speciality_id":{"type":"string","minLength":1,"description":"The Provider's primary care provider speciality id."},"pcp_speciality_name":{"type":"string","minLength":1,"description":"The Provider's primary care provider speciality name."}}},"example":{"_embedded":{"providers":[{"id":"82ba9989-f98a-4aa5-8388-d75138629a76","full_name":"John Doe","date_of_birth":"1980-01-20","phone_number":"+351911111111","npi":"3SI3-GA2-NM84","medical_group_id":"984-KFHM-098","medical_group_name":"INTERN","pcp_speciality_id":"09847-LKDHJ-0987","pcp_speciality_name":"PEDIATRICS","organization_unit":"POK"}]},"total":1}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484010","message":"Invalid JWT token."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484030","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484040","message":"Resource not found."}}}}}}},"/healthcare/payers/connections/claims":{"get":{"tags":["HLS Payers"],"summary":"Get claims","description":"Retrieves claims","operationId":"get_claims_public","security":[{"GA":["hls-payers-connections:read"]}],"parameters":[{"name":"member_id","description":"Member ID from the claim beneficiary","in":"query","required":false,"schema":{"type":"string","minLength":1,"example":"98675264"}},{"name":"provider_id","description":"Provider ID where the claim was registered","in":"query","required":false,"schema":{"type":"string","minLength":1,"example":"98675264"}},{"name":"plan_id","description":"Plan ID where the claim was registered","in":"query","required":false,"schema":{"type":"string","minLength":1,"example":"98675264"}},{"name":"start_date_of_service","description":"The start date of the claim","required":false,"in":"query","schema":{"type":"string","minLength":10,"maxLength":10,"example":"2023-02-22"}},{"name":"end_date_of_service","description":"The end date of the claim","required":false,"in":"query","schema":{"type":"string","minLength":10,"maxLength":10,"example":"2023-02-22"}},{"name":"organization_unit","description":"Organization where the claim were registered","required":false,"in":"query","schema":{"type":"string","minLength":1,"example":"p93n3u58"}},{"name":"status","in":"query","description":"The claim status (APPROVED, DENIED, PENDING)","required":false,"schema":{"type":"string","minLength":1,"example":"APPROVED"}},{"name":"skip","in":"query","description":"The start index to fetch the event types.","required":false,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":2147483647,"default":0,"example":0}},{"name":"limit","in":"query","description":"The total amount of event types to be fetched.","required":false,"schema":{"type":"integer","format":"int32","minimum":1,"maximum":100,"default":50,"example":50}},{"name":"sort_by","in":"query","description":"The sort mechanism.","required":false,"schema":{"type":"string","minimum":1,"maximum":50,"example":"memberId"}},{"name":"order","in":"query","description":"The order mechanism.","required":false,"schema":{"type":"string","minimum":1,"example":"ASC"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","required":["_embedded","total"],"properties":{"_embedded":{"type":"object","required":["claims"],"properties":{"claims":{"type":"array","items":{"type":"object","required":["id","status","billing_amount","paid_amount","claim_provider","date_of_service"],"properties":{"id":{"type":"string","minLength":1,"description":"The ID of the claim."},"status":{"type":"string","description":"The claim status.","minLength":1,"enum":["APPROVED","DENIED","PENDING"]},"billing_amount":{"type":"object","required":["value","currency_code"],"properties":{"value":{"format":"double","type":"number","description":"Value of the monetary amount"},"currency_code":{"type":"string","minLength":1,"description":"Currency of the monetary amount"}}},"paid_amount":{"type":"object","required":["value","currency_code"],"properties":{"value":{"format":"double","type":"number","description":"Value of the monetary amount"},"currency_code":{"type":"string","minLength":1,"description":"Currency of the monetary amount"}}},"date_of_service":{"type":"string","minLength":10,"maxLength":10,"description":"The Claim's date of service. Date format is yyyy-MM-dd."},"claim_provider":{"type":"string","description":"Claim's provider"}}}}}},"total":{"type":"integer","format":"int32"}}},"example":{"_embedded":{"claims":[{"id":"12345678P","status":"DENIED","billing_amount":{"value":2000,"currency_code":"USD"},"paid_amount":{"value":0,"currency_code":"USD"},"claim_provider":"Bob Jones, MD","date_of_service":"2021-11-25"},{"id":"987654321T","status":"DENIED","billing_amount":{"value":1000,"currency_code":"USD"},"paid_amount":{"value":0,"currency_code":"USD"},"claim_provider":"Bob Jones, MD","date_of_service":"2021-07-25"}]},"total":2}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484010","message":"Invalid JWT token."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484030","message":"Required scopes are missing."}}}}}}},"/healthcare/payers/connections/prior-authorizations":{"get":{"tags":["HLS Payers"],"summary":"Get prior authorizations","description":"Retrieves an offset based list of prior authorizations","operationId":"get_prior_authorizations","security":[{"GA":["hls-payers-connections:read"]}],"parameters":[{"name":"skip","description":"The start index to fetch prior authorizations","in":"query","required":false,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":2147483647,"default":0,"example":0}},{"name":"limit","description":"The total amount of prior authorizations to be fetched","in":"query","required":false,"schema":{"type":"integer","format":"int32","minimum":1,"maximum":100,"default":50,"example":50}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","required":["_embedded","total"],"properties":{"_embedded":{"type":"object","required":["prior_authorizations"],"properties":{"prior_authorizations":{"type":"array","items":{"type":"object","required":["id","status","pre_authorization_referring_provider","dos","reason"],"properties":{"id":{"type":"string","description":"Unique ID of the authorization","minLength":1},"status":{"type":"string","description":"The prior authorization status","minLength":5,"enum":["APPROVED","PENDING","DENIED"]},"pre_authorization_referring_provider":{"type":"object","required":["referring_provider_name","referring_provider_role"],"properties":{"referring_provider_name":{"type":"string","description":"Name of the referring provider","minLength":1},"referring_provider_role":{"type":"string","description":"Role of the referring provider","minLength":1}}},"dos":{"type":"string","description":"DOS of the authorization","minLength":10},"reason":{"type":"string","description":"Reason for the authorization","minLength":1},"requested_date":{"type":"string","format":"date-time","description":"The prior authorization's request date","minLength":38},"authorization_date":{"type":"string","format":"date-time","minLength":38,"description":"The prior authorization's authorization date"},"expiration_date":{"type":"string","format":"date-time","minLength":38,"description":"The prior authorization's expiration date"},"number_of_units":{"type":"integer","minLength":0,"description":"The prior authorization's number of units remaining"}}}}}},"total":{"type":"integer","format":"int32","description":"Total number of prior authorizations","minimum":0}}},"example":{"_embedded":{"prior_authorizations":[{"id":"1032971","status":"APPROVED","pre_authorization_referring_provider":{"referring_provider_name":"John Doe","referring_provider_role":"MD"},"dos":"2023-05-30","reason":"Lorem ipsum dolor","requested_date":"2023-07-10T18:33:20+0000","expiration_date":"2021-01-04T18:33:20+0000","authorization_date":"2021-01-04T18:33:20+0000","number_of_units":2},{"id":"1238167","status":"DENIED","pre_authorization_referring_provider":{"referring_provider_name":"John Doe","referring_provider_role":"MD"},"dos":"2023-05-30","reason":"Lorem ipsum dolor","requested_date":"2023-07-10T18:33:20+0000","expiration_date":"2021-01-04T18:33:20+0000","authorization_date":"2021-01-04T18:33:20+0000","number_of_units":2}]},"total":3}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484010","message":"Invalid JWT token."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484030","message":"Required scopes are missing."}}}}}}},"/healthcare/sycurio/login":{"post":{"tags":["HLS Sycurio Integration"],"summary":"HLS Providers Sycurio Integration","description":"Log in to the Sycurio client, with the configurations in industries-setting.","operationId":"sycurioLogin","security":[{"GA":["hls-sycurio:integrate"]}],"parameters":[{"name":"interaction_id","in":"query","required":false,"description":"Interaction Id","schema":{"type":"string","example":"abc","minLength":1,"maxLength":2147483647}}],"responses":{"200":{"description":"Call Sycurio API successfully","content":{"application/json":{"schema":{"type":"object","required":["login_successful"],"properties":{"id":{"type":"string","description":"Useless ID.","example":"abc","minLength":1,"maxLength":50},"login_successful":{"type":"boolean","description":"Whether logged in to Sycurio successfully.","example":false},"sycurio_session_id":{"type":"string","description":"If logged in to Sycurio successfully, return the Sycurio session ID.","example":"abc","minLength":1,"maxLength":50},"sycurio_login_error_reason":{"type":"string","description":"If failed to log in to Sycurio, log the Sycurio error response detail and return the error reason.","example":"Authentication Error","minLength":1,"maxLength":2147483647}}},"examples":{"Login Sycruio successfully":{"value":{"login_successful":true,"sycurio_session_id":"arseut876543124354678"}},"Failed to login Sycurio":{"value":{"login_successful":false,"sycurio_login_error_reason":"Authentication Error-Unable to authenticate with supplied client account credentials. Client not logged in; no session created."}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Generic Bad Request":{"value":{"code":"1484000","message":"Bad request."}},"Upstream Bad Request":{"value":{"code":"1484001","message":"Bad Request in upstream."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"1484010","message":"Invalid JWT token."}},"No Upstream":{"value":{"code":"1484012","message":"No upstream selected."}},"Upstream Unauthorized":{"value":{"code":"1484014","message":"Unauthorized in upstream."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Missing Scopes":{"value":{"code":"1484030","message":"Required scopes are missing."}},"Account Forbidden":{"value":{"code":"1484031","message":"Account does not have access."}},"Upstream Forbidden":{"value":{"code":"1484032","message":"Forbidden in upstream."}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Not Found":{"value":{"code":"1484040","message":"Resource not found."}},"Upstream Not Found":{"value":{"code":"1484041","message":"Not Found in upstream."}}}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484050","message":"Method not allowed."}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484150","message":"Unsupported Media Type"}}}}}}},"/v1/record-list/{record_list_id}/record/{record_id}/call-attempt-disposition/{disposition}":{"post":{"description":"Triggers the automation for on attempt disposition event","security":[{"GA":["po-record-list-automations:write"]}],"tags":["PO Client Custom Automations"],"parameters":[{"name":"record_list_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"record_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"disposition","in":"path","required":true,"schema":{"type":"string","enum":["EXHAUSTED","CONNECTED"]}},{"name":"account-id","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0380001","message":"An unexpected error has occurred. Contact Talkdesk Support."}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0380002","message":"Service unavailable temporarily"}}}}}}},"/v1/record-list/{record_list_id}/record/{record_id}/schedule-callback-created":{"post":{"description":"Triggers the automation for on schedule callback created event","security":[{"GA":["po-record-list-automations:write"]}],"tags":["PO Client Custom Automations"],"parameters":[{"name":"record_list_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"record_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"account-id","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0380001","message":"An unexpected error has occurred. Contact Talkdesk Support."}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0380002","message":"Service unavailable temporarily"}}}}}}},"/v1/record-list/{record_list_id}/record/{record_id}/callback-attempt-disposition/{disposition}":{"post":{"description":"Triggers the automation for on callback call attempt disposition event","security":[{"GA":["po-record-list-automations:write"]}],"tags":["PO Client Custom Automations"],"parameters":[{"name":"record_list_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"record_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"disposition","in":"path","required":true,"schema":{"type":"string","enum":["SUCCESS","INVALID_NUMBER","NO_ANSWER","AGENT_HANGUP_BEFORE_CONNECTION","BUSY, RESCHEDULED","FINALIZED","UNREACHABLE"]}},{"name":"account-id","in":"header","required":true,"schema":{"type":"string"}},{"name":"is_final_attempt","in":"query","required":false,"schema":{"type":"boolean"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0380001","message":"An unexpected error has occurred. Contact Talkdesk Support."}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0380002","message":"Service unavailable temporarily"}}}}}}},"/webhooks/triggers/{trigger_name}":{"post":{"summary":"Create trigger","description":"Create a new webhook trigger","operationId":"postTrigger","security":[{"GA":["webhooks-trigger:write"]}],"parameters":[{"name":"trigger_name","in":"path","required":true,"description":"Required trigger name","schema":{"type":"string","example":"contactCreated","minLength":0,"maxLength":2147483647}},{"name":"x-ms-workflow-name","in":"header","required":true,"description":"Required trigger id","schema":{"type":"string","example":"b6661868-cfc9-4bbd-8776-03f9efeaaaaa","minLength":0,"maxLength":2147483647}}],"tags":["Webhook trigger"],"requestBody":{"description":"The body of the request","required":true,"content":{"application/json":{"schema":{"description":"Register a new webhook trigger","required":["callbackurl"],"type":"object","properties":{"callbackurl":{"type":"string","minLength":0,"maxLength":2147483647},"title":{"type":"string","minLength":0,"maxLength":2147483647},"message":{"type":"string","minLength":0,"maxLength":2147483647}}},"example":{"callbackurl":"https://prod-74.westeurope.logic.azure.com/workflows/a43d0eeabcbc4f638570e1c945d8a7de/triggers/When_a_contact_is_created","title":"A webhook with When a contact is created in Talkdesk trigger was created","message":"Please configure a new Talkdesk integration."}}}},"responses":{"201":{"description":"Successfully created a webhook trigger","headers":{"location":{"description":"The trigger result location","schema":{"type":"string"},"example":"https://api.talkdeskstg.com/webhooks/triggers/b6661868-cfc9-4bbd-8776-03f9efe00000"}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1734000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0450002","message":"Access denied."}}}},"403":{"description":"Forbidden request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0450003","message":"The request is not authorized - the provided token is not valid"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1413000","message":"Resource not found."}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0015005","message":"API upstream error."}}}}}}},"/webhooks/triggers/{trigger_name}/{trigger_id}":{"delete":{"summary":"Delete trigger","description":"Delete a webhook trigger by Id","operationId":"deleteTrigger","security":[{"GA":["webhooks-trigger:write"]}],"parameters":[{"name":"trigger_name","in":"path","required":true,"description":"Required trigger name","schema":{"type":"string","example":"contactCreated","minLength":0,"maxLength":2147483647}},{"name":"trigger_id","in":"path","required":true,"description":"Required trigger id","schema":{"type":"string","example":"1234","minLength":0,"maxLength":2147483647}}],"tags":["Webhook trigger"],"responses":{"200":{"description":"Deleted"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0450002","message":"Access denied."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0450003","message":"The request is not authorized - the provided token is not valid"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1413000","message":"Resource not found."}}}}}}},"/express/accounts":{"get":{"summary":"Returns the collection of the accounts that are under the caller's organization.","description":"All the accounts that are under the organization calling the rest API will be returned. The IDs of the accounts can later be used to retrieve information on those accounts. The results are paged.","operationId":"expressGetAccounts","parameters":[{"name":"order_by","in":"query","description":"Allows ordering the results by 'id'","schema":{"default":"id:desc","type":"string","maxLength":40,"x-sorting_default_order":"desc","x-sorting_fields":["id"]},"example":"id:asc"},{"name":"page","in":"query","required":false,"schema":{"default":1,"minimum":1,"type":"integer","example":1},"description":"The number of the page to be returned. The default value is 1."},{"name":"per_page","in":"query","required":false,"schema":{"default":50,"minimum":1,"maximum":250,"type":"integer"},"example":100,"description":"The number of results to be returned per page. The default value is 50."}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"count":{"type":"integer","description":"The number of results on the current page.","example":50},"page":{"type":"integer","description":"The number of the current page.","example":2},"per_page":{"type":"integer","description":"The number of results per page.","example":50},"total":{"type":"integer","description":"The total number of results for all pages.","example":425},"total_pages":{"type":"integer","description":"The total number of pages.","example":9},"_embedded":{"type":"object","items":{},"description":"The paginated results."},"_links":{"type":"object","description":"The pagination links."}}},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the Talkdesk account.","example":"5ea75fe7aa224700012eae40"},"name":{"type":"string","description":"The name of the Talkdesk account.","example":"josephpinetrees"},"company_name":{"type":"string","description":"The name of the customer in Talkdesk's CRM.","example":"Joseph Pinetrees Inc."},"status":{"type":"string","description":"The status of the Talkdesk account.","example":"ACTIVE","enum":["ACTIVE","CHURNED","IN_TRIAL","INACTIVE","PROSPECT","TRIAL_LOST","OTHER"]}}}}}},"_links":{"type":"object","properties":{"first":{"type":"object","properties":{"href":{"type":"string","description":"The link to the first page."}}},"last":{"type":"object","properties":{"href":{"type":"string","description":"The link to the last page."}}},"next":{"type":"object","properties":{"href":{"type":"string","description":"The link to the next page."}}},"prev":{"type":"object","properties":{"href":{"type":"string","description":"The link to the previous page."}}},"self":{"type":"object","properties":{"href":{"type":"string","description":"The link to the current page."}}}}}}}]},"example":{"count":50,"page":2,"per_page":50,"total":425,"total_pages":9,"_embedded":{"accounts":[{"id":"5ea75fe7aa224700012eae40","name":"josephpinetrees","company_name":"Joseph Pinetrees Inc.","status":"ACTIVE"}]},"_links":{"first":{"href":"https://api-docs.talkdesk.org/express/accounts?page=2"},"last":{"href":"https://api-docs.talkdesk.org/express/accounts?page=10"},"next":{"href":"https://api-docs.talkdesk.org/express/accounts?page=3"},"prev":{"href":"https://api-docs.talkdesk.org/express/accounts?page=1"},"self":{"href":"https://api-docs.talkdesk.org/express/accounts"}}}}}},"400":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3110000","message":"Invalid parameters."}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3110001","message":"The user does not have permissions to execute this request."}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3110002","message":"Required scopes not given from JWT token."}}},"description":"Forbidden"}},"security":[{"GA":["express-accounts:read"]}],"tags":["EXPRESS API"]}},"/express/accounts/{account_id}/contracts":{"get":{"summary":"Get reseller contract info for an express account","description":"Get reseller contract info for express accounts. This includes the number os seats, the account status and the workflow next transition date and status.","operationId":"getResellerContractInfo","parameters":[{"name":"account_id","in":"path","description":"The account ID for which contract info can be retrieved","required":true,"schema":{"type":"string"},"example":"5ea75fe7aa224700012eae40"}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"description":"Contract info","properties":{"id":{"description":"The account ID.","example":"5ea75fe7aa224700012eae40","type":"string"},"trial":{"description":"True when the account is a free trial.","example":true,"type":"boolean"},"account_status":{"allOf":[{"enum":["ACTIVE","SUSPENDED","CANCELED","TERMINATED"],"type":"string"}],"description":"Account status.","example":"ACTIVE","type":"string"},"license_number":{"description":"Number of licenses.","example":10,"format":"int32","type":"integer","maximum":2147483647,"minimum":0},"transition_date":{"description":"Next workflow transition date.","example":"2022-03-10T16:15:50Z","format":"date-time","type":"string"},"transition_status":{"allOf":[{"enum":["ACTIVE","SUSPENDED","CANCELED","TERMINATED"],"type":"string"}],"description":"Next workflow transition status.","example":"SUSPENDED","type":"string"}},"required":["id","trial","account_status","license_number"],"type":"object"},"example":{"id":"5ea75fe7aa224700012eae40","trial":true,"account_status":"ACTIVE","license_number":10,"transition_date":"2022-03-10T16:15:50.000Z","transition_status":"SUSPENDED"}}}},"401":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3110001","message":"The user does not have permissions to execute this request."}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3110002","message":"Required scopes not given from JWT token."}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3110006","message":"Resource not found."}}},"description":"Not Found"}},"security":[{"GA":["express-accounts-contracts:read"]}],"tags":["EXPRESS API"]}},"/express/accounts/{account_id}/contracts/actions":{"get":{"description":"Get a list of contract actions of an express account.","operationId":"getResellerContractAction","parameters":[{"name":"account_id","in":"path","description":"The account ID for which contract actions can be retrieved","required":true,"schema":{"type":"string"},"example":"5ea75fe7aa224700012eae40"},{"name":"filter","in":"query","required":false,"schema":{"type":"string","maxLength":1600,"x-operators":["eq","ne","gt","ge","lt","le","and","or","not","( )","contains"]},"example":"action_type eq 'NEWTDE'","description":"Allows filtering the results by 'status' and 'action_type' using comparison or logical operators. Example:\n * Returns contract actions of type NEWTDE\n ```\n action_type eq 'NEWTDE'\n ```\n"},{"name":"order_by","in":"query","description":"Allows ordering the results by 'updated_at' and 'created_at'.","schema":{"default":"created_at:desc","type":"string","maxLength":40,"x-sorting_default_order":"desc","x-sorting_fields":["created_at","updated_at"]},"example":"created_at:asc"},{"name":"page","in":"query","required":false,"schema":{"default":1,"minimum":1,"type":"integer","example":1},"description":"The number of the page to be returned. The default value is 1."},{"name":"per_page","in":"query","required":false,"schema":{"default":50,"minimum":1,"maximum":250,"type":"integer"},"example":100,"description":"The number of results to be returned per page. The default value is 50."}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"count":{"type":"integer","description":"The number of results on the current page.","example":50},"page":{"type":"integer","description":"The number of the current page.","example":2},"per_page":{"type":"integer","description":"The number of results per page.","example":50},"total":{"type":"integer","description":"The total number of results for all pages.","example":425},"total_pages":{"type":"integer","description":"The total number of pages.","example":9},"_embedded":{"type":"object","items":{},"description":"The paginated results."},"_links":{"type":"object","description":"The pagination links."}}},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"contract_actions":{"type":"array","items":{"description":"Contract action created","properties":{"id":{"description":"Contract action id","example":123245132132,"type":"string"},"action_type":{"allOf":[{"enum":["NEWTDE","AMENDTDE","CANCELTDE"],"type":"string"}],"description":"Action type.\n* NEWTDE: New subscription.\n* AMENDTDE: Amendment of the current subscription.\n* CANCELTDE: Cancellation of the subscription.","example":"NEWTDE","type":"string"},"quantity":{"description":"Number of licenses","example":10,"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"status":{"allOf":[{"enum":["CREATED","IN_PROGRESS","COMPLETED","FAILED"],"type":"string"}],"description":"Contract action status","example":"CREATED","type":"string"},"status_message":{"description":"Contract action status message","example":"Contract action created successfully","type":"string"},"created_at":{"description":"Creation timestamp","example":"2022-03-10T16:15:50Z","format":"date-time","type":"string"},"updated_at":{"description":"Update timestamp","example":"2022-03-10T16:15:50Z","format":"date-time","type":"string"}},"required":["id","status","action_type","updated_at","created_at"],"type":"object"}}}},"_links":{"type":"object","properties":{"first":{"type":"object","properties":{"href":{"type":"string","description":"The link to the first page."}}},"last":{"type":"object","properties":{"href":{"type":"string","description":"The link to the last page."}}},"next":{"type":"object","properties":{"href":{"type":"string","description":"The link to the next page."}}},"prev":{"type":"object","properties":{"href":{"type":"string","description":"The link to the previous page."}}},"self":{"type":"object","properties":{"href":{"type":"string","description":"The link to the current page."}}}}}}}]},"example":{"count":50,"page":2,"per_page":50,"total":425,"total_pages":9,"_embedded":{"contract_actions":[{"id":"123245132132","action_type":"NEWTDE","quantity":10,"status":"CREATED","status_message":"Contract action created successfully","created_at":"2022-03-10T16:15:50.000Z","updated_at":"2022-03-10T16:15:50.000Z"}]},"_links":{"first":{"href":"https://api-docs.talkdesk.org/express/accounts/5ea75fe7aa224700012eae40/contracts/actions?page=1"},"last":{"href":"https://api-docs.talkdesk.org/express/accounts/5ea75fe7aa224700012eae40/contracts/actions?page=9"},"next":{"href":"https://api-docs.talkdesk.org/express/accounts/5ea75fe7aa224700012eae40/contracts/actions?page=3"},"prev":{"href":"https://api-docs.talkdesk.org/express/accounts/5ea75fe7aa224700012eae40/contracts/actions?page=1"},"self":{"href":"https://api-docs.talkdesk.org/express/accounts/5ea75fe7aa224700012eae40/contracts/actions?page=2"}}}}}},"400":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3110005","message":"Constraint violation(s) occurred during input validation."}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3110001","message":"The user does not have permissions to execute this request."}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3110002","message":"Required scopes not given from JWT token."}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3110006","message":"Resource not found."}}},"description":"Not Found"}},"security":[{"GA":["express-accounts-contracts-actions:read"]}],"tags":["EXPRESS API"]},"post":{"summary":"Create a contract action for express account","description":"Create a contract action for an express account. This operation facilitates the subscription, amendment or cancellation of an express contract.","operationId":"createResellerContractAction","parameters":[{"name":"account_id","in":"path","description":"The account ID to create the contract action","required":true,"example":"5ea75fe7aa224700012eae40","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"description":"Creation of a contract action","properties":{"action_type":{"allOf":[{"enum":["NEWTDE","AMENDTDE","CANCELTDE"],"type":"string"}],"description":"Action type.\n* NEWTDE: New subscription.\n* AMENDTDE: Amendment of the current subscription.\n* CANCELTDE: Cancellation of the subscription.","example":"NEWTDE","type":"string"},"quantity":{"description":"Number of licenses.\n* For NEWTDE action_type it represents the total number of licenses. It is required and must be positive.\n* For AMENDTDE action_type it represents the number of licenses to increase or decrease (positive or negative). It is required and must not be zero.\n* For CANCELTDE action_type it is not required and it will be ignored if provided.","example":10,"format":"int32","type":"integer","maximum":2147483647,"minimum":-2147483648}},"required":["action_type"],"type":"object"},"example":{"action_type":"NEWTDE","quantity":10}}},"description":"Creation of a contract action for the account"},"responses":{"200":{"content":{"application/json":{"schema":{"description":"Contract action created","properties":{"id":{"description":"Contract action id","example":123245132132,"type":"string"},"action_type":{"allOf":[{"enum":["NEWTDE","AMENDTDE","CANCELTDE"],"type":"string"}],"description":"Action type.\n* NEWTDE: New subscription.\n* AMENDTDE: Amendment of the current subscription.\n* CANCELTDE: Cancellation of the subscription.","example":"NEWTDE","type":"string"},"quantity":{"description":"Number of licenses","example":10,"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"status":{"allOf":[{"enum":["CREATED","IN_PROGRESS","COMPLETED","FAILED"],"type":"string"}],"description":"Contract action status","example":"CREATED","type":"string"},"status_message":{"description":"Contract action status message","example":"Contract action created successfully","type":"string"},"created_at":{"description":"Creation timestamp","example":"2022-03-10T16:15:50Z","format":"date-time","type":"string"},"updated_at":{"description":"Update timestamp","example":"2022-03-10T16:15:50Z","format":"date-time","type":"string"}},"required":["id","status","action_type","updated_at","created_at"],"type":"object"},"example":{"action_type":"NEWTDE","created_at":"2022-03-10T16:15:50.000Z","id":"123245132132","quantity":10,"status":"CREATED","status_message":"Contract action created successfully","updated_at":"2022-03-10T16:15:50.000Z"}}},"description":"Ok"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3110005","message":"Constraint violation(s) occurred during input validation."}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3110001","message":"The user does not have permissions to execute this request."}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3110002","message":"Required scopes not given from JWT token."}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3110006","message":"Resource not found."}}},"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Not Express Account":{"value":{"code":"3110140","message":"The account was not provisioned on express service."}},"Amend Unavailable This Month":{"value":{"code":"3110144","message":"Unable to perform amend this month due to previous decreasing amend."}},"Ongoing Action":{"value":{"code":"3110146","message":"There is an ongoing action."}},"Operation leads to invalid licenses":{"value":{"code":"3110149","message":"Contract action leads to an invalid number of licenses."}},"Terminated account":{"value":{"code":"3110150","message":"Account status is terminated."}},"Cancelled account":{"value":{"code":"3110151","message":"Account status is canceled."}},"Account is not on trial or suspended paid":{"value":{"code":"3110152","message":"The account is not a trial account."}},"Account is not an active paid account":{"value":{"code":"3110153","message":"The account is not an active express account."}},"Contract actions blocked until the end of the month":{"value":{"code":"3110154","message":"There was a previous CANCELTDE request."}}}}},"description":"Conflict"}},"security":[{"GA":["express-accounts-contracts-actions:write"]}],"tags":["EXPRESS API"]}},"/express/products":{"get":{"summary":"Returns a collection of products.","description":"All the available products. The results are paged.","operationId":"getProducts","parameters":[{"name":"filter","in":"query","required":false,"schema":{"type":"string","maxLength":1600,"x-operators":["eq","ne","gt","ge","lt","le","and","or","not","( )","contains"],"example":"id eq 'TD-LIC-APP-RC-101910'"},"description":"Allows filtering the results by 'id' using comparison or logical operators. Examples:\n * Returns the data for a specific product id\n ```\n id eq 'TD-LIC-APP-RC-101910'\n ```\n"},{"name":"order_by","in":"query","description":"Allows ordering the results by 'id'","schema":{"default":"id:desc","type":"string","maxLength":40,"x-sorting_default_order":"desc","x-sorting_fields":["id"]},"example":"id:asc"},{"name":"page","in":"query","required":false,"schema":{"default":1,"minimum":1,"type":"integer","example":1},"description":"The number of the page to be returned. The default value is 1."},{"name":"per_page","in":"query","required":false,"schema":{"default":50,"minimum":1,"maximum":250,"type":"integer"},"example":100,"description":"The number of results to be returned per page. The default value is 50."}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"count":{"type":"integer","description":"The number of results on the current page.","example":50},"page":{"type":"integer","description":"The number of the current page.","example":2},"per_page":{"type":"integer","description":"The number of results per page.","example":50},"total":{"type":"integer","description":"The total number of results for all pages.","example":425},"total_pages":{"type":"integer","description":"The total number of pages.","example":9},"_embedded":{"type":"object","items":{},"description":"The paginated results."},"_links":{"type":"object","description":"The pagination links."}}},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"products":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The Talkdesk product code.","example":"TD-LIC-APP-RC-101910"},"name":{"type":"string","description":"The name of the product.","example":"Identity"},"family":{"type":"string","description":"The product family. Can be NULL for placeholder products like discounts.","example":"CONSUMPTION","enum":["ADD_ON","ADD_ON_PACKAGES","CONSUMPTION","CREDIT","CREDIT_USAGE","FINANCE","LEGACY_ADD_ON","LEGACY_LICENSE","LICENSE","PRODUCT_USAGE_RATE","PROFESSIONAL_SERVICES","SUNSET","THIRD_PARTY_APPCONNECT","OTHER"]},"unit_of_measure":{"type":"string","description":"The unit used to measure product usage. Can be NULL when not applicable.","example":"MINUTES","enum":["CHARACTERS","CREDITS","EACH","MINUTES","PER_API_CALL","PER_ACCOUNT","PER_CONNECTION","PER_CONVERSATION","PER_GB","PER_INTERACTION","PER_MINUTE","PER_PAGE","PER_SEAT","PER_SESSION","PER_USE","PER_UTTERANCE","PER_VALIDATION","OTHER"]},"charge_type":{"type":"string","description":"How the product is charged. Can be NULL if not applicable.","example":"USAGE","enum":["FIXED_RECURRING","ONE_TIME","ONE_TIME_CHARGE","RECURRING","USAGE","OTHER"]}}}}}},"_links":{"type":"object","properties":{"first":{"type":"object","properties":{"href":{"type":"string","description":"The link to the first page."}}},"last":{"type":"object","properties":{"href":{"type":"string","description":"The link to the last page."}}},"next":{"type":"object","properties":{"href":{"type":"string","description":"The link to the next page."}}},"prev":{"type":"object","properties":{"href":{"type":"string","description":"The link to the previous page."}}},"self":{"type":"object","properties":{"href":{"type":"string","description":"The link to the current page."}}}}}}}]},"example":{"count":50,"page":2,"per_page":50,"total":425,"total_pages":9,"_embedded":{"products":[{"id":"TD-LIC-APP-RC-101910","name":"Identity","family":"CONSUMPTION","unit_of_measure":"MINUTES","charge_type":"USAGE"}]},"_links":{"first":{"href":"https://api-docs.talkdesk.org/express/products?page=2"},"last":{"href":"https://api-docs.talkdesk.org/express/products?page=10"},"next":{"href":"https://api-docs.talkdesk.org/express/products?page=3"},"prev":{"href":"https://api-docs.talkdesk.org/express/products?page=1"},"self":{"href":"https://api-docs.talkdesk.org/express/products"}}}}}},"400":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3110000","message":"Invalid parameters."}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3110001","message":"The user does not have permissions to execute this request."}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3110002","message":"Required scopes not given from JWT token."}}},"description":"This caller is not authorized to query the given accounts. The accounts specified are not under the organization owning the current authentication token."}},"security":[{"GA":["express-products:read"]}],"tags":["EXPRESS API"]}},"/express/subscriptions":{"get":{"summary":"Returns info on the account subscription.","description":"Returns info on the accounts subscriptions. A 403 error is returned if the specified accounts are not under the organization performing the call. The results are paged.","operationId":"getAccountSubscriptions","parameters":[{"name":"filter","in":"query","required":false,"schema":{"type":"string","maxLength":1600,"x-operators":["eq","ne","gt","ge","lt","le","and","or","not","( )","contains"],"example":"accound_id eq '5ea75fe7aa224700012eae40'"},"description":"Allows filtering the results by 'account_id' or 'start_data' and 'end_date' using comparison or logical operators. Examples:\n * Returns the data for a specific account\n ```\n account_id eq '5ea75fe7aa224700012eae40'\n ```\n * Returns the data for a set of given accounts\n ```\n account_id eq '5ea75fe7aa224700012eae40' or account_id eq '4ae75fe7aa224700012eae29'\n ```\n * Returns the data for a spcific account in a given range of dates\n ```\n (start_date ge '2023-12-01' and end_date le '2023-01-01' and account_id eq '5ea75fe7aa224700012eae40')\n ```\n"},{"name":"order_by","in":"query","description":"Allows ordering the results by 'start_date', 'end_date'","schema":{"default":"start_date:desc","type":"string","maxLength":40,"x-sorting_default_order":"desc","x-sorting_fields":["start_date","end_date"]},"example":"end_date:asc"},{"name":"page","in":"query","required":false,"schema":{"default":1,"minimum":1,"type":"integer","example":1},"description":"The number of the page to be returned. The default value is 1."},{"name":"per_page","in":"query","required":false,"schema":{"default":50,"minimum":1,"maximum":250,"type":"integer"},"example":100,"description":"The number of results to be returned per page. The default value is 50."}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"count":{"type":"integer","description":"The number of results on the current page.","example":50},"page":{"type":"integer","description":"The number of the current page.","example":2},"per_page":{"type":"integer","description":"The number of results per page.","example":50},"total":{"type":"integer","description":"The total number of results for all pages.","example":425},"total_pages":{"type":"integer","description":"The total number of pages.","example":9},"_embedded":{"type":"object","items":{},"description":"The paginated results."},"_links":{"type":"object","description":"The pagination links."}}},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"subscriptions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The id of the record.","example":"8f3e643c16671acaf60e8bceddbc1877"},"account_id":{"type":"string","description":"The ID of the Talkdesk account.","example":"5ea75fe7aa224700012eae40"},"contract_number":{"type":"string","description":"The number of the contract.","example":"00021679"},"currency":{"type":"string","description":"The 3 chars ISO code of the currency for the subscription according to ISO-4217 (https://www.iso.org/iso-4217-currency-codes.html ).","example":"USD"},"billing_period":{"type":"string","description":"The billing period for the subscription on the contract level.","example":"MONTH","enum":["ANNUAL","QUARTER","MONTH","SEMI_ANNUAL","OTHER"]},"status":{"type":"string","description":"The status of the contract.","example":"ACTIVATED","enum":["ACTIVATED","OTHER"]},"term":{"type":"integer","description":"The duration of the contract in months.","example":12},"start_date":{"type":"string","description":"The start date of the contract.","example":"2023-08-31T00:00:00.000Z"},"end_date":{"type":"string","description":"The end date of the contract.","example":"2024-08-31T00:00:00.000Z"},"edition":{"type":"string","description":"The Talkdesk CX Cloud Edition on the contract.","example":"Express"},"auto_renewal":{"type":"boolean","description":"True if the contract is auto renewed. False otherwise. Might be NULL if not applicable.","example":true},"renewal_uplift":{"type":"number","format":"float","description":"The percentage of uplift in the contract value uppon renewal. Might be NULL if not applicable.","example":9},"product_id":{"type":"string","description":"The Talkdesk product code.","example":"TD-LIC-APP-RC-101910"},"quantity":{"type":"number","format":"double","description":"The quantity of product in the subscription.","example":10},"unit_price":{"type":"number","format":"double","description":"The price for product unit.","example":5},"billing_frequency":{"type":"string","description":"The billing frequency for the subscription on a contract line level.","example":"MONTH","enum":["ANNUAL","QUARTER","MONTH","SEMI_ANNUAL","OTHER"]},"pricing_model":{"type":"string","description":"The pricing model for the subscription","example":"FIXED_FEE","enum":["FIXED_FEE","TIME_AND_MATERIALS","OTHER"]},"concurrent":{"type":"boolean","description":"False if the license is billid per number of licensed users, True if it is billid by the number of simoultanios users using the product.","example":false},"seasonal":{"type":"boolean","description":"True if the subscription is seasonal. These are monthly licenses, that are not supposed to be renewed, but only effective during a period explicit in a contract to attend to our customers' business cycle and seasonality needs.","example":false}}}}}},"_links":{"type":"object","properties":{"first":{"type":"object","properties":{"href":{"type":"string","description":"The link to the first page."}}},"last":{"type":"object","properties":{"href":{"type":"string","description":"The link to the last page."}}},"next":{"type":"object","properties":{"href":{"type":"string","description":"The link to the next page."}}},"prev":{"type":"object","properties":{"href":{"type":"string","description":"The link to the previous page."}}},"self":{"type":"object","properties":{"href":{"type":"string","description":"The link to the current page."}}}}}}}]},"example":{"count":50,"page":2,"per_page":50,"total":425,"total_pages":9,"_embedded":{"subscriptions":[{"id":"8f3e643c16671acaf60e8bceddbc1877","account_id":"5ea75fe7aa224700012eae40","contract_number":"21679","currency":"USD","billing_period":"MONTH","status":"ACTIVATED","term":12,"start_date":"2023-08-31","end_date":"2024-08-31","edition":"Express","auto_renewal":true,"renewal_uplift":9,"product_id":"TD-LIC-APP-RC-101910","quantity":10,"unit_price":5,"billing_frequency":"MONTH","pricing_model":"FIXED_FEE","concurrent":false,"seasonal":false}]},"_links":{"first":{"href":"https://api-docs.talkdesk.org/express/subscriptions?page=2"},"last":{"href":"https://api-docs.talkdesk.org/express/subscriptions?page=10"},"next":{"href":"https://api-docs.talkdesk.org/express/subscriptions?page=3"},"prev":{"href":"https://api-docs.talkdesk.org/express/subscriptions?page=1"},"self":{"href":"https://api-docs.talkdesk.org/express/subscriptions"}}}}}},"400":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3110000","message":"Invalid parameters."}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3110001","message":"The user does not have permissions to execute this request."}}},"description":"Unauthorized"},"403":{"description":"This caller is not authorized to query the given accounts. The accounts specified are not under the organization owning the current authentication token.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3110002","message":"Required scopes not given from JWT token."}}}}},"security":[{"GA":["express-accounts-subscriptions:read"]}],"tags":["EXPRESS API"]}},"/express/invoices":{"get":{"summary":"Returns a collection of invoice lines for the given accounts.","description":"All the invoice lines will be returned for the accounts under the organization. A 403 error is returned if the specified accounts are not under the organization performing the call. The results are paged.","operationId":"getAccountInvoices","parameters":[{"name":"filter","in":"query","required":false,"schema":{"type":"string","maxLength":1600,"x-operators":["eq","ne","gt","ge","lt","le","and","or","not","( )","contains"]},"example":"accound_id eq '5ea75fe7aa224700012eae40'","description":"Allows filtering the results by 'account_id', invoice 'number' and invoice 'date' using comparison or logical operators. Examples:\n * Returns the data for a specific account\n ```\n accound_id eq '5ea75fe7aa224700012eae40'\n ```\n * Returns the data for a specific invoice number\n ```\n number eq 'INV1120933'\n ```\n * Returns the data for a spcific account in a given range of dates\n ```\n (date ge '2023-12-01' and date le '2023-01-01' and account_id eq '5ea75fe7aa224700012eae40')\n ```\n"},{"name":"order_by","in":"query","description":"Allows ordering the results by 'date'","schema":{"default":"date:desc","type":"string","maxLength":40,"x-sorting_default_order":"desc","x-sorting_fields":["date"]},"example":"date:asc"},{"name":"page","in":"query","required":false,"schema":{"default":1,"minimum":1,"type":"integer","example":1},"description":"The number of the page to be returned. The default value is 1."},{"name":"per_page","in":"query","required":false,"schema":{"default":50,"minimum":1,"maximum":250,"type":"integer"},"example":100,"description":"The number of results to be returned per page. The default value is 50."}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"count":{"type":"integer","description":"The number of results on the current page.","example":50},"page":{"type":"integer","description":"The number of the current page.","example":2},"per_page":{"type":"integer","description":"The number of results per page.","example":50},"total":{"type":"integer","description":"The total number of results for all pages.","example":425},"total_pages":{"type":"integer","description":"The total number of pages.","example":9},"_embedded":{"type":"object","items":{},"description":"The paginated results."},"_links":{"type":"object","description":"The pagination links."}}},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"invoices":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The id of the record.","example":"8f3e643c16671acaf60e8bceddbc1877"},"account_id":{"type":"string","description":"The ID of the account.","example":"5ea75fe7aa224700012eae40"},"number":{"type":"string","description":"The invoice number.","example":"INV13098292"},"invoice_line_number":{"type":"string","description":"The invoice line number.","example":3},"date":{"type":"string","description":"The invoice date.","example":"2024-08-31T00:00:00.000Z"},"due_date":{"type":"string","description":"The due date of the invoice.","example":"2024-10-10T00:00:00.000Z"},"currency":{"type":"string","description":"The 3 chars ISO code of the currency for the invoice according to ISO-4217 (https://www.iso.org/iso-4217-currency-codes.html ).","example":"USD"},"total_invoice_amount":{"type":"number","format":"double","description":"The total invoice amount.","example":161.5},"product_id":{"type":"string","description":"The Talkdesk product code.","example":"TD-LIC-APP-RC-101910"},"description":{"type":"string","description":"A description for the invoice line.","example":"08/16/2023 - 09/15/2023"},"product_name":{"type":"string","description":"The name of the product.","example":"Talkdesk CX Cloud Elevate Edition"},"quantity":{"type":"number","format":"double","description":"The quantity of product in the invoice line","example":10},"rate":{"type":"number","format":"double","description":"The rate applied to the invoice line product","example":5},"amount":{"type":"number","format":"double","description":"The total amount on the invoice line","example":50},"total_tax_amount":{"type":"number","format":"double","description":"The total amount of taxes in the invoice.","example":11.5}}}}}},"_links":{"type":"object","properties":{"first":{"type":"object","properties":{"href":{"type":"string","description":"The link to the first page."}}},"last":{"type":"object","properties":{"href":{"type":"string","description":"The link to the last page."}}},"next":{"type":"object","properties":{"href":{"type":"string","description":"The link to the next page."}}},"prev":{"type":"object","properties":{"href":{"type":"string","description":"The link to the previous page."}}},"self":{"type":"object","properties":{"href":{"type":"string","description":"The link to the current page."}}}}}}}]},"example":{"count":50,"page":2,"per_page":50,"total":425,"total_pages":9,"_embedded":{"invoices":[{"id":"8f3e643c16671acaf60e8bceddbc1877","account_id":"5ea75fe7aa224700012eae40","number":"INV13098292","invoice_line_number":5,"date":"2024-08-31","due_date":"2024-10-10","currency":"USD","total_invoice_amount":161.5,"product_id":"TD-LIC-APP-RC-101910","description":"08/16/2023 - 09/15/2023","product_name":"Talkdesk CX Cloud Elevate Edition","quantity":10,"rate":5,"amount":50,"total_tax_amount":10}]},"_links":{"first":{"href":"https://api-docs.talkdesk.org/express/invoices&page=2"},"last":{"href":"https://api-docs.talkdesk.org/express/invoices&page=10"},"next":{"href":"https://api-docs.talkdesk.org/express/invoices&page=3"},"prev":{"href":"https://api-docs.talkdesk.org/express/invoices&page=1"},"self":{"href":"https://api-docs.talkdesk.org/express/invoices"}}}}}},"400":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3110000","message":"Invalid parameters."}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3110001","message":"The user does not have permissions to execute this request."}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3110002","message":"Required scopes not given from JWT token."}}},"description":"This caller is not authorized to query the given accounts. The accounts specified are not under the organization owning the current authentication token."}},"security":[{"GA":["express-accounts-invoices:read"]}],"tags":["EXPRESS API"]}},"/express/usage/month":{"get":{"summary":"Returns a collection of usage data aggregated by month.","description":"All the usage data will be returned for the accounts under the organization. The data is aggegated by month for each product. A 403 error is returned if the specified accounts are not under the organization performing the call. The results are paged.","operationId":"getAccountUsageMonth","parameters":[{"name":"page","in":"query","required":false,"schema":{"default":1,"minimum":1,"type":"integer","example":1},"description":"The number of the page to be returned. The default value is 1."},{"name":"per_page","in":"query","required":false,"schema":{"default":50,"minimum":1,"maximum":250,"type":"integer"},"example":100,"description":"The number of results to be returned per page. The default value is 50."},{"name":"filter","in":"query","required":false,"schema":{"type":"string","maxLength":1600,"x-operators":["eq","ne","gt","ge","lt","le","and","or","not","( )","contains"]},"example":"accound_id eq '5ea75fe7aa224700012eae40'","description":"Allows filtering the results by 'account_id' or 'month' using comparison or logical operators. Examples:\n * Returns the data for a specific account\n ```\n accound_id eq '5ea75fe7aa224700012eae40'\n ```\n * Returns the data for a set of given accounts\n ```\n account_id eq '5ea75fe7aa224700012eae40' or account_id eq '4ae75fe7aa224700012eae29'\n ```\n * Returns the data for a given account and specific month\n ```\n (month eq '2003-12' and account_id eq '5ea75fe7aa224700012eae40')\n ```\n"},{"name":"order_by","in":"query","description":"Allows ordering the results by 'id'","schema":{"default":"id:desc","type":"string","maxLength":40,"x-sorting_default_order":"desc","x-sorting_fields":["id"]},"example":"id:asc"}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"first":{"type":"object","properties":{"href":{"type":"string","description":"The link to the first page."}}},"last":{"type":"object","properties":{"href":{"type":"string","description":"The link to the last page."}}},"next":{"type":"object","properties":{"href":{"type":"string","description":"The link to the next page."}}},"prev":{"type":"object","properties":{"href":{"type":"string","description":"The link to the previous page."}}},"self":{"type":"object","properties":{"href":{"type":"string","description":"The link to the current page."}}}}},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"usage":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The id of the record.","example":"8f3e643c16671acaf60e8bceddbc1877"},"account_id":{"type":"string","description":"The ID of the account.","example":"5ea75fe7aa224700012eae40"},"product_id":{"type":"string","description":"The ID of the product.","example":"TD-LIC-APP-RC-101910"},"aggr_product_id":{"type":"string","description":"The ID of the aggregator product.","example":"TD-USG-TEL-UG-102213"},"month":{"type":"string","description":"The year and month of the usage aggregate","example":"2023-08"},"type":{"type":"string","description":"The type of usage","example":"NUMBER","enum":["AMD","API_REQUEST","CALL","CALL_SERVICE","CREDIT_COMMIT","DIALER","MESSAGE","NUMBER","PRODUCT_SERVICE","RECHARGE","SPEECH_TRANSCRIPTION","VOICEMAIL_TRANSCRIPTION","OTHER"]},"description":{"type":"string","description":"A description of the usage type","example":"SIP Number"},"currency":{"type":"string","description":"The 3 chars ISO code of the currency for the invoice according to ISO-4217 (https://www.iso.org/iso-4217-currency-codes.html ).","example":"USD"},"direction":{"type":"string","description":"The direction of the interaction, when applicable, NULL otherwise.","example":"INBOUND","enum":["INBOUND","OUTBOUND","OTHER"]},"resolution":{"type":"string","description":"The type of interaction resolution or NULL if not applicable.","example":null,"enum":["ABANDONED","ANSWERED","MACHINE","MISSED","VOICEMAIL","OTHER"]},"unit":{"type":"string","description":"The unit of measure","example":"MINUTES","enum":["CHARS","CONVERSATIONS","GB","MINUTES","NUMBERS","PAGES","REQUESTS","SECONDS","SEGMENTS","SESSIONS","OTHER"]},"price":{"type":"number","format":"double","description":"The price of each unit.","example":1},"wallet_name":{"type":"string","description":"The name of the wallet.","example":"contact center"},"number_of_units":{"type":"number","format":"double","description":"The number of units in the aggregate","example":5},"total_amount":{"type":"number","format":"double","description":"The total amount in the usage aggregate in the currency specified in the currency field.","example":5}}}}}},"_links":{"type":"object","properties":{"first":{"type":"object","properties":{"href":{"type":"string","description":"The link to the first page."}}},"last":{"type":"object","properties":{"href":{"type":"string","description":"The link to the last page."}}},"next":{"type":"object","properties":{"href":{"type":"string","description":"The link to the next page."}}},"prev":{"type":"object","properties":{"href":{"type":"string","description":"The link to the previous page."}}},"self":{"type":"object","properties":{"href":{"type":"string","description":"The link to the current page."}}}}}}}]},"example":{"count":50,"page":2,"per_page":50,"total":425,"total_pages":9,"_embedded":{"usage":[{"id":"8f3e643c16671acaf60e8bceddbc1877","account_id":"5ea75fe7aa224700012eae40","product_id":"TD-LIC-APP-RC-101910","aggr_product_id":"TD-USG-TEL-UG-102213","month":"2023-08","type":"NUMBER","description":"SIP Number","currency":"USD","direction":"INBOUND","resolution":"ANSWERED","unit":"MINUTES","price":1,"wallet_name":"contact center","number_of_units":5,"total_amount":5}]},"_links":{"first":{"href":"https://api-docs.talkdesk.org/express/usage/month?page=2"},"last":{"href":"https://api-docs.talkdesk.org/express/usage/month?page=10"},"next":{"href":"https://api-docs.talkdesk.org/express/usage/month?page=3"},"prev":{"href":"https://api-docs.talkdesk.org/express/usage/month?page=1"},"self":{"href":"https://api-docs.talkdesk.org/express/usage/month"}}}}}},"400":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3110000","message":"Invalid parameters."}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3110001","message":"The user does not have permissions to execute this request."}}},"description":"Unauthorized"},"403":{"description":"This caller is not authorized to query the given accounts. The accounts specified are not under the organization owning the current authentication token.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3110002","message":"Required scopes not given from JWT token."}}}}},"security":[{"GA":["express-accounts-usage:read"]}],"tags":["EXPRESS API"]}},"/express/provisioning/account":{"post":{"description":"Provision a new Talkdesk account","operationId":"createExpressAccount","requestBody":{"description":"Creation of an account associated to an organization","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"account_name":{"description":"Account Name","example":"JosephPinetrees","maxLength":20,"minLength":3,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9]$","type":"string"},"admin_email":{"description":"The email address of the admin for the account.","example":"joseph@josephpinetrees.com","minLength":8,"pattern":"\\S","type":"string"},"admin_name":{"description":"The first and last name of the admin for the account.","example":"John Doe","maxLength":250,"minLength":3,"pattern":"^[a-zA-Z0-9\\s]*$","type":"string"},"authentication":{"description":"Authentication settings for an account","type":"object","properties":{"identity_providers":{"description":"The identity providers associated with the account","type":"object","properties":{"oauth":{"description":"OAuth settings for the account","type":"object","properties":{"google":{"description":"OAuth settings for Google","type":"object","properties":{"enabled":{"description":"Indicates if the identity provider is enabled","example":true,"type":"boolean"}},"required":["enabled"]},"microsoft":{"description":"OAuth settings for Microsoft","type":"object","properties":{"enabled":{"description":"Indicates if the identity provider is enabled","example":true,"type":"boolean"}},"required":["enabled"]},"salesforce":{"description":"OAuth settings for Salesforce","type":"object","properties":{"enabled":{"description":"Indicates if the identity provider is enabled","example":true,"type":"boolean"}},"required":["enabled"]}},"required":["google","microsoft","salesforce"]}},"required":["oauth"]},"local_login_enabled":{"description":"Indicates if local login is enabled for the account","example":true,"type":"boolean"}},"required":["local_login_enabled","identity_providers"]},"company_name":{"description":"The name of the company.","example":"Joseph Pinetree","maxLength":250,"minLength":3,"pattern":"\\S","type":"string"},"currency_iso_code":{"allOf":[{"enum":["AUD","BRL","CAD","EUR","GBP","SGD","USD"],"type":"string"}],"description":"The 3 chars ISO code of the currency for the account according to ISO-4217 (https://www.iso.org/iso-4217-currency-codes.html ).","maxLength":3,"minLength":3,"example":"USD","type":"string"},"edition":{"allOf":[{"enum":["EXPRESS"],"type":"string"}],"description":"The Talkdesk edition.","minLength":7,"example":"EXPRESS","type":"string"},"external_data":{"description":"Custom data in string format to be stored along with the new account information.","example":"salesforce_id:2142141","maxLength":1024,"type":"string"},"num_licenses":{"description":"The number of TD licenses that will be available for the account.","example":10,"format":"int32","minimum":1,"maximum":50},"phone_number":{"description":"The company’s phone number, starting with the country code.","example":"+351489489948","maxLength":15,"minLength":7,"pattern":"^[\\+]?[(]?[0-9]{3}[)]?[-\\s\\.]?[0-9]{3}[-\\s\\.]?[0-9]{4,6}$","type":"string"},"website_url":{"description":"The URL of the company’s website or social presence.","minLength":6,"example":"https://www.josephpinetrees.com","pattern":"\\S","type":"string"}},"required":["account_name","admin_email","admin_name","company_name","currency_iso_code","num_licenses","phone_number","website_url","edition"]},"example":{"account_name":"JosephPinetrees","admin_email":"joseph@josephpinetrees.com","admin_name":"John Doe","company_name":"Joseph Pinetree","currency_iso_code":"USD","num_licenses":10,"phone_number":"+351489489948","website_url":"https://www.josephpinetrees.com","edition":"EXPRESS","external_data":"Salesforce_id:2142141","authentication":{"local_login_enabled":true,"identity_providers":{"oauth":{"google":{"enabled":true},"microsoft":{"enabled":true},"salesforce":{"enabled":true}}}}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"description":"Account created","properties":{"admin_email":{"example":"joseph@josephpinetrees.com","type":"string"},"created_at":{"example":"2022-03-10T16:15:50Z","format":"date-time","type":"string"},"id":{"example":"123245132132","type":"string"},"name":{"example":"JosephPinetrees","type":"string"},"organization_id":{"example":"12325234324","type":"string"},"updated_at":{"example":"2022-03-10T16:15:50Z","format":"date-time","type":"string"}},"type":"object"},"example":{"admin_email":"joseph@josephpinetrees.com","id":"123245132132","name":"JosephPinetrees","organization_id":"12325234324","created_at":"2022-03-10T16:15:50Z","updated_at":"2022-03-10T16:15:50Z"}}},"description":"Ok"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3110071","message":"Problem with the account creation process."}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3110001","message":"The user does not have permissions to execute this request."}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3110002","message":"Required scopes not given from JWT token."}}},"description":"Forbidden"},"406":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3110070","message":"Failed to create account."}}},"description":"Not Acceptable"},"409":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3110072","message":"Account already exists."}}},"description":"Conflict"}},"security":[{"GA":["express-provisioning:write"]}],"summary":"Account created","tags":["express-provisioning"]}},"/express/provisioning/validate/account/{account_name}":{"get":{"description":"Return boolean","operationId":"validateAccount","parameters":[{"name":"account_name","in":"path","description":"account name","required":true,"schema":{"type":"string"},"example":"Jacob TalkDesk"}],"responses":{"200":{"content":{"application/json":{"schema":{"description":"Account Validator","type":"object"},"example":{"type":"xpto"}}},"description":"Ok"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3110000","message":"Invalid parameters."}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3110001","message":"The user does not have permissions to execute this request."}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3110002","message":"Required scopes not given from JWT token."}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3110006","message":"Resource not found."}}},"description":"Not Found"},"424":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3110011","message":"Organizations resource error."}}},"description":"Organization accounts error"}},"security":[{"GA":["express-provisioning:read"]}],"summary":"Valid if account exists","tags":["express-provisioning"]}},"/automated-notifications/bridge/digital-connect":{"post":{"tags":["Automated Notifications"],"summary":"Automated Notifications Bridge for webhooks","description":"Automated Notifications webhook for Digital Connect (DCE)","operationId":"automated_notifications_webhook_for_dce","security":[{"GA":["automated-notifications-bridge:write"]}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["event_type","conversation_id","timestamp"],"properties":{"event_type":{"type":"string","description":"The source where this ID refers to","minLength":1,"enum":["CONVERSATION_ENDED","MESSAGE_CREATED"]},"conversation_id":{"type":"string","description":"Digital Connect conversation ID"},"timestamp":{"type":"string","description":"Digital Connect timestamp"},"payload":{"description":"The payload of the Digital Connect accordingly to the event type.","type":"object"}}},"example":{"event_type":"MESSAGE_CREATED","conversation_id":"digital-connect-dc3805dc-9821-4749-8b42-0ff447a0db46","timestamp":"2022-01-28T11:11:31.000Z","payload":{"id":123456,"content":"agent response","created_at":"2022-01-28T11:11:31.000Z","author":{"name":"Katniss","type":"user"}}}}},"required":true},"responses":{"204":{"description":"Automated Notifications webhook for Digital Connect (DCE)"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"4310000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"4310010","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"4310020","message":"Required scopes are missing."}}}}}}},"/eas/simulated-emails":{"post":{"tags":["Emails"],"operationId":"emails-simulation-message","summary":"Send a simulated message to agent","description":"Contact send a simulated message to agent by email channel","security":[{"EarlyAccess":["simulated-emails:write"]}],"requestBody":{"description":"The Request Body","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"subject":{"type":"string","description":"email subject","minLength":1,"maxLength":1000},"content":{"type":"string","description":"content of email","minLength":1,"maxLength":100000},"from":{"required":["email"],"type":"object","properties":{"name":{"type":"string","description":"email freindly name","minLength":1,"maxLength":200},"email":{"type":"string","description":"email address","minLength":1,"maxLength":200}},"description":"email and name"},"to":{"type":"array","description":"where email send to, each item must be an active email touchpoint","minItems":1,"maxItems":1000,"items":{"required":["email"],"type":"object","properties":{"name":{"type":"string","description":"email freindly name","minLength":1,"maxLength":200},"email":{"type":"string","description":"email address","minLength":1,"maxLength":200}},"description":"email and name"}}},"required":["content","from","to"]},"example":{"subject":"Hello","content":"how are you today","from":{"name":"from","email":"from@email.com"},"to":[{"name":"to","email":"to@email.com"}]}}}},"responses":{"200":{"description":"Success,sends an email message to agent","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":255,"description":"email message id"},"message_id":{"type":"string","minLength":1,"maxLength":255,"description":"email message id"},"thread_id":{"type":"string","minLength":1,"maxLength":255,"description":"thread id"},"interaction_id":{"type":"string","minLength":1,"maxLength":255,"description":"interaction id"}},"required":["id","message_id","thread_id","interaction_id"]},"example":{"id":"0e46b1ae-7420-43d6-a316-9cd48c4a3b7b","message_id":"67bbe4ed-01ef-4b99-9926-2ba7a3740044","thread_id":"f624adac-d664-4dc8-933b-eb8c69208e3c","interaction_id":"9c91b3f1-a5f5-471d-a5dc-4a78d894bdab"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"description":"Bad Request","type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Example 0":{"value":{"code":"1510000","message":"Email address can not be null"}},"Example 1":{"value":{"code":"1510000","message":"Email address invalid"}},"Example 2":{"value":{"code":"1510014","message":"Email touchpoint does not exist"}},"Example 3":{"value":{"code":"1510014","message":"Email touchpoint is not available"}}}}}},"401":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1510001","message":"Unauthorized"}}},"description":"Unauthorized access - invalid or unverifiable JWT."},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1510002","message":"Forbidden"}}}},"500":{"description":"Internal Error","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1510008","message":"Internal server error"}}}}}}},"/prompts":{"post":{"summary":"Create Prompt","operationId":"createPrompt","description":"Create a new prompt","x-namespace":"/prompts","security":[{"GA":["prompts:write"]}],"tags":["Prompts"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization header containing the JWT generated by API Gateway","required":true,"schema":{"type":"string","minLength":1}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["request_id","name","file_name","description"],"properties":{"request_id":{"type":"string","minLength":1,"description":"Request id of a prompt"},"name":{"type":"string","minLength":1,"maxLength":512,"description":"Prompt name"},"file_name":{"type":"string","minLength":1,"maxLength":512,"description":"File name"},"description":{"type":"string","minLength":1,"maxLength":64,"description":"Prompt description"}}},"example":{"request_id":"54awe23gby74rfsdcvbq21asd","name":"Welcome","file_name":"test.mp3","description":"this is test"}}},"description":"Create a new prompt for an authorized account.","required":true},"responses":{"201":{"description":"The newly created prompt","content":{"application/json":{"schema":{"type":"object","required":["id","name","description","type","asset_id","updated_at","updated_by","_links"],"properties":{"id":{"type":"string","description":"The ID of the prompt"},"name":{"type":"string","description":"the prompt name"},"description":{"type":"string","description":"the prompt description"},"type":{"type":"string","description":"the prompt type","enum":["asset","tts","url"]},"asset_id":{"type":"string","description":"asset id"},"created_at":{"type":"string","format":"date-time","description":"The date when the prompt was created"},"created_by":{"type":"string","description":"The user who created the prompt"},"created_user_name":{"type":"string","description":"The user name of whom created the prompt"},"updated_at":{"type":"string","format":"date-time","description":"The date when the prompt was updated"},"updated_by":{"type":"string","description":"The user who updated the prompt"},"updated_user_name":{"type":"string","description":"The user name of whom updated the prompt"},"_links":{"type":"object","description":"HAL API related links.","properties":{"self":{"type":"object","description":"Link to fetch the detail of the prompt","properties":{"href":{"type":"string","description":"Address of the resource"}}},"download_link":{"type":"object","description":"Link used to generate a download link (available only when published or archived states)","properties":{"href":{"type":"string","description":"Download link generation address"}}}}}}},"example":{"id":"95b0f1b471bc44e595e978ed40844b5e","name":"test2.mp3","description":"this is test","asset_id":"95b0f1b471bc44e595e978ed40844b5e","type":"asset","updated_by":"uid","updated_at":"2022-07-20T06:15:41.611Z","_links":{"self":{"href":"https://prompt.talkdesk.com/prompts/95b0f1b471bc44e595e978ed40844b5e"},"download_link":{"href":"https://prompt.talkdesk.com/assets/95b0f1b471bc44e595e978ed40844b5e/download-link"}}}}}},"400":{"description":"Validation constraint violation","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2310001","message":"Missing params"}}}},"401":{"description":"Unauthorized access - invalid or unverifiable JWT.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2310002","message":"Unauthorized - Missing required headers"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2310003","message":"Invalid scopes or lack of permissions"}}}},"409":{"description":"Prompt naming conflict. Already has an prompt with this name.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2310006","message":"Already exists an prompt with the given name"}}}}}},"get":{"summary":"List prompts (audio files) from Studio flows","description":"List prompts (audio files) from Studio flows","operationId":"ListPrompts","x-namespace":"/prompts","security":[{"GA":["prompts:read"]}],"tags":["Prompts"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization header containing the JWT generated by API Gateway","required":true,"schema":{"type":"string","minLength":1}},{"in":"query","name":"created_by","description":"Filter by prompt created_by, support one or more values query(separate with commas).","example":"uid1,uid2","required":false,"schema":{"type":"string","minLength":0,"maxLength":9999}},{"in":"query","name":"updated_by","description":"Filter by prompt created_by, support one or more values query(separate with commas).","example":"uid1","required":false,"schema":{"type":"string","minLength":0,"maxLength":9999}},{"in":"query","name":"created_at_from","description":"Filter by prompt created_at, the oldest date.","required":false,"schema":{"type":"string","format":"date-time","minLength":0,"maxLength":20}},{"in":"query","name":"created_at_to","description":"Filter by prompt created_at, the lastest date.","required":false,"schema":{"type":"string","format":"date-time","minLength":0,"maxLength":20}},{"in":"query","name":"updated_at_from","description":"Filter by prompt updated_at, the oldest date.","required":false,"schema":{"type":"string","format":"date-time","minLength":0,"maxLength":20}},{"in":"query","name":"updated_at_to","description":"Filter by prompt updated_at, the lastest date.","required":false,"schema":{"type":"string","format":"date-time","minLength":0,"maxLength":20}},{"name":"search","in":"query","description":"Search prompts by prompt name or description","required":false,"example":"*music*","schema":{"type":"string","minLength":0,"maxLength":20,"x-search_operators":["*"],"x-search_fields":["name","description"]}},{"name":"search_fields","in":"query","required":false,"schema":{"type":"string","minLength":0,"maxLength":20,"default":"name,description"}},{"in":"query","name":"order_by","description":"order by fields. Use - for descending order.","required":false,"schema":{"type":"string","default":"updated_at:desc","x-sorting_fields":["name","description","type","updated_at","updated_by"],"x-sorting_default_order":"asc","minLength":0,"maxLength":20}},{"name":"page","in":"query","description":"Desired page","schema":{"format":"int32","type":"integer","default":1,"minimum":1,"maximum":2147483647}},{"name":"per_page","in":"query","description":"Limit the number of prompts per page","schema":{"format":"int32","default":50,"minimum":1,"maximum":250,"type":"integer"}}],"responses":{"200":{"description":"Prompts list","content":{"application/json":{"schema":{"type":"object","required":["total","page","per_page","_embedded","_links"],"properties":{"total":{"type":"integer"},"page":{"type":"integer","default":1},"per_page":{"type":"integer","default":20},"_embedded":{"type":"object","description":"The list of prompts","required":["prompts"],"properties":{"prompts":{"type":"array","items":{"type":"object","required":["id","name","description","type","asset_id","updated_at","updated_by","_links"],"properties":{"id":{"type":"string","description":"The ID of the prompt"},"name":{"type":"string","description":"the prompt name"},"description":{"type":"string","description":"the prompt description"},"type":{"type":"string","description":"the prompt type","enum":["asset","tts","url"]},"asset_id":{"type":"string","description":"asset id"},"created_at":{"type":"string","format":"date-time","description":"The date when the prompt was created"},"created_by":{"type":"string","description":"The user who created the prompt"},"created_user_name":{"type":"string","description":"The user name of whom created the prompt"},"updated_at":{"type":"string","format":"date-time","description":"The date when the prompt was updated"},"updated_by":{"type":"string","description":"The user who updated the prompt"},"updated_user_name":{"type":"string","description":"The user name of whom updated the prompt"},"_links":{"type":"object","description":"HAL API related links.","properties":{"self":{"type":"object","description":"Link to fetch the detail of the prompt","properties":{"href":{"type":"string","description":"Address of the resource"}}},"download_link":{"type":"object","description":"Link used to generate a download link (available only when published or archived states)","properties":{"href":{"type":"string","description":"Download link generation address"}}}}}}}}}},"_links":{"type":"object","description":"HAL API related links.","properties":{"self":{"type":"object","description":"Current page of this prompts list","properties":{"href":{"type":"string","description":"Address of the resource","default":"https://prompts.talkdesk.com/prompts?page=2"}}},"prev":{"type":"object","description":"Previous page of this prompts list","properties":{"href":{"type":"string","description":"Address of the resource","default":"https://prompts.talkdesk.com/prompts?page=1"}}},"next":{"type":"object","description":"Next page of the prompts list","properties":{"href":{"type":"string","description":"Address of the resource","default":"https://prompts.talkdesk.com/prompts?page=3"}}}}}}},"example":{"total":6,"page":2,"per_page":1,"_embedded":{"prompts":[{"id":"95b0f1b471bc44e595e978ed40844b5e","name":"test2.mp3","description":"this is test","asset_id":"95b0f1b471bc44e595e978ed40844b5e","type":"asset","updated_by":"uid","updated_at":"2022-07-20T06:15:41.611Z","_links":{"self":{"href":"https://prompt.talkdesk.com/prompts/95b0f1b471bc44e595e978ed40844b5e"},"download_link":{"href":"https://prompt.talkdesk.com/assets/95b0f1b471bc44e595e978ed40844b5e/download-link"}}}]},"_links":{"self":{"href":"https://prompts.talkdesk.com/prompts?page=2"},"prev":{"href":"https://prompts.talkdesk.com/prompts?page=1"},"next":{"href":"https://prompts.talkdesk.com/prompts?page=3"}}}}}},"400":{"description":"Invalid parameter value","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2310001","message":"Missing params"}}}},"401":{"description":"Unauthorized access - invalid or unverifiable JWT.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1210003","message":"Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0610013","message":"Forbidden access"}}}}}}},"/prompts/{id}":{"get":{"summary":"Get prompt by id","operationId":"getPromptById","description":"Gets prompt by its id","x-namespace":"/prompts","security":[{"GA":["prompts:read"]}],"tags":["Prompts"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization header containing the JWT generated by API Gateway","required":true,"schema":{"type":"string","minLength":1}},{"in":"path","name":"id","description":"the prompt id.","required":true,"schema":{"type":"string","minLength":1,"maxLength":50}}],"responses":{"200":{"description":"Prompt details","content":{"application/json":{"schema":{"type":"object","required":["id","name","description","type","asset_id","updated_at","updated_by","_links"],"properties":{"id":{"type":"string","description":"The ID of the prompt"},"name":{"type":"string","description":"the prompt name"},"description":{"type":"string","description":"the prompt description"},"type":{"type":"string","description":"the prompt type","enum":["asset","tts","url"]},"asset_id":{"type":"string","description":"asset id"},"created_at":{"type":"string","format":"date-time","description":"The date when the prompt was created"},"created_by":{"type":"string","description":"The user who created the prompt"},"created_user_name":{"type":"string","description":"The user name of whom created the prompt"},"updated_at":{"type":"string","format":"date-time","description":"The date when the prompt was updated"},"updated_by":{"type":"string","description":"The user who updated the prompt"},"updated_user_name":{"type":"string","description":"The user name of whom updated the prompt"},"_links":{"type":"object","description":"HAL API related links.","properties":{"self":{"type":"object","description":"Link to fetch the detail of the prompt","properties":{"href":{"type":"string","description":"Address of the resource"}}},"download_link":{"type":"object","description":"Link used to generate a download link (available only when published or archived states)","properties":{"href":{"type":"string","description":"Download link generation address"}}}}}}},"example":{"id":"95b0f1b471bc44e595e978ed40844b5e","name":"test2.mp3","description":"this is test","asset_id":"95b0f1b471bc44e595e978ed40844b5e","type":"asset","updated_by":"uid","updated_at":"2022-07-20T06:15:41.611Z","_links":{"self":{"href":"https://prompt.talkdesk.com/prompts/95b0f1b471bc44e595e978ed40844b5e"},"download_link":{"href":"https://prompt.talkdesk.com/assets/95b0f1b471bc44e595e978ed40844b5e/download-link"}}}}}},"401":{"description":"Unauthorized access - invalid or unverifiable JWT.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2310002","message":"Unauthorized - Missing required headers"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2310003","message":"Invalid scopes or lack of permissions"}}}},"404":{"description":"Prompt not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2310004","message":"prompt not found"}}}}}},"delete":{"tags":["Prompts"],"summary":"delete prompt by id","description":"delete prompt by its id","operationId":"deletePromptById","x-namespace":"/prompts","security":[{"GA":["prompts:delete"]}],"parameters":[{"name":"Authorization","in":"header","description":"Authorization header containing the JWT generated by API Gateway","required":true,"schema":{"type":"string","minLength":1}},{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":50}}],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized access - invalid or unverifiable JWT.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2310002","message":"Unauthorized - Missing required headers"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2310003","message":"Invalid scopes or lack of permissions"}}}},"404":{"description":"Prompt Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2310004","message":"prompt not found"}}}}}},"patch":{"tags":["Prompts"],"summary":"Partially updates the prompt","description":"Partially updates the prompt by its id","operationId":"PartiallyUpdatesPrompt","x-namespace":"/prompts","security":[{"GA":["prompts:write"]}],"parameters":[{"name":"Authorization","in":"header","description":"Authorization header containing the JWT generated by API Gateway","required":true,"schema":{"type":"string","minLength":1}},{"name":"id","in":"path","description":"prompt id","required":true,"schema":{"type":"string","minLength":1,"maxLength":50}}],"requestBody":{"content":{"application/json-patch+json":{"schema":{"type":"array","items":{"type":"object","properties":{"op":{"type":"string","enum":["REPLACE"],"description":"The operation to be performed"},"path":{"type":"string","description":"A JSON-Pointer"},"value":{"description":"The value to be used within the operations."}},"required":["op","path","value"]}},"example":[{"op":"REPLACE","path":"/name","value":"helloworld"},{"op":"REPLACE","path":"/description","value":"desc."}]}},"required":true},"responses":{"200":{"description":"Prompt info","content":{"application/json":{"schema":{"type":"object","required":["id","name","description","type","asset_id","updated_at","updated_by","_links"],"properties":{"id":{"type":"string","description":"The ID of the prompt"},"name":{"type":"string","description":"the prompt name"},"description":{"type":"string","description":"the prompt description"},"type":{"type":"string","description":"the prompt type","enum":["asset","tts","url"]},"asset_id":{"type":"string","description":"asset id"},"created_at":{"type":"string","format":"date-time","description":"The date when the prompt was created"},"created_by":{"type":"string","description":"The user who created the prompt"},"created_user_name":{"type":"string","description":"The user name of whom created the prompt"},"updated_at":{"type":"string","format":"date-time","description":"The date when the prompt was updated"},"updated_by":{"type":"string","description":"The user who updated the prompt"},"updated_user_name":{"type":"string","description":"The user name of whom updated the prompt"},"_links":{"type":"object","description":"HAL API related links.","properties":{"self":{"type":"object","description":"Link to fetch the detail of the prompt","properties":{"href":{"type":"string","description":"Address of the resource"}}},"download_link":{"type":"object","description":"Link used to generate a download link (available only when published or archived states)","properties":{"href":{"type":"string","description":"Download link generation address"}}}}}}},"example":{"id":"95b0f1b471bc44e595e978ed40844b5e","name":"test2.mp3","description":"this is test","asset_id":"95b0f1b471bc44e595e978ed40844b5e","type":"asset","updated_by":"uid","updated_at":"2022-07-20T06:15:41.611Z","_links":{"self":{"href":"https://prompt.talkdesk.com/prompts/95b0f1b471bc44e595e978ed40844b5e"},"download_link":{"href":"https://prompt.talkdesk.com/assets/95b0f1b471bc44e595e978ed40844b5e/download-link"}}}}}},"400":{"description":"Prompt name must not be duplicated","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2310001","message":"Missing params"}}}},"401":{"description":"Unauthorized access - invalid or unverifiable JWT.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2310002","message":"Unauthorized - Missing required headers"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2310003","message":"Invalid scopes or lack of permissions"}}}},"404":{"description":"Prompt Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2310004","message":"prompt not found"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid required attribute":{"value":{"code":"2310007","message":"Invalid required attribute"}},"Unsupported JSON Patch operation":{"value":{"code":"2310008","message":"Unsupported JSON Patch operation"}}}}}}}},"put":{"tags":["Prompts"],"summary":"update prompt by id","description":"update prompt by id","operationId":"updatePromptById","x-namespace":"/prompts","security":[{"GA":["prompts:write"]}],"parameters":[{"name":"Authorization","in":"header","description":"Authorization header containing the JWT generated by API Gateway","required":true,"schema":{"type":"string","minLength":1}},{"name":"id","in":"path","description":"prompt id","required":true,"schema":{"type":"string","minLength":1,"maxLength":50}}],"requestBody":{"content":{"application/json-patch+json":{"schema":{"type":"object","required":["name","description"],"properties":{"request_id":{"type":"string","minLength":1,"description":"Request id of a prompt"},"name":{"type":"string","minLength":1,"maxLength":35,"description":"Prompt name"},"file_name":{"type":"string","minLength":1,"maxLength":512,"description":"File name"},"description":{"type":"string","minLength":1,"maxLength":64,"description":"Prompt description"}}},"example":{"request_id":"54awe23gby74rfsdcvbq21asd","name":"Welcome","file_name":"test.mp3","description":"this is test"}}},"required":true},"responses":{"201":{"description":"The newly created prompt","content":{"application/json":{"schema":{"type":"object","required":["id","name","description","type","asset_id","updated_at","updated_by","_links"],"properties":{"id":{"type":"string","description":"The ID of the prompt"},"name":{"type":"string","description":"the prompt name"},"description":{"type":"string","description":"the prompt description"},"type":{"type":"string","description":"the prompt type","enum":["asset","tts","url"]},"asset_id":{"type":"string","description":"asset id"},"created_at":{"type":"string","format":"date-time","description":"The date when the prompt was created"},"created_by":{"type":"string","description":"The user who created the prompt"},"created_user_name":{"type":"string","description":"The user name of whom created the prompt"},"updated_at":{"type":"string","format":"date-time","description":"The date when the prompt was updated"},"updated_by":{"type":"string","description":"The user who updated the prompt"},"updated_user_name":{"type":"string","description":"The user name of whom updated the prompt"},"_links":{"type":"object","description":"HAL API related links.","properties":{"self":{"type":"object","description":"Link to fetch the detail of the prompt","properties":{"href":{"type":"string","description":"Address of the resource"}}},"download_link":{"type":"object","description":"Link used to generate a download link (available only when published or archived states)","properties":{"href":{"type":"string","description":"Download link generation address"}}}}}}},"example":{"id":"95b0f1b471bc44e595e978ed40844b5e","name":"test2.mp3","description":"this is test","asset_id":"95b0f1b471bc44e595e978ed40844b5e","type":"asset","updated_by":"uid","updated_at":"2022-07-20T06:15:41.611Z","_links":{"self":{"href":"https://prompt.talkdesk.com/prompts/95b0f1b471bc44e595e978ed40844b5e"},"download_link":{"href":"https://prompt.talkdesk.com/assets/95b0f1b471bc44e595e978ed40844b5e/download-link"}}}}}},"400":{"description":"Validation constraint violation","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2310001","message":"Missing params"}}}},"401":{"description":"Unauthorized access - invalid or unverifiable JWT.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2310002","message":"Unauthorized - Missing required headers"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2310003","message":"Invalid scopes or lack of permissions"}}}},"404":{"description":"Prompt Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2310004","message":"prompt not found"}}}},"409":{"description":"Prompt naming conflict. Already has an prompt with this name.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2310006","message":"Already exists an prompt with the given name"}}}}}}},"/prompts/{id}/download-link":{"get":{"summary":"Generate Download Link","description":"Generates a new temporary download link for the prompt.","x-namespace":"/prompts","tags":["Prompts"],"security":[{"GA":["prompts:download"]}],"parameters":[{"in":"header","name":"Authorization","description":"Authorization header containing the JWT generated by API Gateway","required":true,"schema":{"type":"string","minLength":1}},{"in":"path","name":"id","description":"The prompt id","required":true,"schema":{"type":"string"}},{"in":"query","name":"expires_in","description":"The custom time to live of the link","required":false,"schema":{"type":"integer","minimum":600,"maximum":43200}}],"responses":{"200":{"description":"The newly generated prompt's download link","content":{"application/json":{"schema":{"type":"object","required":["expires_in","_links"],"properties":{"expires_in":{"type":"integer","description":"Download link expiration time in seconds","default":600},"_links":{"type":"object","description":"HAL API related links.","properties":{"location":{"type":"object","description":"Temporary link granting access to the prompt","properties":{"href":{"type":"string","description":"Address of the resource"}}}}}}},"example":{"expires_in":600,"_links":{"location":{"href":"https://amazone.download.com/bucket/9821123e4567e89b12d3a456426655440010"}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2310001","message":"Missing params"}}}},"401":{"description":"Unauthorized access - invalid or unverifiable JWT.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2310002","message":"Unauthorized - Missing required headers"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2310003","message":"Invalid scopes or lack of permissions"}}}},"404":{"description":"Prompt not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2310004","message":"prompt not found"}}}}}}},"/prompts-usage":{"get":{"summary":"Get usage of a prompt","description":"Get usage of a prompt","x-namespace":"/prompts-usage","operationId":"GetUsageByPromptId","security":[{"GA":["prompts:read"]}],"tags":["Prompts"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization header containing the JWT generated by API Gateway","required":true,"schema":{"type":"string","minLength":1}},{"in":"query","name":"id","description":"Filter by prompt id","example":"prompt_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Prompt Usage","content":{"application/json":{"schema":{"type":"object","required":["_embedded","_links"],"properties":{"_embedded":{"type":"object","required":["prompt_usages"],"properties":{"prompt_usages":{"type":"array","items":{"type":"object","required":["id","usage","flows_usage","queues_usage"],"properties":{"id":{"type":"string","description":"The ID of the prompt"},"usage":{"type":"integer","description":"The usage of the prompt"},"flows_usage":{"type":"integer","description":"The usage for flows of the prompt"},"queues_usage":{"type":"integer","description":"The usage for queues of the prompt"}}}}}},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string","format":"uri","minLength":1}}}}}}},"example":{"_embedded":{"prompt_usages":[{"id":"prompt_id1","usage":1,"flows_usage":1,"queues_usage":0},{"id":"prompt_id2","usage":2,"flows_usage":1,"queues_usage":1}]},"_links":{"self":{"href":"https://api.talkdeskstg.com/prompts-usage?id=id1&id=id2"}}}}}},"400":{"description":"Invalid parameter","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2310001","message":"Missing params"}}}},"401":{"description":"Unauthorized access - invalid or unverifiable JWT.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1210003","message":"Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0610013","message":"Forbidden access"}}}}}}},"/prompts-requests":{"post":{"summary":"Request upload link","operationId":"reuqestUploadLink","description":"Request upload link","x-namespace":"/prompts-requests","security":[{"GA":["prompts:write"]}],"tags":["Prompts"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization header containing the JWT generated by API Gateway","required":true,"schema":{"type":"string","minLength":1}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"validation_constraints":{"type":"object","description":"Prompt validation constraints validated at prompt creation time. Max file size is 100 Megabytes.","properties":{"allowed_mime_types":{"type":"array","description":"The allowed MIME Types for this prompt","items":{"type":"string","description":"The allowed mime-type option","enum":["audio/wav","audio/mp3","audio/mpeg"]}}}}}},"example":{"validation_constraints":{"allowed_mime_types":["audio/mp3","audio/wav"]}}}},"description":"Request upload link for an authorized account.","required":true},"responses":{"201":{"description":"The newly generated upload link and request id","content":{"application/json":{"schema":{"type":"object","required":["id","_links"],"properties":{"id":{"type":"string","description":"ID that should be used as the request identifier (request_id) when creating the prompt"},"_links":{"type":"object","description":"HAL API related links.","properties":{"upload_link":{"type":"string","description":"Link used to upload the asset (available only when draft state)","properties":{"href":{"type":"string","description":"Upload link address"}}}}}}},"example":{"id":"123e4567e89b12d3a456426655440010","_links":{"upload_link":"https://some.external.cdn.org/assets/9821123e4567e89b12d3a456426655440010"}}}}},"400":{"description":"Validation constraint violation","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2310001","message":"Missing params"}}}},"401":{"description":"Unauthorized access - invalid or unverifiable JWT.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2310002","message":"Unauthorized - Missing required headers"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2310003","message":"Invalid scopes or lack of permissions"}}}}}}},"/prompts-quota":{"get":{"summary":"Get prompts quota","description":"Get prompts quota","x-namespace":"/prompts-quota","operationId":"GetPromptsQuota","security":[{"GA":["prompts:read"]}],"tags":["Prompts"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization header containing the JWT generated by API Gateway","required":true,"schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"Prompt quota","content":{"application/json":{"schema":{"type":"object","required":["id","account_id","max_value","current_count","threshold","_links"],"properties":{"id":{"type":"string","description":"The ID of the prompt"},"account_id":{"type":"string","description":"account id"},"max_value":{"type":"integer","description":"max value of prompts under the account","minimum":1,"maximum":2147483647},"current_count":{"type":"integer","description":"current count of prompts under the account","minimum":1,"maximum":2147483647},"threshold":{"type":"number","description":"threshold of prompts under the account","maximum":1},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string","format":"uri","minLength":1}}}}}}},"example":{"id":"95b0f1b471bc44e595e978ed40844b5e","account_id":"begh1bt171bc44e595e978ed40844b5e","max_value":100,"current_count":77,"threshold":0.8,"_links":{"self":{"href":"https://api.talkdeskstg.com/prompts-quota/95b0f1b471bc44e595e978ed40844b5e"}}}}}},"400":{"description":"Invalid parameter","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2310001","message":"Missing params"}}}},"401":{"description":"Unauthorized access - invalid or unverifiable JWT.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1210003","message":"Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0610013","message":"Forbidden access"}}}}}}},"/prompts/bulk":{"post":{"summary":"Prompts Bulk Operation","operationId":"promptsBulkOperation","description":"Prompts bulk download/delete","x-namespace":"/prompts","security":[{"GA":["prompts:delete","prompts:download"]}],"tags":["Prompts"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization header containing the JWT generated by API Gateway","required":true,"schema":{"type":"string","minLength":1}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"method":{"type":"string","enum":["DOWNLOAD","DELETE"],"description":"operation type"},"requests":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string","description":"prompt resource path"},"body":{"description":"request body"}}}}},"required":["method","requests"]},"example":{"method":"DOWNLOAD","requests":[{"path":"/dd3023a419dc4e125abbe6f9905f498m","body":null},{"path":"/kj6023a419dc4e221abbe6f9905f4yrc","body":null}]}}},"description":"Prompts bulk operation for an authorized account.","required":true},"responses":{"200":{"description":"bulk operation results","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string","description":"prompt resource path"},"method":{"type":"string","enum":["DOWNLOAD","DELETE"],"description":"operation type"},"status":{"type":"number","description":"http status value"},"response_body":{"type":"object","properties":{"code":{"type":"string","description":"business status code"},"message":{"type":"string","description":"service message"},"data":{"description":"response body"}}}},"required":["path","method","status"]}},"example":[{"path":"/dd3023a419dc4e125abbe6f9905f498m","method":"DOWNLOAD","status":200,"response_body":{"code":"200","message":"OK","data":{"expires_in":600,"_links":{"location":{"href":"https://amazone.resource.com/resource_id"}}}}},{"path":"/kj6023a419dc4e221abbe6f9905f4yrc","method":"DOWNLOAD","status":200,"response_body":{"code":"200","message":"OK","data":{"expires_in":600,"_links":{"location":{"href":"https://amazone.resource.com/resource_id"}}}}}]}}},"400":{"description":"Validation constraint violation","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2310001","message":"Missing params"}}}},"401":{"description":"Unauthorized access - invalid or unverifiable JWT.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2310002","message":"Unauthorized - Missing required headers"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2310003","message":"Invalid scopes or lack of permissions"}}}}}}},"/prompts/{id}/flows":{"get":{"summary":"Get the flow list by a prompt id","description":"Get the flow list by a prompt id","x-namespace":"/prompts","operationId":"GetFlowsByPromptId","security":[{"GA":["prompts:read"]}],"tags":["Prompts"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization header containing the JWT generated by API Gateway","required":true,"schema":{"type":"string","minLength":1}},{"in":"path","name":"id","description":"the prompt id.","required":true,"schema":{"type":"string","minLength":1,"maxLength":50}},{"name":"search","in":"query","description":"Fuzzy search flows by some fields","required":false,"example":"test","schema":{"type":"string","minLength":0,"maxLength":20,"x-search_operators":null,"x-search_fields":["flow_name"]}},{"name":"search_fields","in":"query","required":false,"schema":{"type":"string","minLength":0,"maxLength":20,"default":"flow_name"}},{"name":"page","in":"query","description":"Desired page","schema":{"format":"int32","type":"integer","default":1,"minimum":1,"maximum":2147483647}},{"name":"per_page","in":"query","description":"Limit the number of prompt flows per page","schema":{"format":"int32","default":50,"minimum":1,"maximum":250,"type":"integer"}}],"responses":{"200":{"description":"Prompts list","content":{"application/json":{"schema":{"type":"object","required":["total","page","per_page","_embedded","_links"],"properties":{"total":{"type":"integer"},"page":{"type":"integer","default":1},"per_page":{"type":"integer","default":20},"_embedded":{"type":"object","required":["prompt_flows"],"properties":{"prompt_flows":{"type":"array","items":{"type":"object","required":["id","flow_id","flow_name"],"properties":{"id":{"type":"string","description":"prompt id"},"flow_id":{"type":"string","description":"id of the flow"},"flow_name":{"type":"string"},"published_flow_version":{"description":"published flow version of the flow","type":"object","required":["flow_id","flow_name","flow_version_id","flow_version_status","flow_trigger_type"],"properties":{"flow_id":{"type":"string"},"flow_name":{"type":"string"},"flow_version_id":{"type":"string"},"flow_version_status":{"type":"string","maxLength":255,"enum":["PUBLISHED","DRAFT"]},"flow_trigger_type":{"type":"string","enum":["VOICE_INBOUND","API","MESSAGE_INBOUND","MODULE"]}}},"draft_flow_version":{"description":"draft flow version of the flow","type":"object","required":["flow_id","flow_name","flow_version_id","flow_version_status","flow_trigger_type"],"properties":{"flow_id":{"type":"string"},"flow_name":{"type":"string"},"flow_version_id":{"type":"string"},"flow_version_status":{"type":"string","maxLength":255,"enum":["PUBLISHED","DRAFT"]},"flow_trigger_type":{"type":"string","enum":["VOICE_INBOUND","API","MESSAGE_INBOUND","MODULE"]}}}}}}}},"_links":{"type":"object","description":"HAL API related links.","properties":{"self":{"type":"object","description":"Current page of this prompt flows list","properties":{"href":{"type":"string","description":"Address of the resource","default":"https://prompts.talkdesk.com/prompts/1/flows?page=2"}}},"prev":{"type":"object","description":"Previous page of this prompt flows list","properties":{"href":{"type":"string","description":"Address of the resource","default":"https://prompts.talkdesk.com/prompts/1/flows?page=1"}}},"next":{"type":"object","description":"Next page of the prompt flows list","properties":{"href":{"type":"string","description":"Address of the resource","default":"https://prompts.talkdesk.com/prompts/1/flows?page=3"}}}}}}},"example":{"total":6,"page":2,"per_page":1,"_embedded":{"prompt_flows":[{"id":"p1","flow_id":"f1","flow_name":"test flow","published_flow_version":{"flow_id":"f1","flow_name":"test flow","flow_version_id":"f1v1","flow_version_status":"PUBLISHED","flow_trigger_type":"VOICE_INBOUND"},"draft_flow_version":{"flow_id":"f1","flow_name":"test flow draft","flow_version_id":"f1v2","flow_version_status":"DRAFT","flow_trigger_type":"VOICE_INBOUND"}},{"id":"p1","flow_id":"f2","flow_name":"test flow2","published_flow_version":{"flow_id":"f2","flow_name":"test flow2","flow_version_id":"f1v2","flow_version_status":"PUBLISHED","flow_trigger_type":"MODULE"}}]},"_links":{"self":{"href":"https://prompts.talkdesk.com/prompts/1/flows?page=2"},"prev":{"href":"https://prompts.talkdesk.com/prompts/1/flows?page=1"},"next":{"href":"https://prompts.talkdesk.com/prompts/1/flows?page=3"}}}}}},"400":{"description":"Invalid parameter value","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2310001","message":"Missing params"}}}},"401":{"description":"Unauthorized access - invalid or unverifiable JWT.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1210003","message":"Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0610013","message":"Forbidden access"}}}},"404":{"description":"Prompt not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2310004","message":"prompt not found"}}}}}}},"/fsi-insurance-integrations/accounts":{"get":{"tags":["FSI Insurance Integrations"],"description":"Get accounts from a search criteria","operationId":"SearchingFsiInsuranceAccount","security":[{"GA":["fsi-insurance-integrations-accounts:read"]}],"parameters":[{"in":"query","name":"skip","description":"The number of elements to skip in accounts collection","schema":{"type":"integer","minimum":0,"maximum":2147483647,"default":0}},{"in":"query","name":"limit","description":"The maximum number of elements in accounts collection","schema":{"type":"integer","minimum":1,"maximum":500,"default":20}},{"name":"ssn","in":"query","description":"Account holder ssn","required":false,"schema":{"type":"string","minLength":0,"maxLength":11}},{"name":"email","in":"query","description":"Account holder email","required":false,"schema":{"type":"string","minLength":0,"maxLength":2147483647}},{"name":"phone_number","in":"query","description":"Matches any of the account holder's phone numbers","required":false,"schema":{"type":"string","minLength":0,"maxLength":2147483647}},{"name":"first_name","in":"query","description":"Account holder first name","required":false,"schema":{"type":"string","minLength":0,"maxLength":2147483647}},{"name":"last_name","in":"query","description":"Account holder last name","required":false,"schema":{"type":"string","minLength":0,"maxLength":2147483647}}],"responses":{"200":{"description":"Accounts response","content":{"application/json":{"schema":{"type":"object","description":"Offset based pagination for accounts","required":["_embedded","total"],"properties":{"_embedded":{"type":"object","required":["accounts"],"properties":{"accounts":{"description":"List of accounts","type":"array","items":{"type":"object","required":["account_number","first_name","last_name","date_of_birth","account_status"],"properties":{"id":{"type":"string","description":"ID of the account","minLength":0,"maxLength":2147483647},"account_number":{"type":"string","description":"Identifier of the account","minLength":0,"maxLength":2147483647},"first_name":{"type":"string","description":"Account holder first name","minLength":0,"maxLength":2147483647},"last_name":{"type":"string","description":"Account holder last name","minLength":0,"maxLength":2147483647},"policies":{"type":"array","items":{"type":"object","required":["policy_number"],"properties":{"policy_number":{"type":"string","description":"Policy number related to account","minLength":0,"maxLength":2147483647}}}},"customer_since":{"type":"string","description":"Account holder customer since date","format":"date-time"},"date_of_birth":{"type":"string","description":"Account holder birth date","format":"date"},"account_status":{"type":"string","description":"Account status","minLength":0,"maxLength":2147483647},"delinquent":{"type":"boolean","description":"Account delinquency status"},"primary_phone_number":{"type":"string","description":"Account holder primary phone number","minLength":0,"maxLength":2147483647},"work_phone_number":{"type":"string","description":"Account holder work phone number","minLength":0,"maxLength":2147483647},"fax_phone_number":{"type":"string","description":"Account holder fax phone number","minLength":0,"maxLength":2147483647},"home_phone_number":{"type":"string","description":"Account holder home phone number","minLength":0,"maxLength":2147483647},"mobile_phone_number":{"type":"string","description":"Account holder mobile phone number","minLength":0,"maxLength":2147483647},"tax_id":{"type":"string","description":"Account holder tax id","minLength":0,"maxLength":2147483647},"custom_fields":{"description":"Custom fields associated with the entity.","type":"array","items":{"type":"object","required":["key"],"properties":{"key":{"type":"string","description":"custom field name","minLength":0,"maxLength":255},"value":{"type":"object","description":"custom field value"}}}},"primary_address":{"type":"object","required":["address_line_1","country","city","state","zip_code"],"properties":{"address_line_1":{"type":"string","description":"The first address line of the location"},"address_line_2":{"type":"string","description":"The second address line of the location"},"address_line_3":{"type":"string","description":"The third address line of the location"},"city":{"type":"string","description":"The city where the location is situated"},"country":{"type":"string","description":"The country code where the location is situated"},"country_name":{"type":"string","description":"The country name where the location is situated"},"location_description":{"type":"string","description":"The location's description"},"name":{"type":"string","description":"The location's display name"},"state":{"type":"string","description":"The state code where the location is situated"},"state_name":{"type":"string","description":"The state name where the location is situated"},"zip_code":{"type":"string","description":"The zip code of the location"}}},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}}}}}}}}},"total":{"type":"integer","description":"Total number of accounts","minimum":0,"default":0},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}}}}}},"example":{"_embedded":{"accounts":[{"account_number":"C000143542","first_name":"Ray","last_name":"Newton","policies":[{"policy_number":7830442500}],"account_status":"Active","customer_since":"2020-12-01T14:56:00.00Z","date_of_birth":"1970-10-01","delinquent":true,"primary_phone_number":"+1 650-333-3333","work_phone_number":"+1 650-333-3333","fax_phone_number":"+1 818-446-1206","mobile_phone_number":"+1 818-446-1207","home_phone_number":"+1 818-446-1208","primary_address":{"address_line_1":"The non-existing street","address_line_2":"No. 1","address_line_3":"Buildings block","city":"Miami","country":"US","country_name":"United States","location_description":"This location is an example","name":"The non-existing street, No. 1, Miami, 1234-567","state":"FL","state_name":"Florida","zip_code":"1234-567"},"tax_id":"123-45-6789","custom_fields":[{"key":"claim_custom_fields","value":"000000"}]}]},"total":1}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1940001","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1940002","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1940003","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1940004","message":"No contact was found."}}}}}}},"/fsi-insurance-integrations/accounts/{account_number}":{"get":{"tags":["FSI Insurance Integrations"],"description":"Get account with account number","operationId":"GettingFsiInsuranceAccount","security":[{"GA":["fsi-insurance-integrations-accounts:read"]}],"parameters":[{"name":"account_number","in":"path","description":"Account number","required":true,"schema":{"type":"string","minLength":1,"maxLength":20}}],"responses":{"200":{"description":"Accounts response","content":{"application/json":{"schema":{"type":"object","required":["account_number","first_name","last_name","date_of_birth","account_status"],"properties":{"id":{"type":"string","description":"ID of the account","minLength":0,"maxLength":2147483647},"account_number":{"type":"string","description":"Identifier of the account","minLength":0,"maxLength":2147483647},"first_name":{"type":"string","description":"Account holder first name","minLength":0,"maxLength":2147483647},"last_name":{"type":"string","description":"Account holder last name","minLength":0,"maxLength":2147483647},"policies":{"type":"array","items":{"type":"object","required":["policy_number"],"properties":{"policy_number":{"type":"string","description":"Policy number related to account","minLength":0,"maxLength":2147483647}}}},"customer_since":{"type":"string","description":"Account holder customer since date","format":"date-time"},"date_of_birth":{"type":"string","description":"Account holder birth date","format":"date"},"account_status":{"type":"string","description":"Account status","minLength":0,"maxLength":2147483647},"delinquent":{"type":"boolean","description":"Account delinquency status"},"primary_phone_number":{"type":"string","description":"Account holder primary phone number","minLength":0,"maxLength":2147483647},"work_phone_number":{"type":"string","description":"Account holder work phone number","minLength":0,"maxLength":2147483647},"fax_phone_number":{"type":"string","description":"Account holder fax phone number","minLength":0,"maxLength":2147483647},"home_phone_number":{"type":"string","description":"Account holder home phone number","minLength":0,"maxLength":2147483647},"mobile_phone_number":{"type":"string","description":"Account holder mobile phone number","minLength":0,"maxLength":2147483647},"tax_id":{"type":"string","description":"Account holder tax id","minLength":0,"maxLength":2147483647},"custom_fields":{"description":"Custom fields associated with the entity.","type":"array","items":{"type":"object","required":["key"],"properties":{"key":{"type":"string","description":"custom field name","minLength":0,"maxLength":255},"value":{"type":"object","description":"custom field value"}}}},"primary_address":{"type":"object","required":["address_line_1","country","city","state","zip_code"],"properties":{"address_line_1":{"type":"string","description":"The first address line of the location"},"address_line_2":{"type":"string","description":"The second address line of the location"},"address_line_3":{"type":"string","description":"The third address line of the location"},"city":{"type":"string","description":"The city where the location is situated"},"country":{"type":"string","description":"The country code where the location is situated"},"country_name":{"type":"string","description":"The country name where the location is situated"},"location_description":{"type":"string","description":"The location's description"},"name":{"type":"string","description":"The location's display name"},"state":{"type":"string","description":"The state code where the location is situated"},"state_name":{"type":"string","description":"The state name where the location is situated"},"zip_code":{"type":"string","description":"The zip code of the location"}}},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}}}}}},"example":{"account_number":"C000143542","first_name":"Ray","last_name":"Newton","policies":[{"policy_number":7830442500}],"account_status":"Active","customer_since":"2020-12-01T14:56:00.00Z","date_of_birth":"1970-10-01","delinquent":true,"primary_phone_number":"+1 650-333-3333","work_phone_number":"+1 650-333-3333","fax_phone_number":"+1 818-446-1206","mobile_phone_number":"+1 818-446-1207","home_phone_number":"+1 818-446-1208","primary_address":{"address_line_1":"The non-existing street","address_line_2":"No. 1","address_line_3":"Buildings block","city":"Miami","country":"US","country_name":"United States","location_description":"This location is an example","name":"The non-existing street, No. 1, Miami, 1234-567","state":"FL","state_name":"Florida","zip_code":"1234-567"},"tax_id":"123-45-6789","custom_fields":[{"key":"claim_custom_fields","value":"000000"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1940001","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1940002","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1940003","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1940004","message":"No contact was found."}}}}}}},"/fsi-insurance-integrations/account-holders/{id}/policies":{"get":{"tags":["FSI Insurance Integrations"],"description":"Get policies from an account holder","operationId":"GettingFsiInsurancePolicies","security":[{"GA":["fsi-insurance-integrations-policies:read"]}],"parameters":[{"name":"skip","in":"query","description":"Number of elements to skip","schema":{"type":"integer","minimum":0,"default":0,"maximum":2147483647}},{"name":"limit","in":"query","description":"Limit of elements to be fetched","schema":{"type":"integer","minimum":1,"maximum":500,"default":20}},{"name":"id","in":"path","description":"The account holder id","required":true,"schema":{"type":"string","minLength":0,"maxLength":2147483647}},{"name":"order_by","in":"query","schema":{"type":"string","minLength":0,"maxLength":2147483647,"default":"id:asc","x-sorting_default_order":"asc","x-sorting_fields":["id"]}}],"responses":{"200":{"description":"Claims response","content":{"application/json":{"schema":{"type":"object","description":"Offset based pagination for policies","required":["_embedded","total"],"properties":{"_embedded":{"type":"object","required":["policies"],"properties":{"policies":{"description":"List of policies","type":"array","items":{"type":"object","required":["number","type","delinquency_status","status"],"properties":{"number":{"type":"string","description":"The ID number that uniquely identifies the policy within the Insurance company system"},"delinquency_status":{"type":"string","description":"Policy Delinquency Status"},"type":{"type":"string","description":"Policy type code"},"status":{"type":"string","description":"Policy Status code"},"custom_fields":{"description":"Custom fields associated with the entity.","type":"array","items":{"type":"object","required":["key"],"properties":{"key":{"type":"string","description":"custom field name","minLength":0,"maxLength":255},"value":{"type":"object","description":"custom field value"}}}}}}}}},"total":{"type":"integer","description":"Total number of policies","minimum":0,"default":0},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}}}}}},"example":{"_embedded":{"policies":[{"number":"number_id_1","type":"PersonalAuto","delinquency_status":"delinquency status","status":"inforce","custom_fields":[{"key":"policies_custom_fields","value":"000000"}]}]},"total":1}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1940001","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1940002","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1940003","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1940004","message":"No contact was found."}}}}}}},"/fsi-insurance-integrations/policies/{id}":{"get":{"tags":["FSI Insurance Integrations"],"description":"Get policy period from a policy","operationId":"GettingFsiInsurancePoliciesPeriod","security":[{"GA":["fsi-insurance-integrations-policies:read"]}],"parameters":[{"name":"id","in":"path","description":"The policy number","required":true,"schema":{"type":"string","minLength":0,"maxLength":2147483647}}],"responses":{"200":{"description":"Policy period response","content":{"application/json":{"schema":{"type":"object","required":["product","payment_schedule","policy_contact_roles","policy_number"],"properties":{"id":{"type":"string","description":"The policy number"},"effective_date":{"type":"string","description":"the effective date of the policy","format":"date-time"},"expiration_date":{"type":"string","description":"the expiration date of the policy","format":"date-time"},"organization_name":{"type":"string","description":"the organization name of the policy"},"organization_type":{"type":"string","description":"the organization type of the policy"},"pa_coverages":{"type":"array","description":"The personal auto coverages of the policy","items":{"type":"object","required":["coverage_name"],"properties":{"cov_term":{"type":"array","description":"The coverage terms","items":{"type":"object","required":["cov_term_name"],"properties":{"cov_term_name":{"type":"string","description":"The coverage term name"},"cov_term_value":{"type":"string","description":"The coverage term value"}}}},"coverage_name":{"type":"string","description":"The coverage name"}}}},"pa_vehicles":{"type":"array","description":"The personal auto vehicles of the policy","items":{"type":"object","required":["serial_number"],"properties":{"color":{"type":"string","description":"The color of the vehicle"},"vin":{"type":"string","description":"The vin of the vehicle"},"make":{"type":"string","description":"The vehicle's make"},"model":{"type":"string","description":"The vehicle's model"},"plate":{"type":"string","description":"The vehicle's plate"},"state":{"type":"string","description":"The vehicle's state"},"serial_number":{"type":"string","description":"The vehicle's serial number (only used in specific cases)"},"year":{"type":"integer","description":"The year when the vehicle was built"},"vehicle_coverages":{"type":"array","items":{"type":"object","required":["coverage_name"],"properties":{"cov_term":{"type":"array","description":"The coverage terms","items":{"type":"object","required":["cov_term_name"],"properties":{"cov_term_name":{"type":"string","description":"The coverage term name"},"cov_term_value":{"type":"string","description":"The coverage term value"}}}},"coverage_name":{"type":"string","description":"The coverage name"}}}}}}},"payment_schedule":{"type":"array","description":"The payment schedule of the policy","items":{"type":"object","required":["amount"],"properties":{"amount":{"type":"string","description":"the amount of payment"},"billing_due_date":{"type":"string","format":"date-time","description":"the due date of the payment"},"statement_due":{"type":"string","format":"date-time","description":"the statement date of the payment"}}}},"policy_contact_roles":{"type":"array","description":"The policy contacts","items":{"type":"object","required":["primary_phone_number"],"properties":{"date_of_birth":{"type":"string","description":"contact's date of birth","format":"date-time"},"email_address":{"type":"string","description":"contact's email address"},"first_name":{"type":"string","description":"contact's first name"},"gender":{"type":"string","description":"contact's gender"},"last_name":{"type":"string","description":"contact's last name"},"marital_status":{"type":"string","description":"contact's marital status"},"primary_address":{"type":"string","description":"the contact's primary address"},"primary_phone_number":{"type":"string","description":"contact's primary phone number"},"role":{"type":"string","description":"contact's role"},"ssn":{"type":"string","description":"contact's social security number"}}}},"hop_dwellings":{"type":"array","description":"Homeowners policy dwellings","items":{"type":"object","properties":{"location_number":{"type":"string","description":"Location number"},"location_address":{"type":"string","description":"Location address"},"territory_codes":{"type":"array","description":"Territory codes","items":{"type":"object","properties":{"code":{"type":"string","description":"The code for territory"}}}},"dwelling_coverages":{"type":"array","description":"Dwelling coverages","items":{"type":"object","properties":{"coverage_name":{"type":"string","description":"Coverage name"},"cov_terms":{"type":"array","description":"Coverage terms","items":{"type":"object","required":["cov_term_name"],"properties":{"cov_term_name":{"type":"string","description":"The coverage term name"},"cov_term_value":{"type":"string","description":"The coverage term value"}}}}}}}}}},"hop_coverages":{"type":"array","description":"Homeowners policy coverages","items":{"type":"object","required":["coverage_name"],"properties":{"cov_term":{"type":"array","description":"The coverage terms","items":{"type":"object","required":["cov_term_name"],"properties":{"cov_term_name":{"type":"string","description":"The coverage term name"},"cov_term_value":{"type":"string","description":"The coverage term value"}}}},"coverage_name":{"type":"string","description":"The coverage name"}}}},"hop_scheduled_personal_property_cov":{"type":"object","description":"Homeowners scheduled personal property coverage","properties":{"cov_scheduled_items":{"type":"array","description":"Coverage Scheduled Items","items":{"type":"object","required":["clauses"],"properties":{"clauses":{"type":"array","description":"Coverage term clauses","items":{"type":"object","required":["cov_terms"],"properties":{"cov_terms":{"type":"array","description":"Term clauses","items":{"type":"object","required":["cov_term_name"],"properties":{"cov_term_name":{"type":"string","description":"The coverage term name"},"cov_term_value":{"type":"string","description":"The coverage term value"}}}}}}}}}},"scheduled_properties":{"type":"array","description":"Scheduled properties","items":{"type":"object","required":["serial_no"],"properties":{"description":{"type":"string","description":"Scheduled item description"},"serial_no":{"type":"string","description":"Serial number"},"appraiser":{"type":"string","description":"Appraiser information"},"appraisal_info":{"type":"string","description":"Appraisal information"},"date_of_appraisal":{"type":"string","format":"date-time","description":"Date of appraisal"}}}}}},"hop_valuable_personal_property":{"type":"object","description":"Homeowners valuable personal property","required":["cov_scheduled_items"],"properties":{"cov_scheduled_items":{"type":"array","description":"Coverage scheduled items","items":{"type":"object","required":["clauses"],"properties":{"clauses":{"type":"array","description":"Coverage term clauses","items":{"type":"object","required":["cov_terms"],"properties":{"cov_terms":{"type":"array","description":"Term clauses","items":{"type":"object","required":["cov_term_name"],"properties":{"cov_term_name":{"type":"string","description":"The coverage term name"},"cov_term_value":{"type":"string","description":"The coverage term value"}}}}}}}}}}}},"policy_number":{"type":"string","description":"the policy number"},"primary_named_insured":{"type":"string","description":"the primary insured entity"},"producer_code":{"type":"string","description":"the policy producers code"},"producer_code_desc":{"type":"string","description":"the description of the producers code"},"product":{"type":"string","description":"the policy's product"},"status":{"type":"string","description":"the policy's status"},"custom_fields":{"description":"Custom fields associated with the entity.","type":"array","items":{"type":"object","required":["key"],"properties":{"key":{"type":"string","description":"custom field name","minLength":0,"maxLength":255},"value":{"type":"object","description":"custom field value"}}}}}},"example":{"effective_date":"1970-01-01T00:00:00.000Z","expiration_date":"1971-01-01T00:00:00.000Z","organization_name":"organization name","organization_type":"organization type","pa_coverages":[{"pa_coverage":null,"cov_terms":[{"cov_term_name":"Some cov term name","cov_term_value":"Some cov term value"}],"coverage_name":"Some coverage name"}],"pa_vehicles":[{"pa_vehicle":null,"color":"black","make":"Nissan","model":"Pickup","plate":"031939","state":"Nevada","vin":"JN6MD06S2BW031939","vehicle_coverages":[{"cov_terms":[{"cov_term_name":"Some cov term name","cov_term_value":"Some cov term value"}],"coverage_name":"Some coverage name"}],"year":1970}],"payment_schedule":[{"payment_schedule":null,"amount":250,"billing_due_date":"1970-01-01T00:00:00.000Z","statement_date":"1971-01-01T00:00:00.000Z"}],"policy_contact_roles":[{"policy_contact_role":null,"additional_interest":[{"additional_interest_type":"Some type","certificate_required":false,"contract_number":123123,"related_to":"Someone"}],"date_of_birth":"1970-01-01T00:00:00.000Z","email_address":"example@talkdesk.com","first_name":"John","gender":"Male","last_name":"Doe","marital_status":"Single","primary_address":"Some primary address 123","primary_phone_number":123123123,"role":"Insured","ssn":"some social security number"}],"hop_dwellings":[{"hop_dwelling":null,"location_number":1,"location_address":"1: 0399 Bridgepointe Parkway, San Mateo, CA","territory_codes":[{"code":"30"}],"dwelling_coverages":[{"coverage_name":"Coverage A - Dwelling","cov_terms":[{"cov_term_name":"Some cov term name","cov_term_value":"Some cov term value"}]}]}],"hop_coverages":[{"hop_coverage":null,"cov_terms":[{"cov_term_name":"Some cov term name","cov_term_value":"Some cov term value"}],"coverage_name":"Some coverage name"}],"hop_scheduled_personal_property_cov":[{"cov_scheduled_items":[{"clauses":[{"cov_terms":[{"cov_term_name":"Some cov term name","cov_term_value":"Some cov term value"}]}]}],"scheduled_properties":[{"description":"Antique violin","serial_no":"A129468239","appraiser":"Appraisal Associates","appraisal_info":"From the late 1800s","date_of_appraisal":"2022-11-23"}]}],"hop_valuable_personal_property":[{"cov_scheduled_items":[{"clauses":[{"cov_terms":[{"cov_term_name":"Some cov term name","cov_term_value":"Some cov term value"}]}]}]}],"policy_number":2756426680,"primary_named_insured":"Sherman Developments","producer_code":"100-002541","producer_code_desc":"Armstrong and Company","product":"Commercial Package","status":"Expired","custom_fields":[{"key":"policies_period_custom_fields","value":"000000"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1940001","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1940002","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1940003","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1940004","message":"No contact was found."}}}}}}},"/fsi-insurance-integrations/policies":{"get":{"tags":["FSI Insurance Integrations"],"description":"Search policies","security":[{"GA":["fsi-insurance-integrations-policies:read"]}],"parameters":[{"name":"skip","in":"query","description":"Number of elements to skip","schema":{"type":"integer","minimum":0,"default":0,"maximum":2147483647}},{"name":"limit","in":"query","description":"Limit of elements to be fetched","schema":{"type":"integer","minimum":1,"maximum":500,"default":20}},{"name":"number","in":"query","schema":{"type":"string","minLength":0,"maxLength":2147483647,"x-filterable":true}},{"name":"ssn","in":"query","schema":{"type":"string","minLength":0,"maxLength":2147483647}},{"name":"type","in":"query","schema":{"type":"string","minLength":0,"maxLength":2147483647,"x-filterable":true}},{"name":"vin","in":"query","schema":{"type":"string","minLength":0,"maxLength":2147483647}},{"name":"first_name","in":"query","schema":{"type":"string","minLength":0,"maxLength":2147483647,"x-filterable":true}},{"name":"last_name","in":"query","schema":{"type":"string","minLength":0,"maxLength":2147483647,"x-filterable":true}},{"name":"country","in":"query","schema":{"type":"string","minLength":0,"maxLength":2147483647}},{"name":"city","in":"query","schema":{"type":"string","minLength":0,"maxLength":2147483647}},{"name":"organization_name","in":"query","schema":{"type":"string","minLength":0,"maxLength":2147483647}},{"name":"state","in":"query","schema":{"type":"string","minLength":0,"maxLength":2147483647}},{"name":"loss_at","in":"query","schema":{"type":"string","minLength":0,"maxLength":2147483647}},{"name":"zip_code","in":"query","schema":{"type":"string","minLength":0,"maxLength":2147483647}},{"name":"order_by","in":"query","required":false,"schema":{"type":"string","minLength":0,"maxLength":2147483647,"default":"id:asc","x-sorting_default_order":"asc","x-sorting_fields":["id"]}}],"responses":{"200":{"description":"Policy search response","content":{"application/json":{"schema":{"type":"object","description":"Offset based pagination for policies","required":["_embedded","total"],"properties":{"_embedded":{"type":"object","required":["policies"],"properties":{"policies":{"description":"List of policies","type":"array","items":{"type":"object","required":["id","number","type","type_name","insured_name","address","effective_at","renewal_at","status","status_name"],"properties":{"id":{"type":"string","description":"The ID number that uniquely identifies the policy within the Insurance company system"},"number":{"type":"string","description":"The ID number that uniquely identifies the policy within the Insurance company system"},"type":{"type":"string","description":"Policy type code"},"type_name":{"type":"string","description":"Policy type name"},"insured_name":{"type":"string","description":"Insured Name"},"address":{"type":"string","description":"Insured Address"},"effective_at":{"type":"string","description":"Date of being effective","format":"date"},"renewal_at":{"type":"string","description":"Date of Renewal","format":"date"},"status":{"type":"string","description":"Policy Status code"},"status_name":{"type":"string","description":"Policy Status name"},"custom_fields":{"description":"Custom fields associated with the entity.","type":"array","items":{"type":"object","required":["key"],"properties":{"key":{"type":"string","description":"custom field name","minLength":0,"maxLength":255},"value":{"type":"object","description":"custom field value"}}}}}}}}},"total":{"type":"integer","description":"Total number of policies","minimum":0,"default":0},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}}}}}},"example":{"_embedded":{"policies":[{"id":"number_id_1","number":"number_id_1","type":"PersonalAuto","type_name":"Personal Auto","insured_name":"Francesca Powers","address":"860-9281 Aliquam Rd., South Pasadena, California, 91145","effective_at":"2019-10-02","renewal_at":"2020-10-01","status":"inforce","status_name":"In force","custom_fields":[{"key":"policies_search_custom_fields","value":"000000"}]}]},"total":1}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1940001","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1940002","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1940003","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1940004","message":"No contact was found."}}}}}}},"/fsi-insurance-integrations/policies/{id}/metadata":{"get":{"tags":["FSI Insurance Integrations"],"description":"Get policy metadata from a policy","security":[{"GA":["fsi-insurance-integrations-policies:read"]}],"parameters":[{"name":"id","in":"path","description":"The policy number","required":true,"schema":{"type":"string","minLength":0,"maxLength":2147483647}},{"name":"loss_date","in":"query","schema":{"type":"string","format":"date-time"}},{"name":"product","in":"query","schema":{"type":"string","minLength":0,"maxLength":2147483647}}],"responses":{"200":{"description":"Policy metadata response","content":{"application/json":{"schema":{"type":"object","required":["locations","contacts"],"properties":{"id":{"type":"string","description":"The ID of the policy metadata"},"locations":{"type":"array","description":"The locations of the policy metadata","items":{"type":"object","description":"Offset based pagination for locations","required":["_embedded","total"],"properties":{"_embedded":{"type":"object","required":["locations"],"properties":{"locations":{"description":"List of locations","type":"array","items":{"type":"object","required":["address_line_1","country","city","state","zip_code"],"properties":{"address_line_1":{"type":"string","description":"The first address line of the location"},"address_line_2":{"type":"string","description":"The second address line of the location"},"address_line_3":{"type":"string","description":"The third address line of the location"},"city":{"type":"string","description":"The city where the location is situated"},"country":{"type":"string","description":"The country code where the location is situated"},"country_name":{"type":"string","description":"The country name where the location is situated"},"location_description":{"type":"string","description":"The location's description"},"name":{"type":"string","description":"The location's display name"},"state":{"type":"string","description":"The state code where the location is situated"},"state_name":{"type":"string","description":"The state name where the location is situated"},"zip_code":{"type":"string","description":"The zip code of the location"}}}}}},"total":{"type":"integer","description":"Total number of locations","minimum":0,"default":0},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}}}}}}},"contacts":{"type":"array","description":"The contacts of the policy metadata","items":{"type":"object","required":["primary_address"],"properties":{"contact_roles":{"type":"array","description":"contact's role","items":{"type":"object","properties":{"role":{"type":"string","description":"The role"},"role_name":{"type":"string","description":"The role name"}}}},"date_of_birth":{"type":"string","description":"contact's date of birth","format":"date-time"},"email_address":{"type":"string","description":"contact's email address"},"first_name":{"type":"string","description":"contact's first name"},"gender":{"type":"string","description":"contact's gender"},"last_name":{"type":"string","description":"contact's last name"},"license_number":{"type":"string","description":"contact's license number"},"license_state":{"type":"string","description":"contact's license state"},"marital_status":{"type":"string","description":"contact's marital status"},"primary_address":{"type":"object","required":["address_line_1","country","city","state","zip_code"],"properties":{"address_line_1":{"type":"string","description":"The first address line of the location"},"address_line_2":{"type":"string","description":"The second address line of the location"},"address_line_3":{"type":"string","description":"The third address line of the location"},"city":{"type":"string","description":"The city where the location is situated"},"country":{"type":"string","description":"The country code where the location is situated"},"country_name":{"type":"string","description":"The country name where the location is situated"},"location_description":{"type":"string","description":"The location's description"},"name":{"type":"string","description":"The location's display name"},"state":{"type":"string","description":"The state code where the location is situated"},"state_name":{"type":"string","description":"The state name where the location is situated"},"zip_code":{"type":"string","description":"The zip code of the location"}}},"primary_phone_number":{"type":"string","description":"contact's primary phone number"},"ssn":{"type":"string","description":"contact's social security number"}}}},"vehicles":{"type":"array","description":"The vehicles of the policy metadata","items":{"type":"object","required":["make","model","year"],"properties":{"color":{"type":"string","description":"The color of the vehicle"},"vin":{"type":"string","description":"The vin of the vehicle"},"make":{"type":"string","description":"The vehicle's make"},"model":{"type":"string","description":"The vehicle's model"},"license_plate":{"type":"string","description":"The vehicle's license plate"},"license_state":{"type":"string","description":"The vehicle's license state"},"serial_number":{"type":"string","description":"The vehicle's serial number (only used in specific cases)"},"year":{"type":"integer","description":"The year when the vehicle was built"}}}},"policy_locations":{"type":"array","description":"The policy locations metadata","items":{"type":"object","required":["address"],"properties":{"address":{"type":"object","required":["address_line_1","country","city","state","zip_code"],"properties":{"address_line_1":{"type":"string","description":"The first address line of the location"},"address_line_2":{"type":"string","description":"The second address line of the location"},"address_line_3":{"type":"string","description":"The third address line of the location"},"city":{"type":"string","description":"The city where the location is situated"},"country":{"type":"string","description":"The country code where the location is situated"},"country_name":{"type":"string","description":"The country name where the location is situated"},"location_description":{"type":"string","description":"The location's description"},"name":{"type":"string","description":"The location's display name"},"state":{"type":"string","description":"The state code where the location is situated"},"state_name":{"type":"string","description":"The state name where the location is situated"},"zip_code":{"type":"string","description":"The zip code of the location"}}}}}},"dwelling_coverage_limit":{"type":"string","description":"The dwelling coverage limit"},"other_structures_coverage_limit":{"type":"string","description":"Other structures coverage limit"},"personal_property_coverage_limit":{"type":"string","description":"The personal property coverage limit"},"living_expenses_coverage_limit":{"type":"string","description":"Living expenses coverage limit"},"custom_fields":{"description":"Custom fields associated with the entity.","type":"array","items":{"type":"object","required":["key"],"properties":{"key":{"type":"string","description":"custom field name","minLength":0,"maxLength":255},"value":{"type":"object","description":"custom field value"}}}}}},"example":{"locations":[{"address_line_1":"The non-existing street","address_line_2":"No. 1","address_line_3":"Buildings block","city":"Miami","country":"US","country_name":"United States","location_description":"This location is an example","name":"The non-existing street, No. 1, Miami, 1234-567","state":"FL","state_name":"Florida","zip_code":"1234-567"}],"contacts":[{"contact_roles":[{"role":"Some role"}],"date_of_birth":"1970-01-01T00:00:00.000Z","email_address":"example@talkdesk.com","first_name":"John","gender":"Male","last_name":"Doe","license_number":"Some license number","marital_status":"Single","primary_address":{"address_line_1":"The non-existing street","address_line_2":"No. 1","address_line_3":"Buildings block","city":"Miami","country":"US","country_name":"United States","location_description":"This location is an example","name":"The non-existing street, No. 1, Miami, 1234-567","state":"FL","state_name":"Florida","zip_code":"1234-567"},"ssn":"some social security number"}],"vehicles":[{"vin":"JN6MD06S2BW031939","make":"Nissan","model":"Pickup","license_plate":"031939","license_state":"Nevad","year":1970,"color":"black"}],"policy_locations":[{"primary_address":{"address_line_1":"The non-existing street","address_line_2":"No. 1","address_line_3":"Buildings block","city":"Miami","country":"US","country_name":"United States","location_description":"This location is an example","name":"The non-existing street, No. 1, Miami, 1234-567","state":"FL","state_name":"Florida","zip_code":"1234-567"}}],"dwelling_coverage_limit":"$75,000.00","other_structures_coverage_limit":"$10,000.00","personal_property_coverage_limit":"$50,000.00","living_expenses_coverage_limit":"$5,000.00","custom_fields":[{"key":"policies_period_custom_fields","value":"000000"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1940001","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1940002","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1940003","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1940004","message":"No contact was found."}}}}}}},"/fsi-insurance-integrations/claims":{"post":{"tags":["FSI Insurance Integrations"],"description":"Create a new claim through FNOL","security":[{"GA":["fsi-insurance-integrations-claims:write"]}],"requestBody":{"required":true,"description":"FNOL request","content":{"application/json":{"schema":{"type":"object","required":["policy","reporter","primary_contact","general_information"],"properties":{"policy":{"description":"claim policy","type":"object","required":["number","type"],"properties":{"number":{"type":"string","description":"claim policy number","minLength":1,"maxLength":22},"type":{"type":"string","description":"claim policy type","minLength":1,"maxLength":100}}},"reporter":{"description":"claim reporter","type":"object","required":["first_name","last_name","relation_to_insured","primary_address"],"properties":{"relation_to_insured":{"type":"string","description":"claim reporter relation to insured","minLength":1,"maxLength":100},"first_name":{"type":"string","description":"claim reporter first name","minLength":1,"maxLength":100},"last_name":{"type":"string","description":"claim reporter last name","minLength":1,"maxLength":100},"primary_phone_number":{"type":"string","description":"claim reporter phone","minLength":1,"maxLength":22},"primary_address":{"description":"claim reporter address","type":"object","required":["address_line1","country","state","city","zip_code"],"properties":{"address_line1":{"type":"string","description":"claim reporter address line 1","minLength":1,"maxLength":500},"address_line2":{"type":"string","description":"claim reporter address line 2","minLength":1,"maxLength":500},"country":{"type":"string","description":"claim reporter address country","minLength":1,"maxLength":100},"state":{"type":"string","description":"claim reporter address state","minLength":1,"maxLength":100},"city":{"type":"string","description":"claim reporter address city","minLength":1,"maxLength":100},"zip_code":{"type":"string","description":"claim reporter address zip code","minLength":1,"maxLength":22},"location_description":{"type":"string","description":"claim reporter address location description","minLength":1,"maxLength":2000}}}}},"primary_contact":{"description":"claim primary contact","type":"object","required":["same_as_reporter"],"properties":{"same_as_reporter":{"type":"boolean","description":"claim primary contact same as reporter"},"relation_to_insured":{"type":"string","description":"claim primary contact relation to insured","minLength":1,"maxLength":100},"first_name":{"type":"string","description":"claim primary contact first name","minLength":1,"maxLength":100},"last_name":{"type":"string","description":"claim primary contact last name","minLength":1,"maxLength":100},"primary_phone_number":{"type":"string","description":"claim primary contact phone","minLength":1,"maxLength":22},"primary_address":{"description":"claim primary contact address","type":"object","required":["address_line1","country","state","city","zip_code"],"properties":{"address_line1":{"type":"string","description":"Address line 1","minLength":1,"maxLength":500},"address_line2":{"type":"string","description":"Address line 2","minLength":1,"maxLength":500},"country":{"type":"string","description":"Address country","minLength":1,"maxLength":100},"state":{"type":"string","description":"Address state","minLength":1,"maxLength":100},"city":{"type":"string","description":"Address city","minLength":1,"maxLength":100},"zip_code":{"type":"string","description":"Address zip code","minLength":1,"maxLength":100},"location_description":{"type":"string","description":"Address location description","minLength":1,"maxLength":2000}}}}},"general_information":{"description":"claim general information","type":"object","required":["product","loss_type"],"properties":{"product":{"type":"string","description":"claim general information product","minLength":1,"maxLength":100},"loss_type":{"type":"string","description":"claim general information loss type","minLength":1,"maxLength":100},"description":{"type":"string","description":"claim general information description","minLength":1,"maxLength":2000}}},"loss_details":{"description":"claim loss details","type":"object","required":["loss_date","loss_cause","fault_rating","notice_date","address_line1","country","state","city","zip_code"],"properties":{"loss_date":{"type":"string","description":"claim loss date","minLength":1,"maxLength":100},"loss_cause":{"type":"string","description":"claim loss cause","minLength":1,"maxLength":100},"fault_rating":{"type":"string","description":"claim fault ration","minLength":1,"maxLength":100},"notice_date":{"type":"string","description":"claim notice date","minLength":1,"maxLength":100},"incident_only":{"type":"boolean","description":"claim is incident only"},"address_line1":{"type":"string","description":"claim location address line 1","minLength":1,"maxLength":500},"address_line2":{"type":"string","description":"claim location address line 2","minLength":1,"maxLength":500},"country":{"type":"string","description":"claim location country","minLength":1,"maxLength":100},"state":{"type":"string","description":"claim location state","minLength":1,"maxLength":100},"city":{"type":"string","description":"claim location city","minLength":1,"maxLength":100},"zip_code":{"type":"string","description":"claim location zip code","minLength":1,"maxLength":22},"description":{"type":"string","description":"claim location description","minLength":1,"maxLength":2000}}},"vehicle_incidents":{"description":"vehicle incidents","type":"array","items":{"type":"object","required":["damage_details","driver_information","vehicle_information"],"properties":{"damage_details":{"description":"vehicle incident damage details","type":"object","required":["loss_occurred"],"properties":{"description":{"type":"string","description":"vehicle incident damage description","minLength":1,"maxLength":2000},"parked":{"type":"boolean","description":"vehicle was parked"},"loss_occurred":{"type":"string","description":"loss occurred","minLength":1,"maxLength":100},"second_description":{"type":"string","description":"vehicle incident second description","minLength":1,"maxLength":2000},"airbags_deployed":{"type":"boolean","description":"vehicle airbags deployed"},"equipment_failure":{"type":"boolean","description":"vehicle equipment failure"},"operable":{"type":"boolean","description":"vehicle is operable"},"total_loss":{"type":"boolean","description":"vehicle total loss"},"loss_estimate":{"type":"string","description":"vehicle loss estimate","minLength":1,"maxLength":100},"collision":{"type":"boolean","description":"vehicle collision"},"stolen":{"type":"boolean","description":"vehicle was stolen"}}},"driver_information":{"description":"vehicle incident driver information","type":"object","required":["first_name","last_name","primary_address"],"properties":{"first_name":{"type":"string","description":"driver first name","minLength":1,"maxLength":100},"last_name":{"type":"string","description":"driver last name","minLength":1,"maxLength":100},"reason":{"type":"string","description":"driver reason to use vehicle","minLength":1,"maxLength":500},"relation":{"type":"string","description":"driver relation to insured","minLength":1,"maxLength":100},"owner":{"type":"object","properties":{"first_name":{"type":"string","description":"vehicle owner first name","minLength":1,"maxLength":100},"last_name":{"type":"string","description":"vehicle owner last name","minLength":1,"maxLength":100}}},"permission":{"type":"boolean","description":"driver has owner permission"},"primary_phone_number":{"type":"string","description":"driver phone","minLength":1,"maxLength":22},"primary_address":{"description":"driver address","type":"object","required":["address_line1","country","state","city","zip_code"],"properties":{"address_line1":{"type":"string","description":"driver address line 1","minLength":1,"maxLength":500},"address_line2":{"type":"string","description":"driver address line 2","minLength":1,"maxLength":500},"country":{"type":"string","description":"driver address country","minLength":1,"maxLength":100},"state":{"type":"string","description":"driver address state","minLength":1,"maxLength":100},"city":{"type":"string","description":"driver address city","minLength":1,"maxLength":100},"zip_code":{"type":"string","description":"driver address zip code","minLength":1,"maxLength":100}}},"license_number":{"type":"string","description":"driver license number","minLength":1,"maxLength":100},"license_state":{"type":"string","description":"driver license state","minLength":1,"maxLength":100},"loan":{"type":"boolean","description":"vehicle loan"},"monthly_payment":{"type":"string","description":"loan monthly payment","minLength":1,"maxLength":100},"months_remaining":{"type":"string","description":"loan months remaining","minLength":1,"maxLength":100},"payoff_remaining":{"type":"string","description":"loan payoff remaining","minLength":1,"maxLength":100},"citations":{"description":"vehicle incident citations","type":"array","items":{"type":"object","properties":{"number":{"type":"string","description":"vehicle incident citation number","minLength":1,"maxLength":100},"authority":{"type":"string","description":"vehicle incident citation authority","minLength":1,"maxLength":100},"type":{"type":"string","description":"vehicle incident citation authority","minLength":1,"maxLength":100}}}},"associated_contacts":{"description":"vehicle incident associated contacts","type":"array","items":{"type":"object","properties":{"contact":{"type":"string","description":"vehicle incident associated contact name","minLength":1,"maxLength":100},"active":{"type":"boolean","description":"vehicle incident associated contact role is active"},"role":{"type":"string","description":"vehicle incident associated contact role","minLength":1,"maxLength":100},"comments":{"type":"string","description":"vehicle incident associated contact role comments","minLength":1,"maxLength":100}}}},"services":{"description":"vehicle incident services","type":"object","properties":{"appraisal":{"type":"boolean","description":"vehicle appraisal"},"rental":{"type":"boolean","description":"vehicle rental"},"other":{"type":"boolean","description":"vehicle other service"}}},"vehicle_information":{"description":"vehicle incident information","type":"object","required":["year","make","model"],"properties":{"year":{"type":"string","description":"vehicle year","minLength":1,"maxLength":100},"make":{"type":"string","description":"vehicle make","minLength":1,"maxLength":100},"model":{"type":"string","description":"vehicle model","minLength":1,"maxLength":100},"color":{"type":"string","description":"vehicle color","minLength":1,"maxLength":100},"style":{"type":"string","description":"vehicle style","minLength":1,"maxLength":100},"vin":{"type":"string","description":"vehicle vin","minLength":1,"maxLength":100},"license_state":{"type":"string","description":"vehicle license state","minLength":1,"maxLength":100},"license_plate":{"type":"string","description":"vehicle license plate","minLength":1,"maxLength":100},"vehicle_type":{"type":"string","description":"vehicle type","minLength":1,"maxLength":100},"loss_party":{"type":"string","description":"vehicle loss party","minLength":1,"maxLength":100}}}}}}}},"notes":{"description":"claim notes","type":"array","items":{"type":"object","properties":{"subject":{"type":"string","description":"note subject","minLength":1,"maxLength":100},"description":{"type":"string","description":"some description about note subject","minLength":1,"maxLength":2000}}}},"custom_fields":{"description":"Custom fields associated with the entity.","type":"array","items":{"type":"object","required":["key"],"properties":{"key":{"type":"string","description":"custom field name","minLength":0,"maxLength":255},"value":{"type":"object","description":"custom field value"}}}}}},"example":{"policy":{"number":"54-123456","type":"PersonalAuto"},"reporter":{"relation_to_insured":"self","first_name":"Jake","last_name":"Peralta","primary_phone_number":"000-00-000177","primary_address":{"address_line1":"Some address","address_line2":"address line 2","country":"US","state":"CO","city":"city","zip_code":123456}},"primary_contact":{"same_as_reporter":false,"first_name":"John","last_name":"Smith","relation_to_insured":"self","primary_phone_number":"000-00-000177","primary_address":{"address_line1":"Some address","address_line2":"address line 2","country":"US","state":"AK","city":"city","zip_code":123456}},"general_information":{"product":"PersonalAuto","loss_type":"AUTO","description":"general description"},"loss_details":{"loss_date":"2022-10-08T00:00:00.000Z","loss_cause":"leftcollision","fault_rating":1,"notice_date":"2022-10-08T00:00:00.000Z","incident_only":false,"address_line1":"Some address","address_line2":"address line 2","country":"US","state":"AK","city":"city","zip_code":987654,"description":"loss details location description"},"vehicle_incidents":{"damage_details":{"description":"damage details description","parked":false,"loss_occurred":"InTransit","second_description":"damage details 2nd description","airbags_deployed":true,"equipment_failure":false,"operable":false,"total_loss":false,"loss_estimate":900,"collision":true,"stolen":false},"driver_information":{"first_name":"John","last_name":"Smith","reason":"pleasure","relation":"relative","permission":true,"primary_phone_number":"000-00-000177","primary_address":{"address_line1":"Some address","address_line2":"address line 2","country":"US","state":"CO","city":"city","zip_code":654789},"license_number":"PT123456789","license_state":"AR","loan":true,"monthly_payment":200,"months_remaining":10,"payoff_remaining":2000,"citations":{"number":"citation 1","authority":"auth1","type":"other"},"associated_contacts":{"contact":"contact name","active":true,"role":"other","comments":"comments"},"services":{"appraisal":true,"rental":true,"other":true}},"vehicle_information":{"year":1999,"make":"Pontiac","model":"G6","color":"color","style":"passengercar","vin":"1G2ZF58B974179896","license_state":"TX","license_plate":79896,"vehicle":0,"vehicle_type":"listed","loss_party":"insured"}},"notes":{"subject":"Driver injuried","description":"The driver sufferes a small cut in his left hand"},"custom_fields":[{"key":"fnol_custom_fields","value":"000000"}]}}}},"responses":{"200":{"description":"Claim created response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the created claim"},"claim_number":{"type":"string","description":"New claim number"}}},"example":{"claim_number":"123-45-678900"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1940001","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1940002","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1940003","message":"Required scopes are missing."}}}}}}},"/fsi-insurance-integrations/account-holders/{id}/billing":{"get":{"tags":["FSI Insurance Integrations"],"description":"Get billing by account holder member id","security":[{"GA":["fsi-insurance-integrations-billing:read"]}],"parameters":[{"name":"id","in":"path","description":"The account holder member id","required":true,"schema":{"type":"string","minLength":0,"maxLength":2147483647}}],"responses":{"200":{"description":"Billing information response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID of the billing","minLength":1,"maxLength":100},"max_policy_period_end_date":{"type":"string","format":"date-time","description":"The end date of the policy period which end date is furthest into the future.","minLength":1,"maxLength":35},"next_invoice_due":{"type":"string","format":"date-time","description":"The date of the next invoice.","minLength":1,"maxLength":35},"next_invoice_due_amount":{"type":"string","description":"The amount of the next invoice.","minLength":1,"maxLength":22},"next_invoice_number":{"type":"string","description":"The number of the next invoice.","minLength":1,"maxLength":100},"total_paid":{"type":"string","description":"The total amount paid.","minLength":1,"maxLength":22},"total_unbilled":{"type":"string","description":"The total amount unbilled.","minLength":1,"maxLength":22},"total_currently_billed":{"type":"string","description":"The amount currently already billed.","minLength":1,"maxLength":22},"total_past_due":{"type":"string","description":"The total past due.","minLength":1,"maxLength":22},"total_outstanding":{"type":"string","description":"The total oustanding of the account.","minLength":1,"maxLength":22},"delinquencies":{"type":"string","description":"The number of recent delinquencies","minLength":1,"maxLength":100},"total_billed_invoices":{"type":"string","description":"The number of billed invoices","minLength":1,"maxLength":22},"total_outstanding_invoices":{"type":"string","description":"The number of outstanding invoices","minLength":1,"maxLength":22},"total_unapplied":{"type":"string","description":"The number of unapplied","minLength":1,"maxLength":22},"custom_fields":{"description":"Custom fields associated with the entity.","type":"array","items":{"type":"object","required":["key"],"properties":{"key":{"type":"string","description":"custom field name","minLength":0,"maxLength":255},"value":{"type":"object","description":"custom field value"}}}}}},"example":{"max_policy_period_end_date":"2025-08-11T00:00:00.000Z","next_invoice_due":"2023-05-22T00:00:00.000Z","next_invoice_due_amount":20000,"next_invoice_number":1000000000,"total_paid":100,"total_unbilled":1000,"total_currently_billed":0,"total_past_due":0,"total_outstanding":0,"delinquencies":"0 in 12 months","total_billed_invoices":0,"total_outstanding_invoices":0,"total_unapplied":0,"custom_fields":[{"key":"claim_custom_fields","value":"000000"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1940001","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1940002","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1940003","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1940004","message":"No contact was found."}}}}}}},"/fsi-insurance-integrations/account-holders/{id}/billing/details":{"get":{"tags":["FSI Insurance Integrations"],"description":"Get billing details by account holder member id","security":[{"GA":["fsi-insurance-integrations-billing:read"]}],"parameters":[{"name":"id","in":"path","description":"The account holder member id","required":true,"schema":{"type":"string","minLength":0,"maxLength":2147483647}}],"responses":{"200":{"description":"Billing information response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID of the billing details","minLength":1,"maxLength":100},"account_number":{"type":"string","description":"The account number.","minLength":1,"maxLength":100},"account_since":{"type":"string","format":"date","description":"The date when the account was opened.","minLength":1,"maxLength":100},"active_policies":{"type":"string","description":"The number of active policies.","minLength":1,"maxLength":22},"billing_period":{"type":"string","format":"date","description":"The end date of the billing period.","minLength":1,"maxLength":100},"payor":{"type":"string","description":"The payer identification.","minLength":1,"maxLength":100},"send_invoices_by":{"type":"string","description":"The method by which the invoices she be sent in.","minLength":1,"maxLength":100},"billing_address":{"type":"string","description":"The billing address associated to the account.","minLength":1,"maxLength":500},"payment_instrument":{"type":"string","description":"The method that is used to pay.","minLength":1,"maxLength":100},"custom_fields":{"description":"Custom fields associated with the entity.","type":"array","items":{"type":"object","required":["key"],"properties":{"key":{"type":"string","description":"custom field name","minLength":0,"maxLength":255},"value":{"type":"object","description":"custom field value"}}}}}},"example":{"account_number":"C000143542","account_since":"2023-05-22T00:00:00.000Z","active_policies":1,"billing_period":"2025-08-11T00:00:00.000Z","payor":"C000143542","send_invoices_by":"Email","billing_address":"10 Main Street, San Mateo, CA 94403","payment_instrument":"Responsive","custom_fields":[{"key":"claim_custom_fields","value":"000000"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1940001","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1940002","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1940003","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1940004","message":"No contact was found."}}}}}}},"/fsi-insurance-integrations/accounts/{account_number}/claims":{"get":{"tags":["FSI Insurance Integrations"],"description":"Search claims related to account holders (contacts)","security":[{"GA":["fsi-insurance-integrations-claims:read"]}],"parameters":[{"name":"skip","in":"query","description":"Number of elements to skip","schema":{"type":"integer","minimum":0,"default":0,"maximum":2147483647}},{"name":"limit","in":"query","description":"Limit of elements to be fetched","schema":{"type":"integer","minimum":1,"maximum":500,"default":20}},{"name":"account_number","in":"path","description":"The account number in external system","required":true,"schema":{"type":"string","minLength":1,"maxLength":40}}],"responses":{"200":{"description":"Claims response","content":{"application/json":{"schema":{"type":"object","description":"Offset based pagination for claims","required":["_embedded","total"],"properties":{"_embedded":{"type":"object","required":["claims"],"properties":{"claims":{"description":"List of claims","type":"array","items":{"type":"object","required":["claim_number","product","policy_number","claim_status"],"properties":{"id":{"type":"string","description":"The ID number that uniquely identifies the claim within the Insurance company system","minLength":1,"maxLength":100},"claim_number":{"type":"string","description":"The ID number that uniquely identifies the claim within the Insurance company system","minLength":1,"maxLength":100},"product":{"type":"string","description":"Product","minLength":1,"maxLength":100},"policy_number":{"type":"string","description":"Policy Number","minLength":1,"maxLength":22},"claim_status":{"type":"string","description":"Claim's Status","minLength":1,"maxLength":100},"assigned_user":{"type":"string","description":"Assigned User","minLength":1,"maxLength":100},"description":{"type":"string","description":"Claim Description","minLength":1,"maxLength":2000},"loss_date":{"type":"string","description":"Claim Loss Date","minLength":1,"maxLength":100},"reported_date":{"type":"string","description":"Claim Reported Date","minLength":1,"maxLength":100},"custom_fields":{"description":"Custom fields associated with the entity.","type":"array","items":{"type":"object","required":["key"],"properties":{"key":{"type":"string","description":"custom field name","minLength":0,"maxLength":255},"value":{"type":"object","description":"custom field value"}}}},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}}}}}}}}},"total":{"type":"integer","description":"Total number of claims","minimum":0,"default":0},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}}}}}},"example":{"_embedded":{"claims":[{"claim_number":"number_id_1","product":"product_name","policy_number":"123-4567-8910","claim_status":"closed","custom_fields":[{"key":"claim_custom_fields","value":"000000"}]}]},"total":1}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1940001","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1940002","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1940003","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1940004","message":"No contact was found."}}}}}}},"/fsi-insurance-integrations/claims/{id}":{"get":{"tags":["FSI Insurance Integrations"],"description":"Get claim by id","security":[{"GA":["fsi-insurance-integrations-claims:read"]}],"parameters":[{"name":"id","in":"path","description":"The claim id","required":true,"schema":{"type":"string","minLength":0,"maxLength":2147483647}}],"responses":{"200":{"description":"Claim response","content":{"application/json":{"schema":{"type":"object","required":["claim_number","policy_number"],"properties":{"id":{"type":"string","description":"The ID number that uniquely identifies the claim within the Insurance company system","minLength":1,"maxLength":100},"claim_number":{"type":"string","description":"The ID number that uniquely identifies the claim within the Insurance company system","minLength":1,"maxLength":100},"claim_status":{"type":"string","description":"Claim's Status","minLength":1,"maxLength":100},"description":{"type":"string","description":"Loss description","minLength":1,"maxLength":2000},"exposures":{"type":"array","items":{"type":"object","description":"Offset based pagination for claim exposures","required":["_embedded","total"],"properties":{"_embedded":{"type":"object","required":["exposures"],"properties":{"exposures":{"description":"List of claim exposures","type":"array","items":{"type":"object","required":["adjuster","claimant","coverage","exposure_type","paid","recoveries"],"properties":{"claimant":{"type":"string","description":"Claimant","minLength":1,"maxLength":100},"adjuster":{"type":"string","description":"Adjuster","minLength":1,"maxLength":100},"coverage":{"type":"string","description":"Coverage of the exposure","minLength":1,"maxLength":100},"exposure_type":{"type":"string","description":"Type of the exposure","minLength":1,"maxLength":100},"paid":{"type":"string","description":"Paid Amount","minLength":1,"maxLength":100},"recoveries":{"type":"string","description":"Recoveries","minLength":1,"maxLength":100},"vehicle_details":{"type":"object","required":["driver_name","make","model","plate","relationship_to_insured"],"properties":{"driver_name":{"type":"string","description":"Driver name.","minLength":1,"maxLength":100},"make":{"type":"string","description":"vehicle's make","minLength":1,"maxLength":100},"model":{"type":"string","description":"vehicle's model","minLength":1,"maxLength":100},"plate":{"type":"string","description":"vehicle's plate","minLength":1,"maxLength":100},"relationship_to_insured":{"type":"string","description":"Driver relationship to insured.","minLength":1,"maxLength":100}}}}}}}},"total":{"type":"integer","description":"Total number of claim exposures","minimum":0,"default":0},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}}}}}}},"loss_cause":{"type":"string","description":"Cause of loss","minLength":1,"maxLength":100},"loss_date":{"type":"string","description":"Date of Loss","minLength":1,"maxLength":100},"loss_estimate":{"type":"string","description":"Loss estimated amount","format":"date","minLength":1,"maxLength":100},"loss_location":{"type":"string","description":"Loss location","minLength":1,"maxLength":500},"paid":{"type":"string","description":"Paid Amount","minLength":1,"maxLength":100},"policy_number":{"type":"string","description":"Policy Number","minLength":1,"maxLength":22},"product":{"type":"string","description":"Product","minLength":1,"maxLength":100},"recovered":{"type":"string","description":"Recovered Amount","minLength":1,"maxLength":100},"report_date":{"type":"string","description":"Date of reporting","format":"date","minLength":1,"maxLength":100},"custom_fields":{"description":"Custom fields associated with the entity.","type":"array","items":{"type":"object","required":["key"],"properties":{"key":{"type":"string","description":"custom field name","minLength":0,"maxLength":255},"value":{"type":"object","description":"custom field value"}}}},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}}}}}},"example":{"claim_number":"number_id_1","claim_status":"closed","description":"Loss description","exposures":[{"_embedded":{"exposures":[{"exposure_type":"Vehicle","coverage":"Collision","claimant":"Amy Smith","adjuster":"Frank Clark","paid":"1500.00","recoveries":"1000.00","vehicle_details":{"driver_name":"John Smith","make":"Nissan","model":"Pickup","plate":"031939","relationship_to_insured":"Friend"}}]},"total":1}],"loss_cause":"Collision with vehicle","loss_date":"2020-10-01","loss_estimate":"95","loss_location":"Loss location","paid_amount":"90","policy_number":"123-4567-8910","product":"product_name","recovered_amount":"3","report_date":"2020-10-02","custom_fields":[{"key":"claim_custom_fields","value":"000000"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1940001","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1940002","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1940003","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1940004","message":"No contact was found."}}}}}}},"/fsi-insurance-integrations/contacts/{id}":{"patch":{"tags":["FSI Insurance Integrations"],"description":"Update contact details for an account holder such as phone number, address or email","security":[{"GA":["fsi-insurance-integrations-contacts:write"]}],"parameters":[{"name":"id","in":"path","description":"Contact id","required":true,"schema":{"type":"string","minLength":1,"maxLength":20}}],"requestBody":{"required":true,"description":"Update contact request","content":{"application/json":{"schema":{"type":"object","properties":{"phone_number":{"type":"string","description":"contact phone number","minLength":1,"maxLength":22},"email":{"type":"string","description":"contact email address","minLength":1,"maxLength":100,"format":"email"},"address":{"description":"contact address","type":"object","properties":{"address_line1":{"type":"string","description":"contact address line 1","minLength":1,"maxLength":500},"address_line2":{"type":"string","description":"contact address line 2","minLength":1,"maxLength":500},"country":{"type":"string","description":"contact address country","minLength":1,"maxLength":100},"state":{"type":"string","description":"contact address state","minLength":1,"maxLength":100},"city":{"type":"string","description":"contact address city","minLength":1,"maxLength":100},"zip_code":{"type":"string","description":"contact address zip code","minLength":1,"maxLength":22},"location_description":{"type":"string","description":"contact address location description","minLength":1,"maxLength":2000}}}}},"example":{"phone_number":6591234567,"address":{"address_line1":"Some address","address_line2":"address line 2","country":"US","state":"AK","city":"city","zip_code":123456},"email":"new.email@example.com"}}}},"responses":{"200":{"description":"Update contact response","content":{"application/json":{"schema":{"type":"object","required":["id","updated_at"],"properties":{"id":{"type":"string","description":"The ID of the contact","minLength":1,"maxLength":100},"phone_number":{"type":"string","description":"contact phone","minLength":1,"maxLength":22},"email":{"type":"string","description":"contact email","minLength":1,"maxLength":100,"format":"email"},"address":{"description":"contact address","type":"object","properties":{"address_line1":{"type":"string","description":"contact address line 1","minLength":1,"maxLength":500},"address_line2":{"type":"string","description":"contact address line 2","minLength":1,"maxLength":500},"country":{"type":"string","description":"contact address country","minLength":1,"maxLength":100},"state":{"type":"string","description":"contact address state","minLength":1,"maxLength":100},"city":{"type":"string","description":"contact address city","minLength":1,"maxLength":100},"zip_code":{"type":"string","description":"contact address zip code","minLength":1,"maxLength":22},"location_description":{"type":"string","description":"contact address location description","minLength":1,"maxLength":2000}}},"updated_at":{"type":"string","description":"update contact date time","minLength":1,"maxLength":100}}},"example":{"id":12345678900,"phone_number":6591234567,"address":{"address_line1":"Some address","address_line2":"address line 2","country":"US","state":"AK","city":"city","zip_code":123456},"email":"new.email@example.com","updated_at":"2025-12-11T00:00:00.000Z"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1940001","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1940002","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1940003","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1940004","message":"No contact was found."}}}}}}},"/fsi-insurance-integrations/document-deliveries":{"post":{"tags":["FSI Insurance Integrations"],"description":"send document delivery by sms and email","security":[{"GA":["fsi-insurance-integrations-send-docs:read"]}],"requestBody":{"required":true,"description":"Document delivery request","content":{"application/json":{"schema":{"type":"object","required":["channel","address","document_type"],"properties":{"policy_number":{"type":"string","description":"Policy number","minLength":1,"maxLength":100},"channel":{"type":"string","description":"Delivery channel (EMAIL/SMS)","enum":["EMAIL","SMS"]},"address":{"type":"string","description":"Delivery target (email address or phone number)","minLength":1,"maxLength":100},"document_type":{"type":"string","description":"Type of document to deliver (MY_ID_CARD/PROOF_OF_COVERAGE)","enum":["MY_ID_CARD","PROOF_OF_COVERAGE"]}}},"example":{"policy_number":"1234567890","channel":"EMAIL","address":"user@example.com","document_type":"MY_ID_CARD"}}}},"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1940001","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1940002","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1940003","message":"Required scopes are missing."}}}}}}},"/fsi-insurance-connections/claims/{id}":{"get":{"tags":["FSI Insurance Connections"],"description":"Get claim by id","security":[{"GA":["fsi-insurance-connections-claims:read"]}],"parameters":[{"name":"id","in":"path","description":"The claim id","required":true,"schema":{"type":"string","minLength":0,"maxLength":2147483647}}],"responses":{"200":{"description":"Claim response","content":{"application/json":{"schema":{"type":"object","required":["claim_number","policy_number"],"properties":{"id":{"type":"string","description":"id"},"claim_number":{"type":"string","description":"The ID number that uniquely identifies the claim within the Insurance company system"},"claim_status":{"type":"string","description":"Claim's Status"},"description":{"type":"string","description":"Loss description"},"exposures":{"type":"array","items":{"type":"object","description":"Offset based pagination for claim exposures","required":["_embedded","total"],"properties":{"_embedded":{"type":"object","required":["exposures"],"properties":{"exposures":{"description":"List of claim exposures","type":"array","items":{"type":"object","required":["adjuster","claimant","coverage","exposure_type","paid","recoveries"],"properties":{"claimant":{"type":"string","description":"Claimant"},"adjuster":{"type":"string","description":"Adjuster"},"coverage":{"type":"string","description":"Coverage of the exposure"},"exposure_type":{"type":"string","description":"Type of the exposure"},"paid":{"type":"string","description":"Paid Amount"},"recoveries":{"type":"string","description":"Recoveries"},"vehicle_details":{"type":"object","required":["driver_name","make","model","plate","relationship_to_insured"],"properties":{"driver_name":{"type":"string","description":"Driver name."},"make":{"type":"string","description":"vehicle's make"},"model":{"type":"string","description":"vehicle's model"},"plate":{"type":"string","description":"vehicle's plate"},"relationship_to_insured":{"type":"string","description":"Driver relationship to insured."}}}}}}}},"total":{"type":"integer","description":"Total number of claim exposures","minimum":0,"default":0},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}}}}}}},"loss_cause":{"type":"string","description":"Cause of loss"},"loss_date":{"type":"string","description":"Date of Loss"},"loss_estimate":{"type":"string","description":"Loss estimated amount","format":"date"},"loss_location":{"type":"string","description":"Loss location"},"paid":{"type":"string","description":"Paid Amount"},"policy_number":{"type":"string","description":"Policy Number"},"product":{"type":"string","description":"Product"},"recovered":{"type":"string","description":"Recovered Amount"},"report_date":{"type":"string","description":"Date of reporting","format":"date"},"custom_fields":{"description":"Custom fields associated with the entity.","type":"array","items":{"type":"object","required":["key"],"properties":{"key":{"type":"string","description":"custom field name","minLength":0,"maxLength":255},"value":{"type":"object","description":"custom field value"}}}},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}}}}}},"example":{"id":"id_1","claim_number":"number_id_1","claim_status":"closed","description":"Loss description","exposures":[{"_embedded":{"exposures":[{"exposure_type":"Vehicle","coverage":"Collision","claimant":"Amy Smith","adjuster":"Frank Clark","paid":"1500.00","recoveries":"1000.00","vehicle_details":{"driver_name":"John Smith","make":"Nissan","model":"Pickup","plate":"031939","relationship_to_insured":"Friend"}}]},"total":1}],"loss_cause":"Collision with vehicle","loss_date":"2020-10-01","loss_estimate":"2020-10-01","loss_location":"Loss location","paid":"90","policy_number":"123-4567-8910","product":"product_name","recovered_amount":"3","report_date":"2020-10-02","custom_fields":[{"key":"claim_custom_fields","value":"000000"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1930001","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1930002","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1930003","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1930004","message":"No contact was found."}}}}}}},"/fsi-insurance-connections/policies/{policy_number}/claims":{"get":{"tags":["FSI Insurance Connections"],"description":"Search claims related to a policy","security":[{"GA":["fsi-insurance-connections-claims:read"]}],"parameters":[{"name":"policy_number","in":"path","description":"A policy number existent in the insurance external system","required":true,"schema":{"type":"string","minLength":1,"maxLength":40}},{"name":"page","in":"query","description":"Number of the requested page(Pagination is not supported yet)","schema":{"format":"int32","default":1,"minimum":1,"type":"integer","maximum":2147483647}},{"name":"per_page","in":"query","description":"Max number of the items in a page(Pagination is not supported yet)","schema":{"format":"int32","default":10,"minimum":1,"type":"integer","maximum":250}}],"responses":{"200":{"description":"Claims response","content":{"application/json":{"schema":{"type":"object","description":"Offset based pagination for claims","required":["_embedded","total"],"properties":{"_embedded":{"type":"object","required":["claims"],"properties":{"claims":{"description":"List of claims","type":"array","items":{"type":"object","required":["id","claim_number","product","policy_number","claim_status","assigned_user","loss_date","reported_date"],"properties":{"id":{"type":"string","description":"id"},"claim_number":{"type":"string","description":"The ID number that uniquely identifies the claim within the Insurance company system"},"product":{"type":"string","description":"Product"},"policy_number":{"type":"string","description":"Policy Number"},"claim_status":{"type":"string","description":"Claim's Status"},"description":{"type":"string","description":"The claim's description"},"assigned_user":{"type":"string","description":"The user assigned to the claim"},"loss_date":{"type":"string","description":"The loss date associated to the claim","format":"date-time"},"reported_date":{"type":"string","description":"The reported date of the claim","format":"date-time"},"custom_fields":{"description":"Custom fields associated with the entity.","type":"array","items":{"type":"object","required":["key"],"properties":{"key":{"type":"string","description":"custom field name","minLength":0,"maxLength":255},"value":{"type":"object","description":"custom field value"}}}},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}}}}}}}}},"total":{"type":"integer","description":"Total number of claims","minimum":0,"default":0},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}}}}}},"example":{"_embedded":{"claims":[{"id":"id_1","claim_number":"number_id_1","product":"product_name","policy_number":"123-4567-8910","claim_status":"closed","assigned_user":"assigned_user_1","loss_date":"2020-10-01T00:00:00.000Z","reported_date":"2020-10-01T00:00:00.000Z","custom_fields":[{"key":"claim_custom_fields","value":"000000"}]}]},"total":1}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1930001","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1930002","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1930003","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1930004","message":"No contact was found."}}}}}}},"/fsi-insurance-connections/accounts/{account_number}/claims":{"get":{"tags":["FSI Insurance Connections"],"description":"Search claims related to an account","security":[{"GA":["fsi-insurance-connections-claims:read"]}],"parameters":[{"name":"account_number","in":"path","description":"An account number existent in the insurance external system","required":true,"schema":{"type":"string","minLength":1,"maxLength":40}},{"name":"page","in":"query","description":"Number of the requested page(Pagination is not supported yet)","schema":{"format":"int32","default":1,"minimum":1,"type":"integer","maximum":2147483647}},{"name":"per_page","in":"query","description":"Max number of the items in a page(Pagination is not supported yet)","schema":{"format":"int32","default":10,"minimum":1,"type":"integer","maximum":250}}],"responses":{"200":{"description":"Claims response","content":{"application/json":{"schema":{"type":"object","description":"Offset based pagination for claims","required":["_embedded","total"],"properties":{"_embedded":{"type":"object","required":["claims"],"properties":{"claims":{"description":"List of claims","type":"array","items":{"type":"object","required":["id","claim_number","product","policy_number","claim_status","assigned_user","loss_date","reported_date"],"properties":{"id":{"type":"string","description":"id"},"claim_number":{"type":"string","description":"The ID number that uniquely identifies the claim within the Insurance company system"},"product":{"type":"string","description":"Product"},"policy_number":{"type":"string","description":"Policy Number"},"claim_status":{"type":"string","description":"Claim's Status"},"description":{"type":"string","description":"The claim's description"},"assigned_user":{"type":"string","description":"The user assigned to the claim"},"loss_date":{"type":"string","description":"The loss date associated to the claim","format":"date-time"},"reported_date":{"type":"string","description":"The reported date of the claim","format":"date-time"},"custom_fields":{"description":"Custom fields associated with the entity.","type":"array","items":{"type":"object","required":["key"],"properties":{"key":{"type":"string","description":"custom field name","minLength":0,"maxLength":255},"value":{"type":"object","description":"custom field value"}}}},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}}}}}}}}},"total":{"type":"integer","description":"Total number of claims","minimum":0,"default":0},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}}}}}},"example":{"_embedded":{"claims":[{"id":"id_1","claim_number":"number_id_1","product":"product_name","policy_number":"123-4567-8910","claim_status":"closed","assigned_user":"assigned_user_1","loss_date":"2020-10-01T00:00:00.000Z","reported_date":"2020-10-01T00:00:00.000Z","custom_fields":[{"key":"claim_custom_fields","value":"000000"}]}]},"total":1}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1930001","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1930002","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1930003","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1930004","message":"No contact was found."}}}}}}},"/erc/ecommerce/connections/customers/{customer_id}/orders/{order_id}/cancel":{"post":{"tags":["ERC ECommerce Connections"],"description":"Cancel a customer's order","security":[{"GA":["erc-ecommerce-connections-orders:write"]}],"parameters":[{"name":"customer_id","in":"path","required":true,"description":"The customer id","schema":{"type":"string","example":"customer123"}},{"name":"order_id","in":"path","required":true,"description":"The order id","schema":{"type":"string","example":"order123"}},{"name":"brand","in":"query","required":false,"description":"The brand of the provider you want to filter by. If the account is multi-brand, this parameter is required.\n","schema":{"type":"string","maxLength":255,"minLength":1,"example":"Brand 123"}}],"requestBody":{"description":"The order cancellation options","content":{"application/json":{"schema":{"type":"object","description":"The options for the order cancellation","properties":{"cancel_reason":{"type":"string","example":"other"}}},"example":{"cancel_reason":"other"}}}},"responses":{"200":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"3234010","message":"Invalid JWT."}},"Account not configured to use ERC E-Commerce APIs":{"value":{"code":"3234011","message":"Account not configured to use ERC E-Commerce APIs."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234030","message":"Required scopes are missing."}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234040","message":"Resource not found."}}}},"405":{"description":"Method not supported","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234050","message":"Method not allowed."}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234220","message":"Unprocessable entity"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3235000","message":"Internal Server Error."}}}},"502":{"description":"Bad Gateway","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3235020","message":"Bad Gateway."}}}}}}},"/erc/ecommerce/connections/customers/{customer_id}/orders/{order_id}/change-shipping-address":{"post":{"tags":["ERC ECommerce Connections"],"description":"Change the shipping address of a customer's order","security":[{"GA":["erc-ecommerce-connections-orders:write"]}],"parameters":[{"name":"customer_id","in":"path","required":true,"description":"The customer id","schema":{"type":"string","example":"customer123"}},{"name":"order_id","in":"path","required":true,"description":"The order id","schema":{"type":"string","example":"order123"}},{"name":"brand","in":"query","required":false,"description":"The brand of the provider you want to filter by. If the account is multi-brand, this parameter is required.\n","schema":{"type":"string","maxLength":255,"minLength":1,"example":"Brand 123"}}],"requestBody":{"description":"The new order shipping address","content":{"application/json":{"schema":{"description":"The new shipping address of the order","allOf":[{"type":"object","description":"Represents an address of a customer or order","required":["first_name","last_name","address","zip_code","city","region_code","country_code"],"properties":{"id":{"type":"string","description":"The address identifier","example":"address1234"},"first_name":{"type":"string","description":"The first name of the person associated with the address","example":"John"},"last_name":{"type":"string","description":"The last name of the person associated with the address","example":"Doe"},"phone_number":{"type":"string","description":"The phone number of the person associated with the address","example":"+351910000000"},"address":{"type":"string","description":"The first line of the address","example":"Lisbon"},"zip_code":{"type":"string","description":"The zip-code of the address","example":"20000000"},"city":{"type":"string","description":"The city of the address","example":"Lisbon"},"region_code":{"type":"string","description":"The region (country subdivision) code according to ISO 3166-2 standard","example":"PT-11"},"country_code":{"type":"string","description":"The country code of the address, according the ISO 3166-1 alpha-2 codes","example":"PT"},"default":{"type":"boolean","description":"Define if address is default","example":true}}}]},"example":{"first_name":"John","last_name":"Doe","phone_number":"+351910000000","address":"Lisbon","zip_code":"20000000","city":"Lisbon","region_code":"PT-11","country_code":"PT"}}}},"responses":{"200":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Generic Bad Request":{"value":{"code":"3234000","message":"Bad request."}},"Invalid Address":{"value":{"code":"3234001","message":"Invalid address provided","fields":[{"name":"region_code","description":"the provided region code is not valid for the country"}]}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"3234010","message":"Invalid JWT."}},"Account not configured to use ERC E-Commerce APIs":{"value":{"code":"3234011","message":"Account not configured to use ERC E-Commerce APIs."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234030","message":"Required scopes are missing."}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234040","message":"Resource not found."}}}},"405":{"description":"Method not supported","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234050","message":"Method not allowed."}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234220","message":"Unprocessable entity"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3235000","message":"Internal Server Error."}}}},"502":{"description":"Bad Gateway","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3235020","message":"Bad Gateway."}}}}}}},"/erc/ecommerce/connections/customers/{customer_id}/shipments":{"get":{"tags":["ERC ECommerce Connections"],"description":"Read the ERC e-commerce customer shipments for the provided customer id and order id.

    Integration shops
    • Customers Bridge -> Supports all parameters and responses.
    • BigCommerce -> Only Supports some parameters and responses.
    • Shopify -> Only Supports some parameters and responses.
    ","security":[{"GA":["erc-ecommerce-connections-customers:read"]}],"parameters":[{"name":"customer_id","in":"path","required":true,"description":"The unique identifier for the customer whose shipments need to be retrieved.","schema":{"type":"string","maxLength":255,"minLength":1,"example":"customer123"}},{"name":"order_id","in":"query","description":"The order id you want to query.","required":false,"schema":{"type":"string","maxLength":255,"minLength":1,"example":"order_no_1"}},{"name":"order_ids","in":"query","required":false,"description":"The order id array you want to query.","schema":{"type":"array","items":{"type":"string","description":"The id of the order array.","minLength":1,"maxLength":255,"example":"order_no_2"}}},{"name":"shipping_provider","in":"query","description":"The shipping provider of shipments you want to query.","required":false,"schema":{"type":"string","maxLength":255,"minLength":1,"example":"FedEx"}},{"name":"tracking_number","in":"query","description":"The tracking number of shipments you want to query.","required":false,"schema":{"type":"string","maxLength":255,"minLength":1,"example":"FedEx1Z99999999"}},{"name":"item_id","in":"query","description":"The item id you want to query.","required":false,"schema":{"type":"string","maxLength":255,"minLength":1,"example":"item_id_1"}},{"name":"product_id","in":"query","description":"The product id you want to query.","required":false,"schema":{"type":"string","maxLength":255,"minLength":1,"example":"Apple1"}},{"name":"delivery_id","in":"query","description":"The delivery id you want to query.","required":false,"schema":{"type":"string","maxLength":255,"minLength":1,"example":"delivery1"}},{"name":"delivery_statuses","in":"query","description":"The array of delivery statuses you want to filter by.","required":false,"schema":{"type":"array","items":{"type":"string","minLength":1,"maxLength":255,"example":"Shipped"}}},{"name":"brand","in":"query","description":"The brand of the provider you want to filter by. If the account is multi-brand, this parameter is required.\n","required":false,"schema":{"type":"string","maxLength":255,"minLength":1,"example":"Brand A"}},{"name":"limit","in":"query","description":"The amount of shipments you want to get.","required":false,"schema":{"type":"integer","example":10,"minimum":1,"maximum":100,"default":50}},{"name":"cursor","in":"query","description":"The opaque string that represents the cursor after which the 'limit' amount of shipments are retrieved.","required":false,"schema":{"type":"string","maxLength":255,"minLength":1,"default":""},"example":"eyJsYXN0X2lkIjozMDExMjM4MjUsImxhc3RfdmFsdWUiOiAiMjAyMC0wOC0zMCJ9"},{"name":"order_by","in":"query","description":"The parameter to be sorted for. Use order_by=key1:desc for descending, order_by=key1:asc for ascending.","required":false,"schema":{"type":"string","maxLength":255,"minLength":1,"example":"id:desc"}}],"responses":{"200":{"description":"The list of customer shipments found for the provided customer id.","content":{"application/json":{"schema":{"type":"object","description":"Represents the paginated list of customer shipments","required":["_embedded","_links"],"properties":{"_embedded":{"type":"object","properties":{"shipments":{"type":"array","description":"The list of shipments in the current page","items":{"type":"object","description":"Represents a shipment associated with a customer","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the shipment","example":"shipment123"},"brand":{"type":"string","description":"The brand of the provider","example":"Brand A"},"customer_id":{"type":"string","description":"The ID of the customer that created this order","example":"customer123"},"order_id":{"type":"string","description":"The ID of the order associated with the shipment","example":"order789"},"delivery_quantity":{"type":"integer","description":"The quantity of items being delivered in this shipment","example":3},"delivery_date_start":{"type":"string","description":"The start date of the delivery window","format":"date-time","example":"2025-02-21T12:16:50.078Z"},"delivery_date_end":{"type":"string","description":"The end date of the delivery window","format":"date-time","example":"2025-02-28T12:16:50.078Z"},"delivery_staff":{"type":"string","description":"The name of the staff member responsible for the delivery.","example":"Mike Daniel"},"latest_status_info":{"type":"string","description":"The latest status of the shipment","example":"Shipped"},"last_update":{"type":"string","description":"The timestamp of the latest update for the shipment. Only the ISO 8601 date-time format (e.g., '2025-02-17T12:00:00Z') is supported.","format":"date-time","example":"2025-02-17T12:00:00Z"},"created_time":{"type":"string","description":"The timestamp when the shipment was created. Only the ISO 8601 date-time format (e.g., '2025-02-17T12:00:00Z') is supported.","format":"date-time","example":"2025-01-23T12:16:50.078Z"},"description":{"type":"string","description":"A description of the shipment","example":"This shipment will be delivered by FedEx."},"shipping_provider":{"type":"string","description":"The shipping provider for the shipment","example":"FedEx"},"shipping_date":{"type":"string","description":"The date when the shipment was processed","format":"date-time","example":"2025-01-23T12:16:50.078Z"},"shipping_address":{"type":"object","description":"The shipping address for this shipment","properties":{"id":{"type":"string","description":"The ID of the shipping address","example":"address_id_123"},"first_name":{"type":"string","description":"The first name of the recipient","example":"John"},"last_name":{"type":"string","description":"The last name of the recipient","example":"Doe"},"phone_number":{"type":"string","description":"The phone number of the recipient","example":"+123456789"},"address":{"type":"string","description":"The street address of the recipient","example":"123 Main St"},"zip_code":{"type":"string","description":"The zip code of the recipient's address","example":"10001"},"city":{"type":"string","description":"The city of the recipient's address","example":"New York"},"region_code":{"type":"string","description":"The region code (e.g., state or province)","example":"NY"},"country_code":{"type":"string","description":"The country code (ISO 3166-1 alpha-2)","example":"US"}}},"tracking_info":{"type":"object","description":"The tracking information for the shipment","properties":{"tracking_number":{"type":"string","description":"The tracking number for the shipment","example":"FedEx1Z99999999"},"tracking_carrier":{"type":"string","description":"The carrier providing the tracking information","example":"FedEx"},"external_url":{"type":"string","description":"The external URL to track the shipment","format":"uri","example":"https://tracking.carrier.com/1Z9999999999999999"}}},"items":{"type":"array","description":"The list of items included in this shipment","items":{"allOf":[{"type":"object","description":"Represents an item that was ordered","properties":{"id":{"type":"string","description":"The ID of the order item","example":"orderItem789"},"product_id":{"type":"string","description":"The product ID of the item","example":"product_iphone_15"},"name":{"type":"string","description":"The name of the order item","example":"Apple iPhone 15"},"description":{"type":"string","description":"A brief description of the order item","example":"Latest Apple smartphone"},"brand":{"type":"string","description":"The brand of the order item","example":"Brand A"},"price":{"type":"object","description":"The price of the order item","properties":{"value":{"type":"string","description":"The price value of the order item","example":"999.99"},"currency":{"type":"string","description":"The currency of the price","example":"USD"}}},"image_url":{"type":"string","format":"uri","description":"The URL of the order item's image","example":"https://example.com/product1.jpg"},"quantity":{"type":"integer","description":"The quantity of the order item","example":2},"sku":{"type":"string","description":"The SKU of the order item","example":"ABC123"}}}]}},"custom_fields":{"type":"object","description":"Additional custom fields","additionalProperties":true}}}}}},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"uri","example":"http://api-docs.talkdesk.org/erc/ecommerce/connections/customers/customer123/shipments?limit=2&order_by=last_update:desc"}}},"next":{"type":"object","properties":{"href":{"type":"string","format":"uri","example":"http://api-docs.talkdesk.org/erc/ecommerce/connections/customers/customer123/shipments?limit=2&order_by=last_update:desc&cursor=eyJsYXN0X2lkIjoxMjQ4MzU4NTYzODYyLCJsYXN0X3ZhbHVlIjoiMjAxOS0wNi0xNyAwMjoyMzo0Mi4wMDAwMDAifQ=="}}}}}}},"examples":{"Valid Customer Shipments List":{"value":{"_embedded":{"shipments":[{"id":"delivery_id","brand":"Brand A","order_id":"order_id_1","customer_id":"customer123","delivery_quantity":3,"delivery_date_start":"2025-02-21T12:16:50.078Z","delivery_date_end":"2025-02-28T12:16:50.078Z","delivery_staff":"Mike Daniel","latest_status_info":"Shipped","last_update":"2025-02-17T12:00:00Z","created_time":"2025-01-23T12:16:50.078Z","description":"This shipment will be delivered by FedEx.","shipping_provider":"FedEx","shipping_date":"2025-01-23T12:16:50.078Z","shipping_address":{"id":"address_id_123","first_name":"John","last_name":"Doe","phone_number":"+123456789","address":"123 Main St","zip_code":"10001","city":"New York","region_code":"NY","country_code":"US"},"tracking_info":{"tracking_number":"FedEx1Z99999999","tracking_carrier":"Tom the postman","external_url":"https://tracking.carrier.com/1Z9999999999999999"},"items":[{"id":"item_id_1","product_id":"product_apple_1","name":"Apple iPhone 15","description":"Latest Apple smartphone","brand":"Brand A","price":{"value":"999.99","currency":"USD"},"image_url":"https://example.com/product1.jpg","quantity":2,"sku":"ABC123"},{"id":"item_id_2","product_id":"Banana2","name":"Product 2","description":"Another great product","brand":"Brand B","price":{"value":"25.00","currency":"USD"},"image_url":"https://example.com/product2.jpg","quantity":1,"sku":"XYZ456"}],"custom_fields":{"field1":"Custom Value 1","field2":"Custom Value 2"}}]},"_links":{"self":{"href":"http://api-docs.talkdesk.org/erc/ecommerce/connections/customers/customer123/shipments?limit=2&order_by=last_update:desc"},"next":{"href":"http://api-docs.talkdesk.org/erc/ecommerce/connections/customers/customer123/shipments?limit=2&order_by=last_update:desc&cursor=eyJsYXN0X2lkIjoxMjQ4MzU4NTYzODYyLCJsYXN0X3ZhbHVlIjoiMjAxOS0wNi0xNyAwMjoyMzo0Mi4wMDAwMDAifQ=="}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Generic Bad Request":{"value":{"code":"3234000","message":"Bad request."}},"Invalid Address":{"value":{"code":"3234001","message":"Invalid address provided","fields":[{"name":"region_code","description":"the provided region code is not valid for the country"}]}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"3234010","message":"Invalid JWT."}},"Account not configured to use ERC E-Commerce APIs":{"value":{"code":"3234011","message":"Account not configured to use ERC E-Commerce APIs."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234030","message":"Required scopes are missing."}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234040","message":"Resource not found."}}}},"405":{"description":"Method not supported","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234050","message":"Method not allowed."}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234220","message":"Unprocessable entity"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3235000","message":"Internal Server Error."}}}},"502":{"description":"Bad Gateway","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3235020","message":"Bad Gateway."}}}}}}},"/erc/ecommerce/connections/customers/{customer_id}/shipments/schedule":{"post":{"tags":["ERC ECommerce Connections"],"description":"Schedule the ERC e-commerce customer shipments slots for the provided order id or delivery id.

    Integration shops
    • Customers Bridge -> Supports all parameters and responses.
    ","security":[{"GA":["erc-ecommerce-connections-customers:write"]}],"parameters":[{"name":"customer_id","in":"path","required":true,"description":"The unique identifier for the customer who wants to schedule the shipment.","schema":{"type":"string","maxLength":255,"minLength":1,"example":"customer123"}},{"name":"brand","in":"query","description":"The brand of the provider you want to filter by. If the account is multi-brand, this parameter is required.\n","required":false,"schema":{"type":"string","maxLength":255,"minLength":1,"example":"Brand A"}}],"requestBody":{"description":"The shipment slot to schedule","content":{"application/json":{"schema":{"type":"object","description":"The customer shipment slot to schedule, notes that at least one of order id, delivery id is required","required":["id"],"properties":{"id":{"type":"string","description":"The slot id which user wants to schedule","example":"slot123"},"order_id":{"type":"string","description":"The order id","example":"order123"},"delivery_id":{"type":"string","description":"The delivery id","example":"delivery123"}}},"example":{"id":"slot123","order_id":"order123","delivery_id":"delivery123"}}}},"responses":{"200":{"description":"Empty Result for Success.","content":{"application/json":{"schema":{"type":"object","description":"Represents the success result of customer shipments schedule","required":["_links"],"properties":{"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"uri","example":"http://api-docs.talkdesk.org/erc/ecommerce/connections/customers/customer123/shipments/schedule"}}}}}}},"examples":{"Valid Customer Shipments Schedule":{"value":{"_links":{"self":{"href":"http://api-docs.talkdesk.org/erc/ecommerce/connections/customers/customer123/shipments/schedule"}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Generic Bad Request":{"value":{"code":"3234000","message":"Bad request."}},"Invalid Combined Param":{"value":{"code":"3234002","message":"At least one of the parameters should be provided.","fields":[{"name":"order_id"},{"name":"delivery_id"}]}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"3234010","message":"Invalid JWT."}},"Account not configured to use ERC E-Commerce APIs":{"value":{"code":"3234011","message":"Account not configured to use ERC E-Commerce APIs."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234030","message":"Required scopes are missing."}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234040","message":"Resource not found."}}}},"405":{"description":"Method not supported","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234050","message":"Method not allowed."}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234220","message":"Unprocessable entity"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3235000","message":"Internal Server Error."}}}},"502":{"description":"Bad Gateway","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3235020","message":"Bad Gateway."}}}}}}},"/erc/ecommerce/connections/customers/{customer_id}":{"get":{"tags":["ERC ECommerce Connections"],"description":"Read the ERC e-commerce connections customer by id.","security":[{"GA":["erc-ecommerce-connections-customers:read"]}],"parameters":[{"name":"customer_id","in":"path","required":true,"description":"The customer id.","schema":{"type":"string","example":"customer123"}},{"name":"brand","in":"query","required":false,"description":"The brand of the provider you want to filter by. If the account is multi-brand, this parameter is required.\n","schema":{"type":"string","maxLength":255,"minLength":1,"example":"Brand 123"}}],"responses":{"200":{"description":"The customer found with the provided id.","content":{"application/json":{"schema":{"type":"object","description":"Represents the customer resource","required":["id","_links"],"properties":{"id":{"type":"string","description":"The ID of the customer","example":"customer123"},"first_name":{"type":"string","description":"The first name of the customer","example":"John"},"last_name":{"type":"string","description":"The last name of the customer","example":"Doe"},"customer_since":{"type":"string","description":"The timestamp date of the customer creation/registration in the system. Only the ISO 8601 date-time format (e.g., '2025-02-17T12:00:00Z') is supported.","format":"date-time","example":"2021-09-04T12:16:50.078Z"},"shipping_addresses":{"type":"array","description":"The list of shipping addresses associated with the customer","items":{"type":"object","description":"Represents an address of a customer or order","required":["first_name","last_name","address","zip_code","city","region_code","country_code"],"properties":{"id":{"type":"string","description":"The address identifier","example":"address1234"},"first_name":{"type":"string","description":"The first name of the person associated with the address","example":"John"},"last_name":{"type":"string","description":"The last name of the person associated with the address","example":"Doe"},"phone_number":{"type":"string","description":"The phone number of the person associated with the address","example":"+351910000000"},"address":{"type":"string","description":"The first line of the address","example":"Lisbon"},"zip_code":{"type":"string","description":"The zip-code of the address","example":"20000000"},"city":{"type":"string","description":"The city of the address","example":"Lisbon"},"region_code":{"type":"string","description":"The region (country subdivision) code according to ISO 3166-2 standard","example":"PT-11"},"country_code":{"type":"string","description":"The country code of the address, according the ISO 3166-1 alpha-2 codes","example":"PT"},"default":{"type":"boolean","description":"Define if address is default","example":true}}}},"integration_info":{"description":"The internal integration information","allOf":[{"type":"object","description":"Represents the external integration information","required":["external_url","type"],"properties":{"external_url":{"type":"string","description":"The URL of the resource in the external system (ex: the URL of a customer in the Shopify system)","format":"uri","example":"https://external.url.com/"},"type":{"description":"The type of integration","allOf":[{"type":"string","description":"The integration type","enum":["UNKNOWN","SHOPIFY"],"example":"SHOPIFY"}]}}}]},"custom_fields":{"type":"object","description":"The custom fields associated with the provider","additionalProperties":true},"brand":{"type":"string","description":"The brand of the provider you want to filter by.","example":"Brand 123"},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"uri","example":"http://api-docs.talkdesk.org/erc/ecommerce/connections/customers/customer123"}}}}}}},"examples":{"Valid Customer":{"value":{"id":"customer123","first_name":"John","last_name":"Doe","customer_since":"2021-09-04T12:16:50.078Z","shipping_addresses":[{"id":"address1234","first_name":"John","last_name":"Doe","phone_number":"+351910000000","address":"Lisbon","zip_code":"20000000","city":"Lisbon","region_code":"PT-11","country_code":"PT","default":true},{"id":"address5678","first_name":"John","last_name":"Doe","phone_number":"+351910000000","address":"Av. dos Aliados","zip_code":"30000000","city":"Porto","region_code":"PT-13","country_code":"PT","default":false},{"id":"address1111","first_name":"John","last_name":"Doe","phone_number":"+351910000000","address":"Rua direita","zip_code":"40000000","city":"Viseu","region_code":"PT-18","country_code":"PT","default":false}],"integration_info":{"external_url":"https://external-integration.url.com","type":"SHOPIFY"},"custom_fields":{},"brand":"Brand 123","_links":{"self":{"href":"http://api-docs.talkdesk.org/erc/ecommerce/connections/customers/customer123"}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234010","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234030","message":"Required scopes are missing."}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234040","message":"Resource not found."}}}},"405":{"description":"Method not supported","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234050","message":"Method not allowed."}}}}}}},"/erc/ecommerce/connections/customers/{customer_id}/orders":{"get":{"tags":["ERC ECommerce Connections"],"description":"Read the ERC e-commerce connections customer orders provided by the customer id.","security":[{"GA":["erc-ecommerce-connections-orders:read"]}],"parameters":[{"name":"customer_id","in":"path","required":true,"description":"The customer id.","schema":{"type":"string","example":"customer123"}},{"name":"limit","in":"query","description":"The amount of orders we want to get","required":true,"schema":{"type":"integer","example":2,"minimum":1,"maximum":100,"default":50}},{"name":"cursor","in":"query","description":"The field is used for pagination and represent the value of the next page’s offset, next page’s start ID, or a custom cursor specified by the provider.","schema":{"type":"string","default":""},"example":"0 or encode({\"last_id\":4059566342166,\"last_value\":\"2021-06-23 22:05:08.525991\"})","allowEmptyValue":true},{"name":"search","in":"query","description":"The order number (or order number prefix) we want to search by","required":false,"schema":{"type":"string","default":"","x-search_operators":["*"],"x-search_fields":["order_number"]}},{"name":"brand","in":"query","required":false,"description":"The brand of the provider you want to filter by. If the account is multi-brand, this parameter is required.\n","schema":{"type":"string","maxLength":255,"minLength":1,"example":"Brand 123"}}],"responses":{"200":{"description":"The list of customer orders found with the provided customer id.","content":{"application/json":{"schema":{"type":"object","description":"Represents the paginated list of customer orders","required":["_embedded","_links"],"properties":{"_embedded":{"type":"object","properties":{"orders":{"type":"array","description":"The list of orders in the current page","items":{"type":"object","description":"Describes the order resource item.","required":["id","order_number"],"properties":{"id":{"type":"string","description":"The ID of the order","example":"order456"},"order_number":{"type":"string","description":"The number of the order (usually the order identifier that the customer knows)","example":"#Y34DHR"},"customer_id":{"type":"string","description":"The ID of the customer that created this order","example":"customer123"},"purchase_datetime":{"type":"string","description":"The timestamp date when the order was created","format":"date-time","example":"2021-09-14T12:16:50.078Z"},"delivery_type":{"description":"The type of delivery associated with the order","allOf":[{"type":"string","description":"Represents the type of delivery for a given order","enum":["UNKNOWN","LOCAL_DELIVERY","LOCAL_PICKUP","SHIPPING"],"example":"SHIPPING"}]},"shipping_addresses":{"type":"array","description":"The address to which the order will be/was shipped","items":{"type":"object","description":"Represents an address of a customer or order","required":["first_name","last_name","address","zip_code","city","region_code","country_code"],"properties":{"id":{"type":"string","description":"The address identifier","example":"address1234"},"first_name":{"type":"string","description":"The first name of the person associated with the address","example":"John"},"last_name":{"type":"string","description":"The last name of the person associated with the address","example":"Doe"},"phone_number":{"type":"string","description":"The phone number of the person associated with the address","example":"+351910000000"},"address":{"type":"string","description":"The first line of the address","example":"Lisbon"},"zip_code":{"type":"string","description":"The zip-code of the address","example":"20000000"},"city":{"type":"string","description":"The city of the address","example":"Lisbon"},"region_code":{"type":"string","description":"The region (country subdivision) code according to ISO 3166-2 standard","example":"PT-11"},"country_code":{"type":"string","description":"The country code of the address, according the ISO 3166-1 alpha-2 codes","example":"PT"},"default":{"type":"boolean","description":"Define if address is default","example":true}}}},"items_number":{"type":"integer","format":"int64","description":"The number of order items","example":3,"minimum":1,"maximum":100},"price_summary":{"description":"The summary of the order prices","allOf":[{"type":"object","required":["original_total_amount","final_total_amount"],"properties":{"original_total_amount":{"description":"The original total amount of the order, i.e. before applying discounts, shipping and taxes","allOf":[{"type":"object","description":"Represents an amount of money in a given currency","required":["value","currency"],"properties":{"value":{"type":"number","description":"The amount of money","format":"double","example":10.5},"currency":{"type":"string","description":"The currency of the money amount","example":"EUR"}}}]},"discounts_amount":{"description":"The amount of the order discounts","allOf":[{"type":"object","description":"Represents an amount of money in a given currency","required":["value","currency"],"properties":{"value":{"type":"number","description":"The amount of money","format":"double","example":10.5},"currency":{"type":"string","description":"The currency of the money amount","example":"EUR"}}}]},"shipping_amount":{"description":"The amount of the order shipping costs","allOf":[{"type":"object","description":"Represents an amount of money in a given currency","required":["value","currency"],"properties":{"value":{"type":"number","description":"The amount of money","format":"double","example":10.5},"currency":{"type":"string","description":"The currency of the money amount","example":"EUR"}}}]},"taxes_amount":{"description":"The amount of the order taxes","allOf":[{"type":"object","description":"Represents an amount of money in a given currency","required":["value","currency"],"properties":{"value":{"type":"number","description":"The amount of money","format":"double","example":10.5},"currency":{"type":"string","description":"The currency of the money amount","example":"EUR"}}}]},"final_total_amount":{"description":"The final total amount of the order, i.e. after applying discounts, shipping and taxes","allOf":[{"type":"object","description":"Represents an amount of money in a given currency","required":["value","currency"],"properties":{"value":{"type":"number","description":"The amount of money","format":"double","example":10.5},"currency":{"type":"string","description":"The currency of the money amount","example":"EUR"}}}]},"net_payment_amount":{"description":"The net payment for the order","allOf":[{"type":"object","description":"Represents an amount of money in a given currency","required":["value","currency"],"properties":{"value":{"type":"number","description":"The amount of money","format":"double","example":10.5},"currency":{"type":"string","description":"The currency of the money amount","example":"EUR"}}}]},"total_outstanding_amount":{"description":"The total amount not yet transacted for the order","allOf":[{"type":"object","description":"Represents an amount of money in a given currency","required":["value","currency"],"properties":{"value":{"type":"number","description":"The amount of money","format":"double","example":10.5},"currency":{"type":"string","description":"The currency of the money amount","example":"EUR"}}}]},"total_refunded_amount":{"description":"The total amount that was refunded","allOf":[{"type":"object","description":"Represents an amount of money in a given currency","required":["value","currency"],"properties":{"value":{"type":"number","description":"The amount of money","format":"double","example":10.5},"currency":{"type":"string","description":"The currency of the money amount","example":"EUR"}}}]}}}]},"order_extra_info":{"description":"The extra info of the order","allOf":[{"type":"object","properties":{"highlighted_item_image_url":{"type":"string","description":"The image of most expensive item ","example":"https://external-integration.url.com/payment_card_brand_icon.jpg"}}}]},"status":{"type":"string","description":"The status of the order. Each integration has its own set of possible status values","example":"CONFIRMED"},"custom_fields":{"type":"object","description":"The custom fields associated with the provider","additionalProperties":true},"brand":{"type":"string","description":"The brand of the provider","example":"Brand 123"}}}}}},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"uri","example":"http://api-docs.talkdesk.org/erc/ecommerce/connections/customers/customer123/orders?limit=2"}}},"next":{"type":"object","properties":{"href":{"type":"string","format":"uri","example":"http://api-docs.talkdesk.org/erc/ecommerce/connections/customers/customer123/orders?limit=2&cursor=eyJsYXN0X2lkIjoxMjQ4MzU4NTYzODYyLCJsYXN0X3ZhbHVlIjoiMjAxOS0wNi0xNyAwMjoyMzo0Mi4wMDAwMDAifQ=="}}}}}}},"examples":{"Valid Order List":{"value":{"_embedded":{"orders":[{"id":"order456","order_number":"#Y34DHR","customer_id":"customer123","purchase_datetime":"2021-09-14T12:16:50.078Z","delivery_type":"SHIPPING","shipping_addresses":[{"id":"address1234","first_name":"John","last_name":"Doe","phone_number":"+351910000000","address":"Lisbon","zip_code":"20000000","city":"Lisbon","region_code":"PT-11","country_code":"PT"},{"id":"address12345","first_name":"John","last_name":"Doe","phone_number":"+351910000000","address":"Lisbon","zip_code":"20000000","city":"Lisbon","region_code":"PT-11","country_code":"PT"}],"items_number":1,"price_summary":{"original_total_amount":{"value":100,"currency":"GBP"},"discounts_amount":{"value":10,"currency":"GBP"},"shipping_amount":{"value":5,"currency":"GBP"},"taxes_amount":{"value":10,"currency":"GBP"},"final_total_amount":{"value":125,"currency":"GBP"},"net_payment_amount":{"value":125,"currency":"GBP"},"total_outstanding_amount":{"value":0,"currency":"GBP"},"total_refunded_amount":{"value":10,"currency":"GBP"}},"order_extra_info":{"highlighted_item_image_url":"https://external-integration.url.com/payment_card_brand_icon.jpg"},"status":"CONFIRMED"},{"id":"order789","order_number":"#Y35DHR","customer_id":"customer123","purchase_datetime":"2021-09-14T12:16:50.078Z","delivery_type":"SHIPPING","shipping_addresses":[{"first_name":"John","last_name":"Doe","phone_number":"+351910000000","address":"Lisbon","zip_code":"20000000","city":"Lisbon","region_code":"PT-11","country_code":"PT"}],"items_number":3,"price_summary":{"original_total_amount":{"value":136.24,"currency":"GBP"},"final_total_amount":{"value":136.24,"currency":"GBP"}},"order_extra_info":{"highlighted_item_image_url":"https://external-integration.url.com/payment_card_brand_icon.jpg"},"status":"CONFIRMED","custom_fields":{},"brand":"Brand 123"}]},"_links":{"self":{"href":"http://api-docs.talkdesk.org/erc/ecommerce/connections/customers/customer123/orders?limit=2"},"next":{"href":"http://api-docs.talkdesk.org/erc/ecommerce/connections/customers/customer123/orders?limit=2&cursor=eyJsYXN0X2lkIjoxMjQ4MzU4NTYzODYyLCJsYXN0X3ZhbHVlIjoiMjAxOS0wNi0xNyAwMjoyMzo0Mi4wMDAwMDAifQ=="}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234010","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234030","message":"Required scopes are missing."}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234040","message":"Resource not found."}}}},"405":{"description":"Method not supported","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234050","message":"Method not allowed."}}}}}}},"/erc/ecommerce/connections/customers/{customer_id}/most-recent-order":{"get":{"tags":["ERC ECommerce Connections"],"description":"Read the ERC e-commerce connections customer most recent order for the provided customer id.","security":[{"GA":["erc-ecommerce-connections-orders:read"]}],"parameters":[{"name":"customer_id","in":"path","required":true,"description":"The customer id.","schema":{"type":"string","example":"customer123"}},{"name":"brand","in":"query","required":false,"description":"The brand of the provider you want to filter by. If the account is multi-brand, this parameter is required.\n","schema":{"type":"string","maxLength":255,"minLength":1,"example":"Brand 123"}}],"responses":{"200":{"description":"The customer most recent order found for the provided customer id.","content":{"application/json":{"schema":{"type":"object","description":"Represents the customer most recent order resource","required":["id","order_number"],"properties":{"id":{"type":"string","description":"The ID of the order","example":"order456"},"customer_id":{"type":"string","description":"The ID of the customer that created this order","example":"customer123"},"status_info":{"type":"array","description":"The list of possible status information states/steps for the order","items":{"type":"object","description":"Represents a status info state/step for a given order","required":["generic_type"],"properties":{"generic_type":{"type":"string","description":"The generic type of the state/step","example":["UNKNOWN","CONFIRMED","ON_ITS_WAY","OUT_FOR_DELIVERY","DELIVERED"]},"detailed_type":{"description":"The detailed type of the state/step","type":"string","example":["UNKNOWN","ATTEMPTED_DELIVERY","READY_FOR_PICKUP","PICKED_UP","CONFIRMED","IN_TRANSIT","OUT_FOR_DELIVERY","DELIVERED","FAILURE"]},"status_date_time":{"type":"string","description":"The timestamp date when the status info state/step was 'reached'","format":"date-time","example":"2021-10-23T12:16:50.078Z"}}}},"status_info_current_index":{"type":"integer","description":"The current state/step index of the order status in the 'status_info' list","example":3},"order_number":{"type":"string","description":"The number of the order (usually the order identifier that the customer knows)","example":"#Y34DHR"},"purchase_datetime":{"type":"string","description":"The timestamp date when the order was created","format":"date-time","example":"2021-09-14T12:16:50.078Z"},"tracking_info":{"allOf":[{"type":"object","description":"The tracking information associated with the order delivery","required":["tracking_number"],"properties":{"tracking_number":{"type":"string","description":"The tracking number associated with the order delivery","example":"#USPS 123456789"},"external_url":{"type":"string","description":"The URL of the external system where we can get more tracking details (ex: the URL of the carrier)","format":"uri","example":"https://external.url.com/"}}}]},"delivery_type":{"description":"The type of delivery associated with the order","allOf":[{"type":"string","description":"Represents the type of delivery for a given order","enum":["UNKNOWN","LOCAL_DELIVERY","LOCAL_PICKUP","SHIPPING"],"example":"SHIPPING"}]},"shipping_addresses":{"type":"array","description":"The addresses to which the order will be/was shipped","items":{"type":"object","description":"Represents an address of a customer or order","required":["first_name","last_name","address","zip_code","city","region_code","country_code"],"properties":{"id":{"type":"string","description":"The address identifier","example":"address1234"},"first_name":{"type":"string","description":"The first name of the person associated with the address","example":"John"},"last_name":{"type":"string","description":"The last name of the person associated with the address","example":"Doe"},"phone_number":{"type":"string","description":"The phone number of the person associated with the address","example":"+351910000000"},"address":{"type":"string","description":"The first line of the address","example":"Lisbon"},"zip_code":{"type":"string","description":"The zip-code of the address","example":"20000000"},"city":{"type":"string","description":"The city of the address","example":"Lisbon"},"region_code":{"type":"string","description":"The region (country subdivision) code according to ISO 3166-2 standard","example":"PT-11"},"country_code":{"type":"string","description":"The country code of the address, according the ISO 3166-1 alpha-2 codes","example":"PT"},"default":{"type":"boolean","description":"Define if address is default","example":true}}}},"highlighted_item":{"description":"The highlighted/main item of the order","allOf":[{"type":"object","description":"Represents an item that was ordered","required":["id","name","price"],"properties":{"id":{"type":"string","description":"The ID of the item","example":"orderItem789"},"name":{"type":"string","description":"The name of the item","example":"Order Item 789"},"description":{"type":"string","description":"The description of the item","example":"Description of order Item 789"},"brand":{"type":"string","description":"The brande of the item","example":"Brand 123"},"price":{"description":"The price of the item","allOf":[{"type":"object","description":"Represents an amount of money in a given currency","required":["value","currency"],"properties":{"value":{"type":"number","description":"The amount of money","format":"double","example":10.5},"currency":{"type":"string","description":"The currency of the money amount","example":"EUR"}}}]},"image_url":{"type":"string","description":"The URL of the item image/picture","format":"uri","example":"https://external-integration.url.com/order_item_icon.png"},"quantity":{"type":"integer","format":"int64","description":"The quantity of the item","example":10,"minimum":1,"maximum":100},"sku":{"type":"string","description":"The sku of the item","example":"Sku 123"},"deliverable_quantity":{"type":"integer","description":"The quantity of order items that are yet to be delivered/processed","format":"int64","example":10,"minimum":1,"maximum":100},"deliveries":{"type":"array","description":"List of deliveries where the item is inserted","items":{"allOf":[{"type":"object","description":"Represents a order item delivery resource","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the order delivery","example":"orderDelivery123"},"delivery_quantity":{"type":"integer","format":"int64","description":"The quantity of items associated with the delivery","example":10,"minimum":1,"maximum":100},"carrier":{"type":"string","description":"[Only supported on Customers Bridge] This refers to the shipping carrier or courier service that is handling the delivery of the item.","example":"FedEx"},"delivery_type":{"type":"string","description":"[Only supported on Customers Bridge] The method of delivery used for the shipment.","example":"Store delivery"},"delivery_date_start":{"type":"string","description":"[Only supported on Customers Bridge] The start date of the delivery window, indicating when the shipment is expected to begin its delivery process. This is when the carrier will start the delivery journey or the delivery window opens.","format":"date-time","example":"2025-02-21T12:16:50.078Z"},"delivery_date_end":{"type":"string","description":"[Only supported on Customers Bridge] The end date of the delivery window, indicating when the shipment is expected to be delivered or when the delivery window closes. This shows the expected timeframe for the delivery to be completed.","format":"date-time","example":"2025-02-28T12:16:50.078Z"},"shipping_date":{"type":"string","description":"[Only supported on Customers Bridge] The date when the shipment was actually shipped out. This is when the order was dispatched from the warehouse or fulfillment center.","example":"2025-02-21T12:16:50.078Z"},"service_level":{"type":"string","description":"[Only supported on Customers Bridge] Indicates the level of service for the delivery, which represents the default or basic shipping option.","example":"Standard"},"description":{"type":"string","description":"[Only supported on Customers Bridge] A text description providing more context or details about the shipment.","example":"This shipment will be delivered by FedEx."},"latest_status_info":{"description":"The latest delivery status information","allOf":[{"type":"object","description":"Represents a status info state/step for a given order delivery","required":["type"],"properties":{"type":{"type":"string","description":"The type of the state/step","example":["UNKNOWN","ATTEMPTED_DELIVERY","READY_FOR_PICKUP","PICKED_UP","CONFIRMED","IN_TRANSIT","OUT_FOR_DELIVERY","DELIVERED","FAILURE"]},"status_date_time":{"type":"string","description":"The timestamp date when the status info state/step was 'reached'","format":"date-time","example":"2021-10-23T12:16:50.078Z"}}}]},"tracking_info":{"description":"The tracking information associated with the order delivery","allOf":[{"type":"object","description":"The tracking information associated with the order delivery","required":["tracking_number"],"properties":{"tracking_number":{"type":"string","description":"The tracking number associated with the order delivery","example":"#USPS 123456789"},"external_url":{"type":"string","description":"The URL of the external system where we can get more tracking details (ex: the URL of the carrier)","format":"uri","example":"https://external.url.com/"}}}]},"last_update":{"type":"string","description":"The timestamp date when the order delivery was last updated","format":"date-time","example":"2021-09-14T12:16:50.078Z"}}}]}},"custom_fields":{"type":"object","description":"The custom fields associated with the provider","additionalProperties":true}}}]},"custom_fields":{"type":"object","description":"The custom fields associated with the provider","additionalProperties":true},"brand":{"type":"string","description":"The brand of the provider","example":"Brand 123"},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"uri","example":"http://api-docs.talkdesk.org/erc/ecommerce/workspace/customers/customer123/most-recent-order"}}}}}}},"examples":{"Valid Order":{"value":{"id":"order456","customer_id":"customer123","status_info":[{"generic_type":"CONFIRMED","detailed_type":"CONFIRMED","status_date_time":"2021-10-23T12:16:50.078Z"},{"generic_type":"ON_ITS_WAY","detailed_type":"IN_TRANSIT","status_date_time":"2021-10-23T13:17:50.078Z"},{"generic_type":"OUT_FOR_DELIVERY","detailed_type":"OUT_FOR_DELIVERY","status_date_time":"2021-10-24T13:17:50.078Z"},{"generic_type":"DELIVERED"}],"status_info_current_index":2,"order_number":"#Y34DHR","purchase_datetime":"2021-09-14T12:16:50.078Z","tracking_info":{"tracking_number":"#USPS 123456789","external_url":"https://external-carrier-url"},"delivery_type":"SHIPPING","shipping_addresses":[{"id":"id123","first_name":"John","last_name":"Doe","phone_number":"+351910000000","address":"Lisbon","zip_code":"20000000","city":"Lisbon","region_code":"PT-11","country_code":"PT"}],"highlighted_item":{"id":"orderItem123","brand":"Brand 123","name":"Order Item 123","description":"Description of order Item 123","price":{"value":100,"currency":"GBP"},"image_url":"https://external-integration.url.com/order_item_icon.png","quantity":1,"sku":"Sku 123"},"custom_fields":{},"brand":"Brand 123","_links":{"self":{"href":"http://api-docs.talkdesk.org/erc/ecommerce/workspace/customers/customer123/most-recent-order"}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234010","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234030","message":"Required scopes are missing."}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234040","message":"Resource not found."}}}},"405":{"description":"Method not supported","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234050","message":"Method not allowed."}}}}}}},"/erc/ecommerce/connections/customers/shipments/available-slots":{"get":{"tags":["ERC ECommerce Connections"],"description":"Read the ERC e-commerce customer shipment available slots for the provided customer id, order id or delivery id.","security":[{"GA":["erc-ecommerce-connections-customers:read"]}],"parameters":[{"name":"customer_id","in":"query","description":"The unique identifier for the customer whose shipment available slots need to be retrieved.","required":false,"schema":{"type":"string","maxLength":255,"minLength":1,"example":"customer123"}},{"name":"order_id","in":"query","description":"The order id you want to query.","required":false,"schema":{"type":"string","maxLength":255,"minLength":1,"example":"order_no_1"}},{"name":"delivery_id","in":"query","required":false,"description":"The delivery id you want to query.","schema":{"type":"string","maxLength":255,"example":"delivery123"}},{"name":"start_time","in":"query","required":false,"description":"The start time for the shipment available slots query.","schema":{"type":"string","format":"date-time","example":"2023-08-30T10:00:00Z"}},{"name":"end_time","in":"query","required":false,"description":"The end time for the shipment available slots query.","schema":{"type":"string","format":"date-time","example":"2023-08-30T12:00:00Z"}},{"name":"zip_code","in":"query","required":false,"description":"The zip code for the shipment available slots query.","schema":{"type":"string","maxLength":10,"minLength":5,"example":"12345"}},{"name":"brand","in":"query","description":"The brand of the provider you want to query. If the account is multi-brand, this parameter is required.\n","required":false,"schema":{"type":"string","maxLength":255,"minLength":1,"example":"Brand A"}},{"name":"limit","in":"query","description":"The amount of shipment available slots you want to get.","required":false,"schema":{"type":"integer","example":10,"minimum":1,"maximum":100,"default":50}},{"name":"cursor","in":"query","description":"The opaque string that represents the cursor after which the 'limit' amount of available slots are retrieved.","required":false,"schema":{"type":"string","maxLength":255,"minLength":1,"default":""},"example":"eyJsYXN0X2lkIjozMDExMjM4MjUsImxhc3RfdmFsdWUiOiAiMjAyMC0wOC0zMCJ9"},{"name":"order_by","in":"query","description":"The parameter to be sorted for. Use order_by=key1:desc for descending, order_by=key1:asc for ascending.","required":false,"schema":{"type":"string","maxLength":255,"minLength":1,"example":"date:asc"}}],"responses":{"200":{"description":"The list of customer available slots found for the provided customer id.","content":{"application/json":{"schema":{"type":"object","description":"Represents the paginated list of shipment available slots","required":["_embedded","_links"],"properties":{"_embedded":{"type":"object","required":["delivery_slots"],"properties":{"delivery_slots":{"type":"array","description":"The list of shipment available slots in the current page","items":{"type":"object","description":"Represents an available slot associated with a shipment","required":["id","date","time","timezone"],"properties":{"id":{"type":"string","description":"The identifier of the slot","example":"slot_123"},"brand":{"type":"string","description":"The brand of the provider","example":"Brand A"},"date":{"type":"string","description":"The scheduled delivery date (YYYY-MM-DD)","format":"date","example":"2025-08-15"},"time":{"type":"object","description":"The delivery time window","required":["start","end"],"properties":{"start":{"type":"string","description":"The scheduled delivery start time","example":"9:00 AM"},"end":{"type":"string","description":"The scheduled delivery end time","example":"11:00 AM"}}},"timezone":{"type":"string","description":"The timezone for the delivery slot","example":"America/New_York"},"shipping_provider":{"type":"string","description":"The shipping provider for the shipment","example":"FedEx"},"custom_fields":{"type":"object","description":"Additional custom fields","additionalProperties":true}}}}}},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string","format":"uri","example":"http://api-docs.talkdesk.org/erc/ecommerce/connections/customers/shipments/available-slots?limit=2&order_by=date:asc"}}},"next":{"type":"object","required":["href"],"properties":{"href":{"type":"string","format":"uri","example":"http://api-docs.talkdesk.org/erc/ecommerce/connections/customers/shipments/available-slots?limit=2&order_by=date:asc&cursor=eyJsYXN0X2lkIjoxMjQ4MzU4NTYzODYyLCJsYXN0X3ZhbHVlIjoiMjAxOS0wNi0xNyAwMjoyMzo0Mi4wMDAwMDAifQ=="}}}}}}},"examples":{"Valid Customer Available Slot List":{"value":{"_embedded":{"delivery_slots":[{"id":"slot_001","brand":"Brand A","date":"2025-01-01","time":{"start":"9:00 AM","end":"11:00 AM"},"timezone":"America/New_York","shipping_provider":"FedEx","custom_fields":{"field1":"Custom Value 1","field2":"Custom Value 2"}}]},"_links":{"self":{"href":"http://api-docs.talkdesk.org/erc/ecommerce/connections/customers/shipments/available-slots?limit=2&order_by=date:asc"},"next":{"href":"http://api-docs.talkdesk.org/erc/ecommerce/connections/customers/shipments/available-slots?limit=2&order_by=date:asc&cursor=eyJsYXN0X2lkIjoxMjQ4MzU4NTYzODYyLCJsYXN0X3ZhbHVlIjoiMjAxOS0wNi0xNyAwMjoyMzo0Mi4wMDAwMDAifQ=="}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"examples":{"Generic Bad Request":{"value":{"code":"3234000","message":"Bad request."}},"Invalid Combined Param":{"value":{"code":"3234002","message":"At least one of the parameters should be provided.","fields":[{"name":"customer_id"},{"name":"order_id"},{"name":"delivery_id"}]}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"3234010","message":"Invalid JWT."}},"Account not configured to use ERC E-Commerce APIs":{"value":{"code":"3234011","message":"Account not configured to use ERC E-Commerce APIs."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234030","message":"Required scopes are missing."}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234040","message":"Resource not found."}}}},"405":{"description":"Method not supported","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234050","message":"Method not allowed."}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234220","message":"Unprocessable entity"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3235000","message":"Internal Server Error."}}}},"502":{"description":"Bad Gateway","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3235020","message":"Bad Gateway."}}}}}}},"/erc/ecommerce/connections/products":{"get":{"tags":["ERC ECommerce Connections"],"description":"Get/search the products of the store we are integrated with.","security":[{"GA":["erc-ecommerce-connections-products:read"]}],"parameters":[{"name":"limit","in":"query","description":"The amount of products we want to get","required":true,"schema":{"type":"integer","example":5,"minimum":1,"maximum":100,"default":50}},{"name":"cursor","in":"query","description":"The field is used for pagination and represent the value of the next page’s offset, next page’s start ID, or a custom cursor specified by the provider.","schema":{"type":"string","default":""},"example":"0 or encode({\"last_id\":4059566342166,\"last_value\":\"2021-06-23 22:05:08.525991\"})","allowEmptyValue":true},{"name":"brand","in":"query","required":false,"description":"The brand of the provider you want to filter by. If the account is multi-brand, this parameter is required.\n","schema":{"type":"string","maxLength":255,"minLength":1,"example":"Brand 123"}},{"name":"search","in":"query","description":"The product name or any string related to product.","required":false,"schema":{"type":"string","default":"","x-search_operators":["*"],"x-search_fields":["title","description"]},"example":"black dress","allowEmptyValue":true}],"responses":{"200":{"description":"The list of found products.","content":{"application/json":{"schema":{"type":"object","description":"Represents the paginated list of products","required":["_embedded","_links"],"properties":{"_embedded":{"type":"object","properties":{"products":{"type":"array","description":"The list of products in the current page","items":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the product","example":"product123"},"title":{"type":"string","description":"The default title of the product. It is only displayed if the selected product variant doesn't have a title defined.","example":"Linen dress"},"brand":{"type":"string","description":"The brand of the provider","example":"Brand 123"},"description":{"type":"string","description":"The product description"},"default_variant_id":{"type":"string","description":"The ID of the product variant to be presented by default","example":"productVariant123"},"default_image_id":{"type":"string","description":"The ID of the product image to be presented by default","example":"productImage123"},"images":{"type":"array","description":"The list of product images","default":[],"items":{"type":"object","required":["id","image_url"],"properties":{"id":{"type":"string","description":"The ID of the product image","example":"productImage123"},"image_url":{"type":"string","description":"The URL of the product image","format":"uri","example":"https://external-integration.url.com/product_image.png"}}}},"options":{"type":"array","description":"The list of product options","default":[],"items":{"type":"object","required":["name","values"],"properties":{"name":{"type":"string","description":"The name of the product option","example":"Color"},"values":{"type":"array","description":"The list of possible values for the product option","example":["White","Black","Red","Purple"],"items":{"type":"string"}}}}},"variants":{"type":"array","description":"The list of product variants. The maximum number of product variants is the amount of possible option values combinations. There may be some combinations that are not manufactured/sold, and so there may be some variants missing from the list.","default":[],"items":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the product variant","example":"productVariant123"},"sku":{"type":"string","description":"The SKU of the product variant","example":"productVariant123Sku"},"price":{"type":"object","description":"The price of the product variant","allOf":[{"type":"object","description":"Represents an amount of money in a given currency","required":["value","currency"],"properties":{"value":{"type":"number","description":"The amount of money","format":"double","example":10.5},"currency":{"type":"string","description":"The currency of the money amount","example":"EUR"}}}]},"images_ids":{"type":"array","description":"The list of IDs of the images associated with the product variant","default":[],"example":["productImage123","productImage456"],"items":{"type":"string"}},"options":{"type":"object","description":"The map of option values that correspond to this product variant. A variant can only have a single value for each option and all options must be present (have a value).","additionalProperties":{"type":"string"},"example":{"Color":"White","Size":"XS"}},"available_quantity":{"type":"integer","format":"int64","description":"The product's variant quantity available in stock","default":0,"example":1000,"minimum":1,"maximum":100}}}},"custom_fields":{"type":"object","description":"The custom fields associated with the provider","additionalProperties":true}}}}}},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"uri","example":"http://api-docs.talkdesk.org/erc/ecommerce/workspace/products?limit=2"}}},"next":{"type":"object","properties":{"href":{"type":"string","format":"uri","example":"http://api-docs.talkdesk.org/erc/ecommerce/workspace/products?limit=2&cursor=eyJsYXN0X2lkIjoxMjQ4MzU4NTYzODYyLCJsYXN0X3ZhbHVlIjoiMjAxOS0wNi0xNyAwMjoyMzo0Mi4wMDAwMDAifQ=="}}}}}}},"examples":{"Valid Order List":{"value":{"_embedded":{"products":[{"id":"product123","title":"Linen dress","brand":"Brand 123","description":"This is the description of an example linen dress","default_variant_id":"product123Variant10","default_image_id":"product123image1","images":[{"id":"product123image1","image_url":"https://external-integration.url.com/procuct123-image1.jpg"},{"id":"product123image2","image_url":"https://external-integration.url.com/procuct123-image2.jpg"},{"id":"product123image3","image_url":"https://external-integration.url.com/procuct123-image3.jpg"},{"id":"product123image4","image_url":"https://external-integration.url.com/procuct123-image4.jpg"}],"options":[{"name":"Color","values":["White","Black","Red","Purple"]},{"name":"Size","values":["XS","S","M","L","XL"]}],"variants":[{"id":"product123Variant1","sku":"1234/567","price":{"value":25.99,"currency":"EUR"},"images_ids":["product123image1","product123image2"],"options":{"Color":"White","Size":"XS"},"available_quantity":100},{"id":"product123Variant2","sku":"1234/568","price":{"value":25.99,"currency":"EUR"},"images_ids":["product123image1","product123image2"],"options":{"Color":"White","Size":"S"},"available_quantity":100},{"id":"product123Variant3","sku":"1234/569","price":{"value":25.99,"currency":"EUR"},"images_ids":["product123image1","product123image2"],"options":{"Color":"White","Size":"M"},"available_quantity":100},{"id":"product123Variant4","sku":"1234/570","price":{"value":25.99,"currency":"EUR"},"images_ids":["product123image1","product123image2"],"options":{"Color":"White","Size":"L"},"available_quantity":100},{"id":"product123Variant5","sku":"1234/571","price":{"value":25.99,"currency":"EUR"},"images_ids":["product123image1","product123image2"],"options":{"Color":"White","Size":"XL"},"available_quantity":100},{"id":"product123Variant6","sku":"1234/572","price":{"value":29.99,"currency":"EUR"},"images_ids":["product123image1","product123image3"],"options":{"Color":"Black","Size":"XS"},"available_quantity":100},{"id":"product123Variant7","sku":"1234/573","price":{"value":29.99,"currency":"EUR"},"images_ids":["product123image1","product123image3"],"options":{"Color":"Black","Size":"S"},"available_quantity":100},{"id":"product123Variant8","sku":"1234/574","price":{"value":29.99,"currency":"EUR"},"images_ids":["product123image1","product123image3"],"options":{"Color":"Black","Size":"M"},"available_quantity":100},{"id":"product123Variant9","sku":"1234/575","price":{"value":29.99,"currency":"EUR"},"images_ids":["product123image1","product123image3"],"options":{"Color":"Black","Size":"L"},"available_quantity":100},{"id":"product123Variant10","sku":"1234/576","price":{"value":29.99,"currency":"EUR"},"images_ids":["product123image1","product123image3"],"options":{"Color":"Black","Size":"XL"},"available_quantity":50},{"id":"product123Variant11","sku":"1234/577","price":{"value":50.99,"currency":"EUR"},"images_ids":["product123image1"],"options":{"Color":"Red","Size":"M"},"available_quantity":10}],"custom_fields":{}},{"id":"product456","title":"Floral print dress","description":"This is the description of an example floral print dress","default_variant_id":"product456Variant1","default_image_id":"product456image1","images":[{"id":"product456image1","image_url":"https://external-integration.url.com/procuct456-image1.jpg"}],"options":[{"name":"Color","values":["White"]},{"name":"Size","values":["S","M"]}],"variants":[{"id":"product456Variant1","sku":"1235/567","price":{"value":10,"currency":"EUR"},"images_ids":["product456image1"],"options":{"Color":"White","Size":"S"},"available_quantity":200},{"id":"product456Variant2","sku":"1235/568","price":{"value":10,"currency":"EUR"},"images_ids":["product456image1"],"options":{"Color":"White","Size":"M"},"available_quantity":100}],"custom_fields":{}}]},"_links":{"self":{"href":"http://api-docs.talkdesk.org/erc/ecommerce/workspace/products?limit=2"},"next":{"href":"http://api-docs.talkdesk.org/erc/ecommerce/workspace/products?limit=2&cursor=eyJsYXN0X2lkIjoxMjQ4MzU4NTYzODYyLCJsYXN0X3ZhbHVlIjoiMjAxOS0wNi0xNyAwMjoyMzo0Mi4wMDAwMDAifQ=="}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234010","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234030","message":"Required scopes are missing."}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234040","message":"Resource not found."}}}},"405":{"description":"Method not supported","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234050","message":"Method not allowed."}}}}}}},"/erc/ecommerce/connections/customers/{customer_id}/orders/{order_id}/items":{"get":{"operationId":"ercEcommerceConnectionsGetCustomerOrderItems","tags":["ERC ECommerce Connections"],"description":"Read the ERC e-commerce connections customer order items for the provided customer id and order id. BigCommerce and Shopify's Integration shops support only some parameters and responses, and the Customers Bridge supports all parameters and responses.","summary":"Read the ERC e-commerce connections customer order items for the provided customer id and order id.","security":[{"GA":["erc-ecommerce-connections-orders:read"]}],"parameters":[{"name":"customer_id","in":"path","required":true,"description":"The customer id","schema":{"type":"string","maxLength":255,"minLength":1,"example":"customer123"}},{"name":"order_id","in":"path","required":true,"description":"The order id","schema":{"type":"string","maxLength":255,"minLength":1,"example":"order789"}},{"name":"brand","in":"query","required":false,"description":"The brand of the provider you want to filter by. If the account is multi-brand, this parameter is required.\n","schema":{"type":"string","maxLength":255,"minLength":1,"example":"Brand 123"}},{"name":"carrier","in":"query","description":"[Only supported on Customers Bridge] This refers to the shipping carrier or courier service that is handling the delivery of the item.","required":false,"schema":{"type":"string","maxLength":255,"minLength":1,"example":"FedEx"}},{"name":"delivery_type","in":"query","description":"[Only supported on Customers Bridge] The method of delivery used for the shipment.","required":false,"schema":{"type":"string","maxLength":255,"minLength":1,"example":"Store delivery"}},{"name":"delivery_date_start","in":"query","description":"[Only supported on Customers Bridge] The start date of the delivery window, indicating when the shipment is expected to begin its delivery process. This is when the carrier will start the delivery journey or the delivery window opens.","required":false,"schema":{"type":"string","maxLength":255,"minLength":1,"example":"2025-02-21T12:16:50.078Z"}},{"name":"delivery_date_end","in":"query","description":"[Only supported on Customers Bridge] The end date of the delivery window, indicating when the shipment is expected to be delivered or when the delivery window closes. This shows the expected timeframe for the delivery to be completed.","required":false,"schema":{"type":"string","maxLength":255,"minLength":1,"example":"2025-02-28T12:16:50.078Z"}},{"name":"shipping_date","in":"query","description":"[Only supported on Customers Bridge] The date when the shipment was actually shipped out. This is when the order was dispatched from the warehouse or fulfillment center.","required":false,"schema":{"type":"string","maxLength":255,"minLength":1,"example":"2025-02-21T12:16:50.078Z"}},{"name":"description","in":"query","description":"[Only supported on Customers Bridge] A text description providing more context or details about the shipment.","required":false,"schema":{"type":"string","maxLength":255,"minLength":1,"example":"This shipment will be delivered by FedEx."}},{"name":"limit","in":"query","description":"The amount of order items we want to get","required":true,"schema":{"type":"integer","example":5,"minimum":1,"maximum":100,"default":50}},{"name":"order_by","in":"query","description":"The parameter to be sorted for. If descending order, use order_by=key1:desc if ascending, use order_by=key1:asc","schema":{"type":"string","maxLength":255,"minLength":1,"x-sorting_default_order":"asc","x-sorting_fields":["price","id"]},"example":["price:desc","id:asc"],"allowEmptyValue":true}],"responses":{"200":{"description":"The list of customer order items found for the provided customer id and order id.","content":{"application/json":{"schema":{"type":"object","description":"Represents the complete list of customer order items","required":["_embedded","_links"],"properties":{"_embedded":{"required":["items"],"type":"object","properties":{"items":{"type":"array","description":"The list of order items","items":{"type":"object","description":"Represents an item that was ordered","required":["id","name","price"],"properties":{"id":{"type":"string","description":"The ID of the item","example":"orderItem789"},"name":{"type":"string","description":"The name of the item","example":"Order Item 789"},"description":{"type":"string","description":"The description of the item","example":"Description of order Item 789"},"brand":{"type":"string","description":"The brande of the item","example":"Brand 123"},"price":{"description":"The price of the item","allOf":[{"type":"object","description":"Represents an amount of money in a given currency","required":["value","currency"],"properties":{"value":{"type":"number","description":"The amount of money","format":"double","example":10.5},"currency":{"type":"string","description":"The currency of the money amount","example":"EUR"}}}]},"image_url":{"type":"string","description":"The URL of the item image/picture","format":"uri","example":"https://external-integration.url.com/order_item_icon.png"},"quantity":{"type":"integer","format":"int64","description":"The quantity of the item","example":10,"minimum":1,"maximum":100},"sku":{"type":"string","description":"The sku of the item","example":"Sku 123"},"deliverable_quantity":{"type":"integer","description":"The quantity of order items that are yet to be delivered/processed","format":"int64","example":10,"minimum":1,"maximum":100},"deliveries":{"type":"array","description":"List of deliveries where the item is inserted","items":{"allOf":[{"type":"object","description":"Represents a order item delivery resource","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the order delivery","example":"orderDelivery123"},"delivery_quantity":{"type":"integer","format":"int64","description":"The quantity of items associated with the delivery","example":10,"minimum":1,"maximum":100},"carrier":{"type":"string","description":"[Only supported on Customers Bridge] This refers to the shipping carrier or courier service that is handling the delivery of the item.","example":"FedEx"},"delivery_type":{"type":"string","description":"[Only supported on Customers Bridge] The method of delivery used for the shipment.","example":"Store delivery"},"delivery_date_start":{"type":"string","description":"[Only supported on Customers Bridge] The start date of the delivery window, indicating when the shipment is expected to begin its delivery process. This is when the carrier will start the delivery journey or the delivery window opens.","format":"date-time","example":"2025-02-21T12:16:50.078Z"},"delivery_date_end":{"type":"string","description":"[Only supported on Customers Bridge] The end date of the delivery window, indicating when the shipment is expected to be delivered or when the delivery window closes. This shows the expected timeframe for the delivery to be completed.","format":"date-time","example":"2025-02-28T12:16:50.078Z"},"shipping_date":{"type":"string","description":"[Only supported on Customers Bridge] The date when the shipment was actually shipped out. This is when the order was dispatched from the warehouse or fulfillment center.","example":"2025-02-21T12:16:50.078Z"},"service_level":{"type":"string","description":"[Only supported on Customers Bridge] Indicates the level of service for the delivery, which represents the default or basic shipping option.","example":"Standard"},"description":{"type":"string","description":"[Only supported on Customers Bridge] A text description providing more context or details about the shipment.","example":"This shipment will be delivered by FedEx."},"latest_status_info":{"description":"The latest delivery status information","allOf":[{"type":"object","description":"Represents a status info state/step for a given order delivery","required":["type"],"properties":{"type":{"type":"string","description":"The type of the state/step","example":["UNKNOWN","ATTEMPTED_DELIVERY","READY_FOR_PICKUP","PICKED_UP","CONFIRMED","IN_TRANSIT","OUT_FOR_DELIVERY","DELIVERED","FAILURE"]},"status_date_time":{"type":"string","description":"The timestamp date when the status info state/step was 'reached'","format":"date-time","example":"2021-10-23T12:16:50.078Z"}}}]},"tracking_info":{"description":"The tracking information associated with the order delivery","allOf":[{"type":"object","description":"The tracking information associated with the order delivery","required":["tracking_number"],"properties":{"tracking_number":{"type":"string","description":"The tracking number associated with the order delivery","example":"#USPS 123456789"},"external_url":{"type":"string","description":"The URL of the external system where we can get more tracking details (ex: the URL of the carrier)","format":"uri","example":"https://external.url.com/"}}}]},"last_update":{"type":"string","description":"The timestamp date when the order delivery was last updated","format":"date-time","example":"2021-09-14T12:16:50.078Z"}}}]}},"custom_fields":{"type":"object","description":"The custom fields associated with the provider","additionalProperties":true}}}},"refunds":{"type":"array","description":"The list of order refunds","items":{"type":"object","description":"Represents a refund for an item of an order","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the refund","example":"refund123"},"created_at":{"type":"string","format":"date-time","description":"The creation time of the refund","example":"2024-06-01T12:00:00Z"},"updated_at":{"type":"string","format":"date-time","description":"The last update time of the refund","example":"2024-06-02T12:00:00Z"},"note":{"type":"string","description":"Additional notes about the refund","example":"Customer requested refund due to damaged item"},"order_adjustments":{"type":"array","description":"List of adjustments applied to the order","items":{"allOf":[{"type":"object","description":"Represents an adjustment applied to the order","required":["id","amount","currency"],"properties":{"id":{"type":"string","description":"The ID of the adjustment","example":"adj123"},"reason":{"type":"string","description":"The reason for the adjustment","example":"Promotion discount"},"amount":{"type":"number","format":"double","description":"The amount of the adjustment","example":10.5},"currency":{"type":"string","description":"The currency of the adjustment","example":"USD"}}}]}},"refund_line_items":{"type":"array","description":"List of refunded line items","items":{"allOf":[{"type":"object","description":"Represents a refunded line item in the order","required":["line_item_id","quantity","amount","currency"],"properties":{"line_item_id":{"type":"string","description":"The ID of the refunded line item","example":"item456"},"quantity":{"type":"integer","description":"The quantity refunded","example":2},"amount":{"type":"number","format":"double","description":"The refund amount for this line item","example":20},"currency":{"type":"string","description":"The currency of the refund","example":"USD"}}}]}},"transactions":{"type":"array","description":"List of refund transactions","items":{"allOf":[{"type":"object","description":"Represents a transaction for the refund","required":["id","amount","currency","kind"],"properties":{"id":{"type":"string","description":"The ID of the refund transaction","example":"txn789"},"created_at":{"type":"string","format":"date-time","description":"The creation time of the transaction","example":"2024-06-01T12:00:00Z"},"amount":{"type":"number","format":"double","description":"The amount refunded in this transaction","example":20},"currency":{"type":"string","description":"The currency of the transaction","example":"USD"},"gateway":{"type":"string","description":"The payment gateway used","example":"Stripe"},"kind":{"type":"string","description":"The kind of transaction","example":"refund"},"payment_detail":{"type":"object","properties":{"card_brand":{"type":"string","description":"The payment card brand of the order","example":"Visa"},"card_brand_image_url":{"type":"string","description":"The icon of payment card brand","example":"https://external-integration.url.com/payment_card_brand_icon.svg"},"card_number":{"type":"string","description":"The number of payment card","example":"**** **** **** *567"},"is_refunded":{"type":"boolean","description":"The flag to indicate if order is refunded","example":false}}}}}]}},"shipping_lines":{"type":"array","description":"List of refunded shipping fees","items":{"allOf":[{"type":"object","description":"Represents a refunded shipping fee","required":["id","amount","currency"],"properties":{"id":{"type":"string","description":"The ID of the shipping fee","example":"ship123"},"amount":{"type":"number","format":"double","description":"The amount refunded for shipping","example":5},"currency":{"type":"string","description":"The currency of the shipping fee","example":"USD"}}}]}}}}},"returns":{"type":"array","description":"The list of order returns","items":{"type":"object","description":"Represents a return of an order","required":["id","name","status"],"properties":{"id":{"type":"string","description":"The ID of the order return","example":"return123"},"name":{"type":"string","description":"The name of the order return","example":"Order Return 123"},"status":{"type":"string","description":"The status of the order return","example":"approved"},"closed_at":{"type":"string","format":"date-time","description":"The time when the return was closed","example":"2024-06-03T10:00:00Z"},"created_at":{"type":"string","format":"date-time","description":"The creation time of the order return","example":"2024-06-01T12:00:00Z"},"request_approved_at":{"type":"string","format":"date-time","description":"The time when the return request was approved","example":"2024-06-02T09:00:00Z"},"refund_ids":{"type":"array","description":"List of refund IDs associated with this return","items":{"type":"string"},"example":["refund1","refund2"]},"return_line_items":{"type":"array","description":"List of returned line items","items":{"type":"object","description":"Represents a returned line item","required":["id","line_item_id","quantity","processed_quantity"],"properties":{"id":{"type":"string","description":"The ID of the return line item","example":"rli123"},"line_item_id":{"type":"string","description":"The ID of the original line item","example":"item456"},"quantity":{"type":"integer","description":"The quantity returned","example":2},"processed_quantity":{"type":"integer","description":"The quantity processed for return","example":2},"return_reason":{"type":"string","description":"The reason for the return","example":"Defective product"},"return_reason_note":{"type":"string","description":"Additional notes for the return reason","example":"Screen cracked"},"customer_note":{"type":"string","description":"Customer's note for the return","example":"Please process quickly"},"restocking_fee":{"type":"object","description":"Represents a restocking fee for returned items","required":["percentage","amount","currency"],"properties":{"id":{"type":"string","description":"ID of the restocking fee","example":"fee123"},"percentage":{"type":"number","format":"double","description":"Restocking fee percentage","example":10},"amount":{"type":"number","format":"double","description":"Restocking fee amount","example":5},"currency":{"type":"string","description":"Currency of the restocking fee","example":"USD"}}}}}},"shipping_fees":{"type":"array","description":"List of shipping fees for the return","items":{"type":"object","description":"Represents a refunded shipping fee","required":["id","amount","currency"],"properties":{"id":{"type":"string","description":"The ID of the shipping fee","example":"ship123"},"amount":{"type":"number","format":"double","description":"The amount refunded for shipping","example":5},"currency":{"type":"string","description":"The currency of the shipping fee","example":"USD"}}}},"exchange_line_items":{"type":"array","description":"List of exchanged line items","items":{"type":"object","description":"Represents an exchanged line item","required":["id","line_item_ids","quantity","processed_quantity"],"properties":{"id":{"type":"string","description":"The ID of the exchange line item","example":"ex123"},"line_item_ids":{"type":"array","description":"List of original line item IDs","items":{"type":"string"},"example":["item456","item789"]},"quantity":{"type":"integer","description":"The quantity exchanged","example":1},"processed_quantity":{"type":"integer","description":"The quantity processed for exchange","example":1},"product_variant":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the product variant","example":"productVariant123"},"sku":{"type":"string","description":"The SKU of the product variant","example":"productVariant123Sku"},"price":{"type":"object","description":"The price of the product variant","allOf":[{"type":"object","description":"Represents an amount of money in a given currency","required":["value","currency"],"properties":{"value":{"type":"number","description":"The amount of money","format":"double","example":10.5},"currency":{"type":"string","description":"The currency of the money amount","example":"EUR"}}}]},"images_ids":{"type":"array","description":"The list of IDs of the images associated with the product variant","default":[],"example":["productImage123","productImage456"],"items":{"type":"string"}},"options":{"type":"object","description":"The map of option values that correspond to this product variant. A variant can only have a single value for each option and all options must be present (have a value).","additionalProperties":{"type":"string"},"example":{"Color":"White","Size":"XS"}},"available_quantity":{"type":"integer","format":"int64","description":"The product's variant quantity available in stock","default":0,"example":1000,"minimum":1,"maximum":100}}}}}},"decline":{"type":"object","description":"Represents a declined return","required":["reason"],"properties":{"note":{"type":"string","description":"The note where the decline happened","example":"warehouse"},"reason":{"type":"string","description":"The reason for the decline","example":"Item not eligible for return"}}},"tracking_info":{"type":"array","description":"The tracking information associated with the return","items":{"type":"object","description":"The tracking information associated with the return","required":["tracking_number"],"properties":{"tracking_number":{"type":"string","description":"The tracking number associated with the return","example":"#USPS 123456789"},"external_url":{"type":"string","description":"The URL of the external system where we can get more tracking details (ex: the URL of the carrier)","format":"uri","example":"https://external.url.com/"}}}}}}}}},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"uri","example":"http://api-docs.talkdesk.org/erc/ecommerce/connections/customers/customer123/orders/order789/items?limit=2&order_by=price:desc"}}}}}}},"examples":{"Valid Order Items Status List":{"value":{"_embedded":{"items":[{"id":"orderItem123","brand":"Brand 123","name":"Order Item 123","description":"Description of order Item 123","price":{"value":100,"currency":"GBP"},"image_url":"https://external-integration.url.com/order_item_icon.png","quantity":10,"deliverable_quantity":0,"sku":"Sku 123","custom_fields":{}},{"id":"orderItem456","brand":"Brand 123","name":"Order Item 456","description":"Description of order Item 456","price":{"value":23.75,"currency":"USD"},"image_url":"https://external-integration.url.com/order_item_icon.png","quantity":20,"deliverable_quantity":0,"sku":"Sku 456","custom_fields":{}},{"id":"orderItem678","brand":"Brand 123","name":"Order Item 678","description":"Description of order Item 678","price":{"value":12.49,"currency":"GBP"},"image_url":"https://external-integration.url.com/order_item_icon.png","quantity":30,"deliverable_quantity":20,"sku":"Sku 678","deliveries":[{"id":"orderDelivery123","delivery_quantity":10,"carrier":"FedEx","delivery_type":"Store delivery","delivery_date_start":"2025-02-21T12:16:50.078Z","delivery_date_end":"2025-02-28T12:16:50.078Z","shipping_date":"2025-02-21T12:16:50.078Z","service_level":"Standard","description":"This shipment will be delivered by FedEx.","latest_status_info":{"type":"CONFIRMED","status_date_time":"2021-10-23T12:16:50.078Z"},"tracking_info":{"tracking_number":"#USPS 123456789","external_url":"https://external-carrier-url"},"last_update":"2021-10-24T12:16:50.078Z"}],"custom_fields":{}}],"refunds":[{"id":"refund001","created_at":"2025-02-22T10:00:00Z","updated_at":"2025-02-22T10:10:00Z","note":"Customer requested partial refund.","order_adjustments":[{"id":"adj001","reason":"PRICE_MATCH","amount":5,"currency":"GBP"}],"refund_line_items":[{"line_item_id":"orderItem123","quantity":1,"amount":100,"currency":"GBP"}],"transactions":[{"id":"txn001","created_at":"2025-02-22T10:05:00Z","amount":100,"currency":"GBP","gateway":"stripe","kind":"REFUND","payment_detail":{"card_brand":"VISA","card_brand_image_url":"https://cdn.example.com/visa.png","card_number":"**** **** **** 4242","is_refunded":true}}],"shipping_lines":[{"id":"shipfee001","amount":0,"currency":"GBP"}]}],"returns":[{"id":"return001","name":"RT-1001","status":"OPEN","closed_at":null,"created_at":"2025-02-23T09:00:00Z","request_approved_at":"2025-02-23T12:00:00Z","refund_ids":["refund001"],"return_line_items":[{"id":"returnLine001","line_item_id":"orderItem456","quantity":2,"processed_quantity":0,"return_reason":"DAMAGED","return_reason_note":"Box dented","customer_note":"Please process quickly","restocking_fee":{"id":"rf001","percentage":0,"amount":0,"currency":"USD"}}],"shipping_fees":[{"id":"returnShip001","amount":0,"currency":"USD"}],"exchange_line_items":[{"id":"exch001","line_item_ids":["orderItem456"],"quantity":2,"processed_quantity":0,"product_variant":{"id":"variant-new-456","sku":"Sku 456-NEW","price":{"value":25,"currency":"USD"},"images_ids":["img123"],"options":{"color":"Blue","size":"M"},"available_quantity":50}}],"decline":{"note":"Customer changed mind","reason":"NO_LONGER_WANTED"},"tracking_info":[{"tracking_number":"#FEDEX 987654321","external_url":"https://fedex.com/track/987654321"},{"tracking_number":"#FEDEX 987654322","external_url":"https://fedex.com/track/987654322"}]}]},"_links":{"self":{"href":"http://api-docs.talkdesk.org/erc/ecommerce/connections/customers/customer123/orders/order789/items"}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234010","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234030","message":"Required scopes are missing."}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234040","message":"Resource not found."}}}},"405":{"description":"Method not supported","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234050","message":"Method not allowed."}}}}}}},"/erc/ecommerce/connections/customers/{customer_id}/orders/{order_id}/items/cancel":{"put":{"operationId":"ercEcommerceConnectionsCancelCustomerOrderItems","tags":["ERC ECommerce Connections"],"description":"Cancel items from the ERC e-commerce customer order with the provided customer ID and order ID.

    Integration shops
    • Customers Bridge -> Not Supported.
    • BigCommerce -> Supported.
    • Shopify -> Not Supported.
    ","summary":"Cancel items from the ERC e-commerce customer order with the provided customer ID and order ID.","security":[{"GA":["erc-ecommerce-connections-orders:write"]}],"parameters":[{"name":"customer_id","in":"path","required":true,"description":"The customer id","schema":{"type":"string","minLength":1,"example":"customer123"}},{"name":"order_id","in":"path","required":true,"description":"The order id","schema":{"type":"string","minLength":1,"example":"order789"}},{"name":"brand","in":"query","required":false,"description":"The brand of the provider you want to filter by. If the account is multi-brand, this parameter is required.\n","schema":{"type":"string","maxLength":255,"minLength":1,"example":"Brand 123"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"type":"array","description":"The list of order item ids to be cancelled","items":{"type":"string","minLength":1},"example":["orderItem123","orderItem456","orderItem678"]}}}}}},"responses":{"200":{"description":"The list of customer order items found for the provided customer id and order id.","content":{"application/json":{"schema":{"type":"object","description":"Represents the complete list of customer order items","required":["_embedded","_links"],"properties":{"_embedded":{"required":["items"],"type":"object","properties":{"items":{"type":"array","description":"The list of order items","items":{"type":"object","description":"Represents an item that was ordered","required":["id","name","price"],"properties":{"id":{"type":"string","description":"The ID of the item","example":"orderItem789"},"name":{"type":"string","description":"The name of the item","example":"Order Item 789"},"description":{"type":"string","description":"The description of the item","example":"Description of order Item 789"},"brand":{"type":"string","description":"The brande of the item","example":"Brand 123"},"price":{"description":"The price of the item","allOf":[{"type":"object","description":"Represents an amount of money in a given currency","required":["value","currency"],"properties":{"value":{"type":"number","description":"The amount of money","format":"double","example":10.5},"currency":{"type":"string","description":"The currency of the money amount","example":"EUR"}}}]},"image_url":{"type":"string","description":"The URL of the item image/picture","format":"uri","example":"https://external-integration.url.com/order_item_icon.png"},"quantity":{"type":"integer","format":"int64","description":"The quantity of the item","example":10,"minimum":1,"maximum":100},"sku":{"type":"string","description":"The sku of the item","example":"Sku 123"},"deliverable_quantity":{"type":"integer","description":"The quantity of order items that are yet to be delivered/processed","format":"int64","example":10,"minimum":1,"maximum":100},"deliveries":{"type":"array","description":"List of deliveries where the item is inserted","items":{"allOf":[{"type":"object","description":"Represents a order item delivery resource","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the order delivery","example":"orderDelivery123"},"delivery_quantity":{"type":"integer","format":"int64","description":"The quantity of items associated with the delivery","example":10,"minimum":1,"maximum":100},"carrier":{"type":"string","description":"[Only supported on Customers Bridge] This refers to the shipping carrier or courier service that is handling the delivery of the item.","example":"FedEx"},"delivery_type":{"type":"string","description":"[Only supported on Customers Bridge] The method of delivery used for the shipment.","example":"Store delivery"},"delivery_date_start":{"type":"string","description":"[Only supported on Customers Bridge] The start date of the delivery window, indicating when the shipment is expected to begin its delivery process. This is when the carrier will start the delivery journey or the delivery window opens.","format":"date-time","example":"2025-02-21T12:16:50.078Z"},"delivery_date_end":{"type":"string","description":"[Only supported on Customers Bridge] The end date of the delivery window, indicating when the shipment is expected to be delivered or when the delivery window closes. This shows the expected timeframe for the delivery to be completed.","format":"date-time","example":"2025-02-28T12:16:50.078Z"},"shipping_date":{"type":"string","description":"[Only supported on Customers Bridge] The date when the shipment was actually shipped out. This is when the order was dispatched from the warehouse or fulfillment center.","example":"2025-02-21T12:16:50.078Z"},"service_level":{"type":"string","description":"[Only supported on Customers Bridge] Indicates the level of service for the delivery, which represents the default or basic shipping option.","example":"Standard"},"description":{"type":"string","description":"[Only supported on Customers Bridge] A text description providing more context or details about the shipment.","example":"This shipment will be delivered by FedEx."},"latest_status_info":{"description":"The latest delivery status information","allOf":[{"type":"object","description":"Represents a status info state/step for a given order delivery","required":["type"],"properties":{"type":{"type":"string","description":"The type of the state/step","example":["UNKNOWN","ATTEMPTED_DELIVERY","READY_FOR_PICKUP","PICKED_UP","CONFIRMED","IN_TRANSIT","OUT_FOR_DELIVERY","DELIVERED","FAILURE"]},"status_date_time":{"type":"string","description":"The timestamp date when the status info state/step was 'reached'","format":"date-time","example":"2021-10-23T12:16:50.078Z"}}}]},"tracking_info":{"description":"The tracking information associated with the order delivery","allOf":[{"type":"object","description":"The tracking information associated with the order delivery","required":["tracking_number"],"properties":{"tracking_number":{"type":"string","description":"The tracking number associated with the order delivery","example":"#USPS 123456789"},"external_url":{"type":"string","description":"The URL of the external system where we can get more tracking details (ex: the URL of the carrier)","format":"uri","example":"https://external.url.com/"}}}]},"last_update":{"type":"string","description":"The timestamp date when the order delivery was last updated","format":"date-time","example":"2021-09-14T12:16:50.078Z"}}}]}},"custom_fields":{"type":"object","description":"The custom fields associated with the provider","additionalProperties":true}}}},"refunds":{"type":"array","description":"The list of order refunds","items":{"type":"object","description":"Represents a refund for an item of an order","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the refund","example":"refund123"},"created_at":{"type":"string","format":"date-time","description":"The creation time of the refund","example":"2024-06-01T12:00:00Z"},"updated_at":{"type":"string","format":"date-time","description":"The last update time of the refund","example":"2024-06-02T12:00:00Z"},"note":{"type":"string","description":"Additional notes about the refund","example":"Customer requested refund due to damaged item"},"order_adjustments":{"type":"array","description":"List of adjustments applied to the order","items":{"allOf":[{"type":"object","description":"Represents an adjustment applied to the order","required":["id","amount","currency"],"properties":{"id":{"type":"string","description":"The ID of the adjustment","example":"adj123"},"reason":{"type":"string","description":"The reason for the adjustment","example":"Promotion discount"},"amount":{"type":"number","format":"double","description":"The amount of the adjustment","example":10.5},"currency":{"type":"string","description":"The currency of the adjustment","example":"USD"}}}]}},"refund_line_items":{"type":"array","description":"List of refunded line items","items":{"allOf":[{"type":"object","description":"Represents a refunded line item in the order","required":["line_item_id","quantity","amount","currency"],"properties":{"line_item_id":{"type":"string","description":"The ID of the refunded line item","example":"item456"},"quantity":{"type":"integer","description":"The quantity refunded","example":2},"amount":{"type":"number","format":"double","description":"The refund amount for this line item","example":20},"currency":{"type":"string","description":"The currency of the refund","example":"USD"}}}]}},"transactions":{"type":"array","description":"List of refund transactions","items":{"allOf":[{"type":"object","description":"Represents a transaction for the refund","required":["id","amount","currency","kind"],"properties":{"id":{"type":"string","description":"The ID of the refund transaction","example":"txn789"},"created_at":{"type":"string","format":"date-time","description":"The creation time of the transaction","example":"2024-06-01T12:00:00Z"},"amount":{"type":"number","format":"double","description":"The amount refunded in this transaction","example":20},"currency":{"type":"string","description":"The currency of the transaction","example":"USD"},"gateway":{"type":"string","description":"The payment gateway used","example":"Stripe"},"kind":{"type":"string","description":"The kind of transaction","example":"refund"},"payment_detail":{"type":"object","properties":{"card_brand":{"type":"string","description":"The payment card brand of the order","example":"Visa"},"card_brand_image_url":{"type":"string","description":"The icon of payment card brand","example":"https://external-integration.url.com/payment_card_brand_icon.svg"},"card_number":{"type":"string","description":"The number of payment card","example":"**** **** **** *567"},"is_refunded":{"type":"boolean","description":"The flag to indicate if order is refunded","example":false}}}}}]}},"shipping_lines":{"type":"array","description":"List of refunded shipping fees","items":{"allOf":[{"type":"object","description":"Represents a refunded shipping fee","required":["id","amount","currency"],"properties":{"id":{"type":"string","description":"The ID of the shipping fee","example":"ship123"},"amount":{"type":"number","format":"double","description":"The amount refunded for shipping","example":5},"currency":{"type":"string","description":"The currency of the shipping fee","example":"USD"}}}]}}}}},"returns":{"type":"array","description":"The list of order returns","items":{"type":"object","description":"Represents a return of an order","required":["id","name","status"],"properties":{"id":{"type":"string","description":"The ID of the order return","example":"return123"},"name":{"type":"string","description":"The name of the order return","example":"Order Return 123"},"status":{"type":"string","description":"The status of the order return","example":"approved"},"closed_at":{"type":"string","format":"date-time","description":"The time when the return was closed","example":"2024-06-03T10:00:00Z"},"created_at":{"type":"string","format":"date-time","description":"The creation time of the order return","example":"2024-06-01T12:00:00Z"},"request_approved_at":{"type":"string","format":"date-time","description":"The time when the return request was approved","example":"2024-06-02T09:00:00Z"},"refund_ids":{"type":"array","description":"List of refund IDs associated with this return","items":{"type":"string"},"example":["refund1","refund2"]},"return_line_items":{"type":"array","description":"List of returned line items","items":{"type":"object","description":"Represents a returned line item","required":["id","line_item_id","quantity","processed_quantity"],"properties":{"id":{"type":"string","description":"The ID of the return line item","example":"rli123"},"line_item_id":{"type":"string","description":"The ID of the original line item","example":"item456"},"quantity":{"type":"integer","description":"The quantity returned","example":2},"processed_quantity":{"type":"integer","description":"The quantity processed for return","example":2},"return_reason":{"type":"string","description":"The reason for the return","example":"Defective product"},"return_reason_note":{"type":"string","description":"Additional notes for the return reason","example":"Screen cracked"},"customer_note":{"type":"string","description":"Customer's note for the return","example":"Please process quickly"},"restocking_fee":{"type":"object","description":"Represents a restocking fee for returned items","required":["percentage","amount","currency"],"properties":{"id":{"type":"string","description":"ID of the restocking fee","example":"fee123"},"percentage":{"type":"number","format":"double","description":"Restocking fee percentage","example":10},"amount":{"type":"number","format":"double","description":"Restocking fee amount","example":5},"currency":{"type":"string","description":"Currency of the restocking fee","example":"USD"}}}}}},"shipping_fees":{"type":"array","description":"List of shipping fees for the return","items":{"type":"object","description":"Represents a refunded shipping fee","required":["id","amount","currency"],"properties":{"id":{"type":"string","description":"The ID of the shipping fee","example":"ship123"},"amount":{"type":"number","format":"double","description":"The amount refunded for shipping","example":5},"currency":{"type":"string","description":"The currency of the shipping fee","example":"USD"}}}},"exchange_line_items":{"type":"array","description":"List of exchanged line items","items":{"type":"object","description":"Represents an exchanged line item","required":["id","line_item_ids","quantity","processed_quantity"],"properties":{"id":{"type":"string","description":"The ID of the exchange line item","example":"ex123"},"line_item_ids":{"type":"array","description":"List of original line item IDs","items":{"type":"string"},"example":["item456","item789"]},"quantity":{"type":"integer","description":"The quantity exchanged","example":1},"processed_quantity":{"type":"integer","description":"The quantity processed for exchange","example":1},"product_variant":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the product variant","example":"productVariant123"},"sku":{"type":"string","description":"The SKU of the product variant","example":"productVariant123Sku"},"price":{"type":"object","description":"The price of the product variant","allOf":[{"type":"object","description":"Represents an amount of money in a given currency","required":["value","currency"],"properties":{"value":{"type":"number","description":"The amount of money","format":"double","example":10.5},"currency":{"type":"string","description":"The currency of the money amount","example":"EUR"}}}]},"images_ids":{"type":"array","description":"The list of IDs of the images associated with the product variant","default":[],"example":["productImage123","productImage456"],"items":{"type":"string"}},"options":{"type":"object","description":"The map of option values that correspond to this product variant. A variant can only have a single value for each option and all options must be present (have a value).","additionalProperties":{"type":"string"},"example":{"Color":"White","Size":"XS"}},"available_quantity":{"type":"integer","format":"int64","description":"The product's variant quantity available in stock","default":0,"example":1000,"minimum":1,"maximum":100}}}}}},"decline":{"type":"object","description":"Represents a declined return","required":["reason"],"properties":{"note":{"type":"string","description":"The note where the decline happened","example":"warehouse"},"reason":{"type":"string","description":"The reason for the decline","example":"Item not eligible for return"}}},"tracking_info":{"type":"array","description":"The tracking information associated with the return","items":{"type":"object","description":"The tracking information associated with the return","required":["tracking_number"],"properties":{"tracking_number":{"type":"string","description":"The tracking number associated with the return","example":"#USPS 123456789"},"external_url":{"type":"string","description":"The URL of the external system where we can get more tracking details (ex: the URL of the carrier)","format":"uri","example":"https://external.url.com/"}}}}}}}}},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"uri","example":"http://api-docs.talkdesk.org/erc/ecommerce/connections/customers/customer123/orders/order789/items?limit=2&order_by=price:desc"}}}}}}},"examples":{"Valid Order Items Status List":{"value":{"_embedded":{"items":[{"id":"orderItem123","brand":"Brand 123","name":"Order Item 123","description":"Description of order Item 123","price":{"value":100,"currency":"GBP"},"image_url":"https://external-integration.url.com/order_item_icon.png","quantity":0,"deliverable_quantity":0,"sku":"Sku 123","custom_fields":{}},{"id":"orderItem456","brand":"Brand 123","name":"Order Item 456","description":"Description of order Item 456","price":{"value":23.75,"currency":"USD"},"image_url":"https://external-integration.url.com/order_item_icon.png","quantity":0,"deliverable_quantity":0,"sku":"Sku 456","custom_fields":{}},{"id":"orderItem678","brand":"Brand 123","name":"Order Item 678","description":"Description of order Item 678","price":{"value":12.49,"currency":"GBP"},"image_url":"https://external-integration.url.com/order_item_icon.png","quantity":0,"deliverable_quantity":20,"sku":"Sku 678","deliveries":[{"id":"orderDelivery123","delivery_quantity":10,"latest_status_info":{"type":"CONFIRMED","status_date_time":"2021-10-23T12:16:50.078Z"},"tracking_info":{"tracking_number":"#USPS 123456789","external_url":"https://external-carrier-url"},"last_update":"2021-10-24T12:16:50.078Z"}],"custom_fields":{}}]},"_links":{"self":{"href":"http://api-docs.talkdesk.org/erc/ecommerce/connections/customers/customer123/orders/order789/items"}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234010","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234030","message":"Required scopes are missing."}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234040","message":"Resource not found."}}}},"405":{"description":"Method not supported","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234050","message":"Method not allowed."}}}}}}},"/erc/ecommerce/connections/customers/cart":{"get":{"tags":["ERC ECommerce Connections"],"description":"Read the ERC e-commerce cart of customer by the one of customer_id and cart_id.","security":[{"GA":["erc-ecommerce-connections-customers:read"]}],"parameters":[{"name":"customer_id","in":"query","description":"The id of customer","required":false,"schema":{"type":"string"},"example":"4238-8d21-06f794a0c68c-7c357571-84bc","allowEmptyValue":true},{"name":"cart_id","in":"query","description":"The id of customer cart","required":false,"schema":{"type":"string","example":"f251d341-b9ac-4b5c-a586-9534469dc2e7"}},{"name":"brand","in":"query","required":false,"description":"The brand of the provider you want to filter by. If the account is multi-brand, this parameter is required.\n","schema":{"type":"string","maxLength":255,"minLength":1,"example":"Brand 123"}}],"responses":{"200":{"description":"The cart data found with the provided customer_id or cart_id.","content":{"application/json":{"schema":{"allOf":[{"required":["cart_id"],"type":"object","description":"Represents an cart of a customer","properties":{"cart_id":{"type":"string","description":"The ID of the cart"},"customer_id":{"type":"string","description":"The ID of the customer"},"total_quantity":{"type":"string","description":"The total quantity in the cart"},"currency":{"type":"string","description":"The currency of the cart"},"cart_status":{"type":"string","description":"The status of the cart"},"created_time":{"type":"string","format":"date-time","description":"The time when the cart was created"},"updated_time":{"type":"string","format":"date-time","description":"The time when the cart was last updated"},"cost":{"type":"object","required":["final_amount"],"properties":{"base_amount":{"type":"string","description":"The base amount"},"discounts_amount":{"type":"string","description":"The discounts amount"},"final_amount":{"type":"string","description":"The final amount"},"taxes_amount":{"type":"string","description":"The taxes amount"}}},"cart_discounts":{"type":"array","items":{"type":"object","required":["discounted_amount","discount_name","type"],"properties":{"discounted_amount":{"type":"string","description":"The discounted amount"},"type":{"type":"string","description":"The type of discount"},"discount_code":{"type":"string","description":"The discount code"},"discount_name":{"type":"string","description":"The name of the discount"},"discount_description":{"type":"string","description":"The description of the discount"}}}},"cart_lines":{"type":"array","items":{"type":"object","required":["line_id","variant_id","variant_title","product_id","sku","default_image","cost"],"properties":{"line_id":{"type":"string","description":"The ID of the line"},"variant_id":{"type":"string","description":"The ID of the variant"},"variant_title":{"type":"string","description":"The title of the variant"},"product_id":{"type":"string","description":"The ID of the product"},"sku":{"type":"string","description":"The SKU"},"default_image":{"type":"string","description":"The URL of the default image"},"quantity_available":{"type":"string","description":"The quantity available"},"quantity":{"type":"string","description":"The quantity"},"url":{"type":"string","description":"The URL"},"cost":{"type":"object","required":["final_amount"],"properties":{"base_amount":{"type":"string","description":"The base amount"},"discounts_amount":{"type":"string","description":"The discounts amount"},"final_amount":{"type":"string","description":"The final amount"},"taxes_amount":{"type":"string","description":"The taxes amount"}}},"cart_lines_discounts":{"type":"array","items":{"type":"object","required":["discounted_amount","discount_name","type"],"properties":{"discounted_amount":{"type":"string","description":"The discounted amount"},"type":{"type":"string","description":"The type of discount"},"discount_code":{"type":"string","description":"The discount code"},"discount_name":{"type":"string","description":"The name of the discount"},"discount_description":{"type":"string","description":"The description of the discount"}}}}}}},"brand":{"type":"string","description":"The brand of the provider","example":"Brand 123"},"custom_fields_type":{"type":"string","description":"The type of custom fields"},"custom_fields":{"type":"object","description":"The custom fields associated with the provider","additionalProperties":true},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","description":"The link to the cart"}}}}}}}]},"examples":{"Valid Order List":{"value":{"cart_id":"7c357571-84bc-4238-8d21-06f794a0c68c","customer_id":"0","total_quantity":"5","currency":"USD","cart_status":"ACTIVE","created_time":"2024-02-22T07:35:51+00:00","updated_time":"2024-03-05T07:20:01+00:00","cost":{"base_amount":"587.85","discounts_amount":"0","final_amount":"646.64","taxes_amount":"58.79"},"cart_discounts":[{"discounted_amount":"0","type":"DISCOUNT","discount_code":"1363c133-c9d2-4cf0-bdb3-2f67c240f9ce","discount_name":"Discount","discount_description":"Discount"},{"discounted_amount":"0","type":"DISCOUNT","discount_code":"936344d3-623a-494a-acc4-909f821d9f39","discount_name":"Discount","discount_description":"Discount"}],"cart_lines":[{"line_id":"1363c133-c9d2-4cf0-bdb3-2f67c240f9ce","variant_id":"72","variant_title":"Utility Caddy","product_id":"104","sku":"OFSUC","default_image":"https://cdn11.bigcommerce.com/s-j4haierfig/products/104/images/336/utilitybucket1.1688152579.220.290.jpg?c=1","quantity_available":"0","quantity":"3","url":"https://talkdesk-retail-dev.mybigcommerce.com/utility-caddy/","cost":{"base_amount":"45.95","discounts_amount":"0","final_amount":"45.95","taxes_amount":"0"},"cart_lines_discounts":[{"discounted_amount":"0","type":"DISCOUNT","discount_code":"1363c133-c9d2-4cf0-bdb3-2f67c240f9ce","discount_name":"Discount","discount_description":"Discount"}]},{"line_id":"936344d3-623a-494a-acc4-909f821d9f39","variant_id":"66","variant_title":"[Sample] Able Brewing System","product_id":"86","sku":"ABS","default_image":"https://cdn11.bigcommerce.com/s-j4haierfig/products/86/images/286/ablebrewingsystem4.1688152579.220.290.jpg?c=1","quantity_available":"0","quantity":"2","url":"https://talkdesk-retail-dev.mybigcommerce.com/able-brewing-system","cost":{"base_amount":"225","discounts_amount":"0","final_amount":"225","taxes_amount":"0"},"cartLinesDiscounts":[{"discounted_amount":"0","type":"DISCOUNT","discount_code":"1363c133-c9d2-4cf0-bdb3-2f67c240f9ce","discount_name":"Discount","discount_description":"Discount"}]}],"custom_fields_type":"BIGCOMMERCE","custom_fields":{},"brand":"Brand 123","links":{"self":{"href":"http://api-docs.talkdesk.org/erc/ecommerce/workspace/customers/cart?cart_id=7c357571-84bc-4238-8d21-06f794a0c68c&customer_id=0"}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"3234010","message":"Invalid JWT."}},"Account not configured to use ERC E-Commerce APIs":{"value":{"code":"3234011","message":"Account not configured to use ERC E-Commerce APIs."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234030","message":"Required scopes are missing."}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234040","message":"Resource not found."}}}},"405":{"description":"Method not supported","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234050","message":"Method not allowed."}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3235000","message":"Internal Server Error."}}}},"502":{"description":"Bad Gateway","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3235020","message":"Bad Gateway."}}}}}}},"/erc/ecommerce/connections/external/customers":{"get":{"tags":["ERC ECommerce Connections"],"description":"Read the ERC e-commerce connections external customers.","security":[{"EarlyAccess":["erc-ecommerce-connections-customers:read"]}],"parameters":[{"name":"page","in":"query","required":false,"description":"Desired page. Defaults to 1.","schema":{"type":"integer","default":1,"maximum":99999,"minimum":1,"example":10000000}},{"name":"per_page","in":"query","required":false,"description":"Limit the number of attributes per page. Defaults to 50.","schema":{"type":"integer","default":50,"maximum":100,"minimum":1,"example":100}},{"name":"name","in":"query","required":false,"description":"The external customer name","schema":{"type":"string","minLength":1,"maxLength":255,"example":"customer123"}},{"name":"phone","in":"query","required":false,"description":"The external customer phone","schema":{"type":"string","minLength":1,"maxLength":255,"example":"+8618062427256"}},{"name":"email","in":"query","required":false,"description":"The external customer email","schema":{"type":"string","minLength":1,"maxLength":255,"example":"xxx@test.com"}},{"name":"brand","in":"query","required":false,"description":"The brand of the provider you want to filter by. If the account is multi-brand, this parameter is required.\n","schema":{"type":"string","maxLength":255,"minLength":1,"example":"Brand 123"}},{"name":"ids","in":"query","required":false,"description":"The external customer ids","schema":{"type":"array","items":{"type":"string","maxLength":32,"minLength":32}}}],"responses":{"200":{"description":"The customer external customers with the provided parameters.","content":{"application/json":{"schema":{"type":"object","description":"Represents the customer resource","required":["total","count","page","per_page","total_pages","_embedded"],"properties":{"total":{"type":"integer","description":"The total number of customers","example":1},"count":{"type":"integer","description":"The count of customers in the current page","example":1},"page":{"type":"integer","description":"The current page number","example":1},"per_page":{"type":"integer","description":"The number of customers per page","example":1},"total_pages":{"type":"integer","description":"The total number of pages","example":1},"_embedded":{"type":"object","description":"The embedded resources","properties":{"contacts":{"type":"array","description":"The list of contacts","items":{"type":"object","description":"The contact details","required":["external_customer_id","name","updated_at","created_at","emails","phones"],"properties":{"external_customer_id":{"type":"string","description":"The ID of the customer","example":"5863685193889"},"name":{"type":"string","description":"The name of the customer","example":"john"},"updated_at":{"type":"string","description":"The timestamp date when the customer was last updated","format":"date-time","example":"2021-12-02T15:45:18Z"},"created_at":{"type":"string","description":"The timestamp date when the customer was created","format":"date-time","example":"2023-11-20T06:34:49.000Z"},"emails":{"type":"array","description":"The list of customer's emails","items":{"type":"string","example":"xxx@email.com"}},"phones":{"type":"array","description":"The list of customer's phone numbers","items":{"type":"string","example":"+8618062427253"}},"custom_fields":{"type":"object","description":"The custom fields associated with the customer","additionalProperties":true,"example":{"field_1":"value_1","field_2":"value_2"}}}}}}},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"uri","example":"http://localhost:8080/erc/ecommerce/external/customers?page=1&per_page=10"}}},"next":{"type":"object","properties":{"href":{"type":"string","format":"uri","example":"http://localhost:8080/erc/ecommerce/external/customers?page=2&per_page=10"}}}}}}},"examples":{"Valid Customer":{"value":{"total":1,"count":1,"page":1,"per_page":1,"total_pages":1,"_embedded":{"contacts":[{"external_customer_id":"5863685193889","name":"john","updated_at":"2021-12-02T15:45:18Z","created_at":"2023-11-20T06:34:49.000Z","emails":["xxx@email.com"],"phones":["+8618062427253"],"custom_fields":{"field_1":"value_1","field_2":"value_2"}}]},"_links":{"self":{"href":"http://localhost:8080/erc/ecommerce/external/customers?page=1&per_page=10"},"next":{"href":"http://localhost:8080/erc/ecommerce/external/customers?page=2&per_page=10"}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"3234010","message":"Invalid JWT."}},"Account not configured to use ERC E-Commerce APIs":{"value":{"code":"3234011","message":"Account not configured to use ERC E-Commerce APIs."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234030","message":"Required scopes are missing."}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234040","message":"Resource not found."}}}},"405":{"description":"Method not supported","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234050","message":"Method not allowed."}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3235000","message":"Internal Server Error."}}}},"502":{"description":"Bad Gateway","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3235020","message":"Bad Gateway."}}}}}}},"/erc/ecommerce/customers/technician-visits/available-slots":{"get":{"tags":["ERC ECommerce Connections"],"description":"Read the ERC e-commerce customer technician visits available slots for the provided customer id or visit id.","security":[{"EarlyAccess":["erc-ecommerce-customers:read"]}],"parameters":[{"name":"customer_id","in":"query","description":"The unique identifier for the customer whose technician visits available slots need to be retrieved.","required":false,"schema":{"type":"string","maxLength":255,"minLength":1,"example":"customer123"}},{"name":"visit_id","in":"query","description":"The visit id you want to query.","required":false,"schema":{"type":"string","maxLength":255,"minLength":1,"example":"visit_id_1"}},{"name":"start_time","in":"query","required":false,"description":"The start time for the shipment available slots query.","schema":{"type":"string","format":"date-time","example":"2023-08-30T10:00:00Z"}},{"name":"end_time","in":"query","required":false,"description":"The end time for the shipment available slots query.","schema":{"type":"string","format":"date-time","example":"2023-08-30T12:00:00Z"}},{"name":"zip_code","in":"query","required":false,"description":"The zip code for the shipment available slots query.","schema":{"type":"string","maxLength":10,"minLength":5,"example":"12345"}},{"name":"brand","in":"query","description":"The brand of the provider you want to query. If the account is multi-brand, this parameter is required.\n","required":false,"schema":{"type":"string","maxLength":255,"minLength":1,"example":"Brand A"}},{"name":"limit","in":"query","description":"The amount of technician visits available slots you want to get.","required":false,"schema":{"type":"integer","example":10,"minimum":1,"maximum":100,"default":50}},{"name":"cursor","in":"query","description":"The opaque string that represents the cursor after which the 'limit' amount of available slots are retrieved.","required":false,"schema":{"type":"string","maxLength":255,"minLength":1,"default":""},"example":"eyJsYXN0X2lkIjozMDExMjM4MjUsImxhc3RfdmFsdWUiOiAiMjAyMC0wOC0zMCJ9"},{"name":"order_by","in":"query","description":"The parameter to be sorted for. Use order_by=key1:desc for descending, order_by=key1:asc for ascending.","required":false,"schema":{"type":"string","maxLength":255,"minLength":1,"example":"date:asc"}}],"responses":{"200":{"description":"The list of customer available slots found for the provided customer id.","content":{"application/json":{"schema":{"type":"object","description":"Represents the paginated list of technician visit available slots","required":["_embedded","_links"],"properties":{"_embedded":{"type":"object","required":["technician_visit_slots"],"properties":{"technician_visit_slots":{"type":"array","description":"The list of technician visit available slots in the current page","items":{"type":"object","description":"Represents an available slot associated with a technician visit","required":["id","date","time","timezone"],"properties":{"id":{"type":"string","description":"The identifier of the slot","example":"slot_123"},"brand":{"type":"string","description":"The brand of the provider","example":"Brand A"},"date":{"type":"string","description":"The technician visit date (YYYY-MM-DD)","format":"date","example":"2025-08-15"},"time":{"type":"object","description":"The technician visit time window","required":["start","end"],"properties":{"start":{"type":"string","description":"The scheduled technician visit start time","example":"9:00 AM"},"end":{"type":"string","description":"The scheduled technician visit end time","example":"11:00 AM"}}},"timezone":{"type":"string","description":"The timezone for the technician visit slot","example":"America/New_York"},"technician":{"type":"object","description":"The technician assigned to the visit","required":["id"],"properties":{"id":{"type":"string","description":"The identifier of the technician","example":"tech_456"},"name":{"type":"string","description":"The name of the technician","example":"John Smith"},"phone_number":{"type":"string","description":"The phone number of the technician","example":"+12125551234"},"scheduling_zone":{"type":"string","description":"The scheduling zone of the technician","example":"Manhattan"}}},"custom_fields":{"type":"object","description":"Additional custom fields","additionalProperties":true}}}}}},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string","format":"uri","example":"http://api-docs.talkdesk.org/erc/ecommerce/customers/technician-visits/available-slots?limit=2&order_by=date:asc"}}},"next":{"type":"object","required":["href"],"properties":{"href":{"type":"string","format":"uri","example":"http://api-docs.talkdesk.org/erc/ecommerce/customers/technician-visits/available-slots?limit=2&order_by=date:asc&cursor=eyJsYXN0X2lkIjoxMjQ4MzU4NTYzODYyLCJsYXN0X3ZhbHVlIjoiMjAxOS0wNi0xNyAwMjoyMzo0Mi4wMDAwMDAifQ=="}}}}}}},"examples":{"Valid Customer Available Slot List":{"value":{"_embedded":{"technician_visit_slots":[{"id":"slot_001","brand":"Brand A","date":"2025-01-01","time":{"start":"9:00 AM","end":"11:00 AM"},"timezone":"America/New_York","technician":{"id":"tech_456","name":"John Smith","phone_number":"+12125551234","scheduling_zone":"Manhattan"},"custom_fields":{"field1":"Custom Value 1","field2":"Custom Value 2"}}]},"_links":{"self":{"href":"http://api-docs.talkdesk.org/erc/ecommerce/customers/technician-visits/available-slots?limit=2&order_by=date:asc"},"next":{"href":"http://api-docs.talkdesk.org/erc/ecommerce/customers/technician-visits/available-slots?limit=2&order_by=date:asc&cursor=eyJsYXN0X2lkIjoxMjQ4MzU4NTYzODYyLCJsYXN0X3ZhbHVlIjoiMjAxOS0wNi0xNyAwMjoyMzo0Mi4wMDAwMDAifQ=="}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1974000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1974010","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1974030","message":"Required scopes are missing."}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1974000","message":"Bad request."}}}},"405":{"description":"Method not supported","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1974050","message":"Method not allowed."}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1975000","message":"Internal Server Error."}}}},"502":{"description":"Bad Gateway","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1975020","message":"Bad Gateway."}}}}}}},"/erc/ecommerce/customers/{customer_id}/technician-visits/schedule":{"post":{"tags":["ERC ECommerce Connections"],"description":"Schedule the ERC e-commerce customer technician visits for the provided visit id.","security":[{"GA":["erc-ecommerce-customers:write"]}],"parameters":[{"name":"customer_id","in":"path","required":true,"description":"The unique identifier for the customer who wants to schedule the shipment.","schema":{"type":"string","maxLength":255,"minLength":1,"example":"customer123"}},{"name":"brand","in":"query","description":"The brand of the provider you want to filter by. If the account is multi-brand, this parameter is required.\n","required":false,"schema":{"type":"string","maxLength":255,"minLength":1,"example":"Brand A"}}],"requestBody":{"description":"The shipment slot to schedule","content":{"application/json":{"schema":{"type":"object","description":"The customer technician visit slot to schedule, notes that at least one of order id, delivery id is required","required":["id"],"properties":{"id":{"type":"string","description":"The slot id which user wants to schedule","example":"slot123"},"visit_id":{"type":"string","description":"The visit id","example":"visit123"}}},"example":{"id":"slot123","visit_id":"visit123"}}}},"responses":{"200":{"description":"Empty Result for Success."},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1974000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1974010","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1974030","message":"Required scopes are missing."}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1974040","message":"Resource not found."}}}},"405":{"description":"Method not supported","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1974050","message":"Method not allowed."}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1974220","message":"Unprocessable entity"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1975000","message":"Internal Server Error."}}}},"502":{"description":"Bad Gateway","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1975020","message":"Bad Gateway."}}}}}}},"/erc/ecommerce/customers/{customer_id}/technician-visits":{"get":{"tags":["ERC ECommerce Connections"],"description":"Read the ERC e-commerce customer technician visits for the provided customer id.","security":[{"GA":["erc-ecommerce-customers:read"]}],"parameters":[{"name":"customer_id","in":"path","required":true,"description":"The unique identifier for the customer whose technician visits need to be retrieved.","schema":{"type":"string","maxLength":255,"minLength":1,"example":"customer123"}},{"name":"statuses","in":"query","required":false,"description":"The array of technician visit statuses you want to filter by.","style":"form","explode":true,"schema":{"type":"array","items":{"type":"string","description":"The technician visit status.","minLength":1,"maxLength":255},"example":["Installation","Completed","Scheduled"]}},{"name":"brand","in":"query","description":"The brand of the provider you want to filter by. If the account is multi-brand, this parameter is required.\n","required":false,"schema":{"type":"string","maxLength":255,"minLength":1,"example":"Brand A"}},{"name":"limit","in":"query","description":"The amount of technician visits you want to get.","required":false,"schema":{"type":"integer","example":10,"minimum":1,"maximum":100,"default":50}},{"name":"cursor","in":"query","description":"The opaque string that represents the cursor after which the 'limit' amount of technician visits are retrieved.","required":false,"schema":{"type":"string","maxLength":255,"minLength":1,"default":""},"example":"eyJsYXN0X2lkIjozMDExMjM4MjUsImxhc3RfdmFsdWUiOiAiMjAyMC0wOC0zMCJ9"},{"name":"order_by","in":"query","description":"The parameter to be sorted for. Use order_by=key1:desc for descending, order_by=key1:asc for ascending.","required":false,"schema":{"type":"string","maxLength":255,"minLength":1,"example":"id:desc"}}],"responses":{"200":{"description":"The list of customer technician visits found for the provided customer id.","content":{"application/json":{"schema":{"type":"object","description":"Represents the paginated list of customer technician visits","required":["_embedded","_links"],"properties":{"_embedded":{"type":"object","properties":{"visits":{"type":"array","description":"The list of visits in the current page","items":{"type":"object","description":"Represents a technician visit for a customer","required":["id"],"properties":{"id":{"type":"string","description":"Visit identifier (required)","example":"visit_001"},"status":{"type":"string","description":"Current status of the visit","example":"Scheduled"},"type":{"type":"string","description":"Type of visit","example":"Installation"},"address":{"type":"object","description":"The address for this customer","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the address","example":"address_id_123"},"first_name":{"type":"string","description":"The first name of the recipient","example":"John"},"last_name":{"type":"string","description":"The last name of the recipient","example":"Doe"},"phone_number":{"type":"string","description":"The phone number of the recipient","example":"+123456789"},"address":{"type":"string","description":"The street address of the recipient","example":"123 Main St"},"zip_code":{"type":"string","description":"The zip code of the recipient's address","example":"10001"},"city":{"type":"string","description":"The city of the recipient's address","example":"New York"},"region_code":{"type":"string","description":"The region code (e.g., state or province)","example":"NY"},"country_code":{"type":"string","description":"The country code (ISO 3166-1 alpha-2)","example":"US"}}},"date":{"type":"string","description":"Scheduled date of the visit","format":"date","example":"2025-09-01"},"time":{"type":"object","properties":{"start":{"type":"string","description":"Scheduled start time of the visit","example":"10:00 AM"},"end":{"type":"string","description":"Scheduled end time of the visit","example":"12:00 PM"}}},"timezone":{"type":"string","description":"Timezone for the scheduled visit","example":"America/New_York"},"technician":{"type":"object","properties":{"id":{"type":"string","description":"Technician identifier","example":"tech_456"},"name":{"type":"string","description":"Technician name","example":"John Smith"},"phone_number":{"type":"string","description":"Technician's phone number","example":"+12125551234"},"scheduling_zone":{"type":"string","description":"Technician's assigned scheduling zone","example":"Manhattan"}}},"custom_fields":{"type":"object","description":"Custom fields for the visit","additionalProperties":true}}}}}},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"uri","example":"http://api-docs.talkdesk.org/erc/ecommerce/customers/customer123/technician-visits?limit=2&order_by=last_update:desc"}}},"next":{"type":"object","properties":{"href":{"type":"string","format":"uri","example":"http://api-docs.talkdesk.org/erc/ecommerce/customers/customer123/technician-visits?limit=2&order_by=last_update:desc&cursor=eyJsYXN0X2lkIjoxMjQ4MzU4NTYzODYyLCJsYXN0X3ZhbHVlIjoiMjAxOS0wNi0xNyAwMjoyMzo0Mi4wMDAwMDAifQ=="}}}}}}},"examples":{"Valid Customer visits List":{"value":{"_embedded":{"visits":[{"id":"visit_id","brand":"Brand A","status":"Scheduled","type":"Installation","date":"2025-09-01","time":{"start":"10:00 AM","end":"12:00 PM"},"timezone":"America/New_York","address":{"id":"address_id_123","first_name":"John","last_name":"Doe","phone_number":"+123456789","address":"123 Main St","zip_code":"10001","city":"New York","region_code":"NY","country_code":"US"},"technician":{"id":"tech_456","name":"John Smith","phone_number":"+12125551234","scheduling_zone":"Manhattan"},"custom_fields":{"installation_type":"express"}}]},"_links":{"self":{"href":"http://api-docs.talkdesk.org/erc/ecommerce/customers/customer123/technician-visits?limit=2&order_by=last_update:desc"},"next":{"href":"http://api-docs.talkdesk.org/erc/ecommerce/customers/customer123/technician-visits?limit=2&order_by=last_update:desc&cursor=eyJsYXN0X2lkIjoxMjQ4MzU4NTYzODYyLCJsYXN0X3ZhbHVlIjoiMjAxOS0wNi0xNyAwMjoyMzo0Mi4wMDAwMDAifQ=="}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Generic Bad Request":{"value":{"code":"3234000","message":"Bad request."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"3234010","message":"Invalid JWT."}},"Account not configured to use ERC E-Commerce APIs":{"value":{"code":"3234011","message":"Account not configured to use ERC E-Commerce APIs."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234030","message":"Required scopes are missing."}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234040","message":"Resource not found."}}}},"405":{"description":"Method not supported","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234050","message":"Method not allowed."}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234220","message":"Unprocessable entity"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3235000","message":"Internal Server Error."}}}},"502":{"description":"Bad Gateway","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3235020","message":"Bad Gateway."}}}}}}},"/erc/ecommerce/shopify-webhooks-handler/credentials":{"get":{"tags":["ERC ECommerce Shopify Webhooks Handler"],"description":"Get the ERC e-commerce Shopify Integration credentials for the currently authenticated Talkdesk account.","security":[{"GA":["erc-ecommerce-shopify-webhooks-handler-credentials:read"]}],"responses":{"200":{"description":"The Shopify Integration credentials currently configured for the authenticated Talkdesk account","content":{"application/json":{"schema":{"allOf":[{"type":"object","description":"Represents integration settings for industries, supporting single or multiple integrations","required":["if_multiple_integration"],"properties":{"id":{"type":"string","description":"id","example":"101"},"if_multiple_integration":{"type":"boolean","description":"Indicates whether multiple integrations are enabled","example":true},"default_integration":{"type":"object","description":"Integration setting for a specific e-commerce platform","properties":{"integration_type":{"type":"string","description":"The type of integration (e.g., SHOPIFY, BIGCOMMERCE, CUSTOM)","example":"SHOPIFY","minLength":0,"maxLength":2147483647},"brand_name":{"type":"string","description":"The brand name associated with this integration","example":"Acme Inc.","minLength":0,"maxLength":2147483647},"brand_domain_id":{"type":"string","description":"The domain ID for the brand","example":"acme.com","minLength":0,"maxLength":2147483647},"authorization_id":{"type":"string","description":"Authorization ID used to authenticate","example":"auth-1234","minLength":0,"maxLength":2147483647},"shopify_integration_credential":{"type":"object","description":"Represents the Shopify Integration credentials","properties":{"shopify_store_domain":{"type":"string","description":"The domain of the Shopify store","example":"example-store.myshopify.com","minLength":0,"maxLength":2147483647},"shopify_api_key":{"type":"string","description":"API key of the Shopify app","example":"","minLength":0,"maxLength":2147483647},"shopify_api_secret":{"type":"string","description":"API secret of the Shopify app","example":"","minLength":0,"maxLength":2147483647},"shopify_api_access_token":{"type":"string","description":"Access token obtained after installation","example":"","minLength":0,"maxLength":2147483647}}}}},"multiple_integrations":{"type":"array","description":"A list of integration settings when multiple integrations are enabled","items":{"type":"object","description":"Integration setting for a specific e-commerce platform","properties":{"integration_type":{"type":"string","description":"The type of integration (e.g., SHOPIFY, BIGCOMMERCE, CUSTOM)","example":"SHOPIFY","minLength":0,"maxLength":2147483647},"brand_name":{"type":"string","description":"The brand name associated with this integration","example":"Acme Inc.","minLength":0,"maxLength":2147483647},"brand_domain_id":{"type":"string","description":"The domain ID for the brand","example":"acme.com","minLength":0,"maxLength":2147483647},"authorization_id":{"type":"string","description":"Authorization ID used to authenticate","example":"auth-1234","minLength":0,"maxLength":2147483647},"shopify_integration_credential":{"type":"object","description":"Represents the Shopify Integration credentials","properties":{"shopify_store_domain":{"type":"string","description":"The domain of the Shopify store","example":"example-store.myshopify.com","minLength":0,"maxLength":2147483647},"shopify_api_key":{"type":"string","description":"API key of the Shopify app","example":"","minLength":0,"maxLength":2147483647},"shopify_api_secret":{"type":"string","description":"API secret of the Shopify app","example":"","minLength":0,"maxLength":2147483647},"shopify_api_access_token":{"type":"string","description":"Access token obtained after installation","example":"","minLength":0,"maxLength":2147483647}}}}}}}},{"type":"object","required":["_links"],"properties":{"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"uri","example":"http://api-docs.talkdesk.org/erc/ecommerce/shopify-webhooks-handler/credentials"}}}}}}}]},"examples":{"Valid Integration Credentials":{"value":{"id":"101","if_multiple_integration":true,"default_integration":{"integration_type":"SHOPIFY","brand_name":"Acme Inc.","brand_domain_id":"acme.com","authorization_id":"","shopify_integration_credential":{"shopify_store_domain":"shopify-store-name.myshopify.com","shopify_api_key":"46617a607dc837261ff52149d12378123ba12c","shopify_api_secret":"1234567a8080dc837261ff5214912344322cb","shopify_api_access_token":""}},"multiple_integrations":[{"integration_type":"SHOPIFY","brand_name":"Acme Inc.","brand_domain_id":"acme.com","authorization_id":"","shopify_integration_credential":{"shopify_store_domain":"shopify-store-name.myshopify.com","shopify_api_key":"46617a607dc837261ff52149d12378123ba12c","shopify_api_secret":"1234567a8080dc837261ff5214912344322cb","shopify_api_access_token":""}},{"integration_type":"BIGCOMMERCE","brand_name":"Beta Corp","brand_domain_id":"beta.com","authorization_id":"auth-5678","shopify_integration_credential":null}],"_links":{"self":{"href":"http://api-docs.talkdesk.org/erc/ecommerce/shopify-webhooks-handler/credentials"}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2174000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2174010","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2174030","message":"Required scopes are missing."}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2174040","message":"Resource not found."}}}},"405":{"description":"Method not supported","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2174050","message":"Method not allowed."}}}}}},"put":{"tags":["ERC ECommerce Shopify Webhooks Handler"],"description":"Upsert the ERC e-commerce Shopify Integration credentials for the currently authenticated Talkdesk account.","security":[{"GA":["erc-ecommerce-shopify-webhooks-handler-credentials:write"]}],"requestBody":{"description":"The Shopify Integration credentials to be configured for the authenticated Talkdesk account","content":{"application/json":{"schema":{"type":"object","description":"Represents the Shopify Integration credentials for the authenticated Talkdesk account","required":["shopify_store_domain","shopify_api_key","shopify_api_secret"],"properties":{"id":{"type":"string","description":"Unique identifier for the Shopify integration credentials","example":"abc123","minLength":0,"maxLength":2147483647},"shopify_store_domain":{"type":"string","description":"The domain of the shopify store that is integrated with the authenticated Talkdesk account","example":"shopify-store-name.myshopify.com","minLength":0,"maxLength":2147483647},"shopify_api_key":{"type":"string","description":"The API key of the Shopify App that allows the integration with the Shopify API","example":"","minLength":0,"maxLength":2147483647},"shopify_api_secret":{"type":"string","description":"The API secret of the Shopify App that allows the integration with the Shopify API","example":"","minLength":0,"maxLength":2147483647},"shopify_api_access_token":{"type":"string","description":"\"The API access token obtained during the installation of the Shopify App that allows the integration with the Shopify API\"\n","example":"","minLength":0,"maxLength":2147483647}}},"examples":{"Valid Integration Credentials":{"value":{"shopify_store_domain":"shopify-store-name.myshopify.com","shopify_api_key":"46617a607dc837261ff52149d12378123ba12c","shopify_api_secret":"1234567a8080dc837261ff5214912344322cb","shopify_api_access_token":"1234567a8080dc8abc1245667722314"}},"Valid Integration Credentials without access token":{"value":{"shopify_store_domain":"shopify-store-name.myshopify.com","shopify_api_key":"46617a607dc837261ff52149d12378123ba12c","shopify_api_secret":"1234567a8080dc837261ff5214912344322cb"}},"Invalid Integration Credentials (missing shopify domain in store domain)":{"value":{"shopify_store_domain":"invalid-store-name.missing-shopify-domain","shopify_api_key":"46617a607dc837261ff52149d12378123ba12c","shopify_api_secret":"1234567a8080dc837261ff5214912344322cb"}},"Invalid Integration Credentials (missing field)":{"value":{"shopify_store_domain":"shopify-store-name.myshopify.com","shopify_api_key":"46617a607dc837261ff52149d12378123ba12c"}}}}}},"responses":{"200":{"description":"The Shopify Integration credentials currently configured for the authenticated Talkdesk account","content":{"application/json":{"schema":{"allOf":[{"type":"object","description":"Represents integration settings for industries, supporting single or multiple integrations","required":["if_multiple_integration"],"properties":{"id":{"type":"string","description":"id","example":"101"},"if_multiple_integration":{"type":"boolean","description":"Indicates whether multiple integrations are enabled","example":true},"default_integration":{"type":"object","description":"Integration setting for a specific e-commerce platform","properties":{"integration_type":{"type":"string","description":"The type of integration (e.g., SHOPIFY, BIGCOMMERCE, CUSTOM)","example":"SHOPIFY","minLength":0,"maxLength":2147483647},"brand_name":{"type":"string","description":"The brand name associated with this integration","example":"Acme Inc.","minLength":0,"maxLength":2147483647},"brand_domain_id":{"type":"string","description":"The domain ID for the brand","example":"acme.com","minLength":0,"maxLength":2147483647},"authorization_id":{"type":"string","description":"Authorization ID used to authenticate","example":"auth-1234","minLength":0,"maxLength":2147483647},"shopify_integration_credential":{"type":"object","description":"Represents the Shopify Integration credentials","properties":{"shopify_store_domain":{"type":"string","description":"The domain of the Shopify store","example":"example-store.myshopify.com","minLength":0,"maxLength":2147483647},"shopify_api_key":{"type":"string","description":"API key of the Shopify app","example":"","minLength":0,"maxLength":2147483647},"shopify_api_secret":{"type":"string","description":"API secret of the Shopify app","example":"","minLength":0,"maxLength":2147483647},"shopify_api_access_token":{"type":"string","description":"Access token obtained after installation","example":"","minLength":0,"maxLength":2147483647}}}}},"multiple_integrations":{"type":"array","description":"A list of integration settings when multiple integrations are enabled","items":{"type":"object","description":"Integration setting for a specific e-commerce platform","properties":{"integration_type":{"type":"string","description":"The type of integration (e.g., SHOPIFY, BIGCOMMERCE, CUSTOM)","example":"SHOPIFY","minLength":0,"maxLength":2147483647},"brand_name":{"type":"string","description":"The brand name associated with this integration","example":"Acme Inc.","minLength":0,"maxLength":2147483647},"brand_domain_id":{"type":"string","description":"The domain ID for the brand","example":"acme.com","minLength":0,"maxLength":2147483647},"authorization_id":{"type":"string","description":"Authorization ID used to authenticate","example":"auth-1234","minLength":0,"maxLength":2147483647},"shopify_integration_credential":{"type":"object","description":"Represents the Shopify Integration credentials","properties":{"shopify_store_domain":{"type":"string","description":"The domain of the Shopify store","example":"example-store.myshopify.com","minLength":0,"maxLength":2147483647},"shopify_api_key":{"type":"string","description":"API key of the Shopify app","example":"","minLength":0,"maxLength":2147483647},"shopify_api_secret":{"type":"string","description":"API secret of the Shopify app","example":"","minLength":0,"maxLength":2147483647},"shopify_api_access_token":{"type":"string","description":"Access token obtained after installation","example":"","minLength":0,"maxLength":2147483647}}}}}}}},{"type":"object","required":["_links"],"properties":{"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"uri","example":"http://api-docs.talkdesk.org/erc/ecommerce/shopify-webhooks-handler/credentials"}}}}}}}]},"examples":{"Valid Integration Credentials":{"value":{"id":"101","if_multiple_integration":true,"default_integration":{"integration_type":"SHOPIFY","brand_name":"Acme Inc.","brand_domain_id":"acme.com","authorization_id":"","shopify_integration_credential":{"shopify_store_domain":"shopify-store-name.myshopify.com","shopify_api_key":"46617a607dc837261ff52149d12378123ba12c","shopify_api_secret":"1234567a8080dc837261ff5214912344322cb","shopify_api_access_token":""}},"multiple_integrations":[{"integration_type":"SHOPIFY","brand_name":"Acme Inc.","brand_domain_id":"acme.com","authorization_id":"","shopify_integration_credential":{"shopify_store_domain":"shopify-store-name.myshopify.com","shopify_api_key":"46617a607dc837261ff52149d12378123ba12c","shopify_api_secret":"1234567a8080dc837261ff5214912344322cb","shopify_api_access_token":""}},{"integration_type":"BIGCOMMERCE","brand_name":"Beta Corp","brand_domain_id":"beta.com","authorization_id":"auth-5678","shopify_integration_credential":null}],"_links":{"self":{"href":"http://api-docs.talkdesk.org/erc/ecommerce/shopify-webhooks-handler/credentials"}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2174000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2174010","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2174030","message":"Required scopes are missing."}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2174040","message":"Resource not found."}}}},"405":{"description":"Method not supported","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2174050","message":"Method not allowed."}}}}}},"delete":{"tags":["ERC ECommerce Shopify Webhooks Handler"],"description":"Delete the ERC e-commerce Shopify Integration credentials configured for the currently authenticated Talkdesk account.","security":[{"GA":["erc-ecommerce-shopify-webhooks-handler-credentials:write"]}],"parameters":[{"name":"shopify_store_domain","in":"query","description":"The shopify_store_domain you want to delete.","required":true,"schema":{"type":"string","maxLength":255,"minLength":1,"example":"shopify-store-name.myshopify.com"}}],"responses":{"204":{"description":"No Content - Credentials successfully deleted"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2174000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2174010","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2174030","message":"Required scopes are missing."}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2174040","message":"Resource not found."}}}},"405":{"description":"Method not supported","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2174050","message":"Method not allowed."}}}}}}},"/erc/ecommerce/return/reasons":{"get":{"tags":["ERC ECommerce Connections"],"description":"Retrieve the list of available return reasons.","security":[{"GA":["erc-ecommerce-return:read"]}],"parameters":[{"name":"brand","in":"query","required":false,"description":"The brand of the provider you want to filter by. If the account is multi-brand, this parameter is required.\n","schema":{"type":"string","maxLength":255,"minLength":1,"example":"Brand 123"}}],"responses":{"200":{"description":"The list of return reasons.","content":{"application/json":{"schema":{"type":"object","description":"The list of return reasons","required":["reasons","_links"],"properties":{"reasons":{"type":"array","description":"The list of return reasons","items":{"type":"object","description":"The return reason","required":["type","description"],"properties":{"type":{"type":"string","description":"The type of return reason","example":"SIZE_TOO_LARGE"},"description":{"type":"string","description":"The description of the return reason","example":"size too large"}}}},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"uri","example":"http://api-docs.talkdesk.org/erc/ecommerce/return/reasons"}}}}}}},"examples":{"Return Reasons List":{"value":{"reasons":[{"type":"SIZE_TOO_SMALL","description":"size too small"}],"_links":{"self":{"href":"http://api-docs.talkdesk.org/erc/ecommerce/return/reasons"}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234010","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234030","message":"Required scopes are missing."}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234040","message":"Resource not found."}}}},"405":{"description":"Method not supported","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234050","message":"Method not allowed."}}}}}}},"/erc/ecommerce/return/calculations":{"post":{"tags":["ERC ECommerce Connections"],"description":"Calculate the expected refund amount for a return request.","security":[{"GA":["erc-ecommerce-return:read"]}],"requestBody":{"description":"Return calculation request containing order details, return items, and optional exchange items.","content":{"application/json":{"schema":{"type":"object","description":"The return calculate request body.","required":["order_id","return_line_items"],"properties":{"order_id":{"type":"string","description":"The order ID.","minLength":1,"maxLength":255,"example":"order789"},"brand":{"type":"string","description":"The brand identifier for calculating the expected return refund amount. If the account is multi-brand, this parameter is required.\n","minLength":1,"maxLength":255,"example":"The Brand"},"return_line_items":{"type":"array","description":"The line items to be returned.","minItems":1,"items":{"type":"object","required":["line_item_id","quantity"],"properties":{"line_item_id":{"type":"string","description":"The ID of the item from the Get Order Items API.","minLength":1,"maxLength":255,"example":"orderLineItemID123"},"delivery_id":{"type":"string","description":"The ID of the order delivery from the Get Order Items API.","minLength":1,"maxLength":255,"example":"deliveryID123"},"quantity":{"type":"integer","description":"The quantity to return, which must be positive.","minimum":1,"default":1,"maximum":100000,"example":1},"restocking_percentage":{"type":"integer","description":"The restocking fee percentage, which must be between 1 and 99.","minimum":1,"maximum":99,"example":10}}}},"exchange_line_items":{"type":"array","description":"The line items to be exchanged.","items":{"type":"object","required":["variant_id","quantity"],"properties":{"variant_id":{"type":"string","description":"The product variant ID.","minLength":1,"maxLength":255,"example":"123123"},"quantity":{"type":"integer","description":"The quantity to exchange, which must be positive.","minimum":1,"default":1,"maximum":100000,"example":1},"applied_discount":{"type":"object","description":"The discount applied to the exchange item.","properties":{"description":{"type":"string","description":"The discount description","example":"Exchange discount"},"amount":{"type":"number","description":"The amount discount.","example":30},"percentage":{"type":"integer","description":"The percentage discount, which must be between 1 and 100.","minimum":1,"maximum":100,"example":50}},"oneOf":[{"required":["amount"]},{"required":["percentage"]}]}}}},"return_shipping_fee":{"type":"number","description":"The return shipping fee.","example":30}}},"examples":{"Return Calculations Request":{"value":{"order_id":"123123","brand":"The Brand","return_line_items":[{"line_item_id":"line_item_1","delivery_id":"delivery_1","quantity":1,"restocking_percentage":10},{"line_item_id":"line_item_2","delivery_id":"delivery_2","quantity":2}],"exchange_line_items":[{"variant_id":"variant_1","quantity":1,"applied_discount":{"description":"Exchange discount","amount":5}},{"variant_id":"variant_2","quantity":1,"applied_discount":{"description":"Exchange discount","percentage":20}}],"return_shipping_fee":7.5}}}}}},"responses":{"200":{"description":"The calculated return amounts.","content":{"application/json":{"schema":{"type":"object","description":"The return calculate response body.","required":["return_item_amount","taxes_included","subtotal_amount","customer_collect_amount","_links"],"properties":{"taxes_included":{"type":"boolean","description":"Indicates if taxes are included in the amounts.","example":true},"return_item_amount":{"type":"object","description":"The total amount of returned items.","required":["value","currency"],"properties":{"value":{"type":"number","description":"The amount value.","example":30},"currency":{"type":"string","description":"The currency code.","example":"EUR"}}},"exchange_item_amount":{"type":"object","description":"The total amount of exchange items.","required":["value","currency"],"properties":{"value":{"type":"number","description":"The amount value.","example":30},"currency":{"type":"string","description":"The currency code.","example":"EUR"}}},"subtotal_amount":{"type":"object","description":"The subtotal amount.","required":["value","currency"],"properties":{"value":{"type":"number","description":"The amount value.","example":30},"currency":{"type":"string","description":"The currency code.","example":"EUR"}}},"return_shipping_fee_amount":{"type":"object","description":"The return shipping fee amount.","required":["value","currency"],"properties":{"value":{"type":"number","description":"The amount value.","example":30},"currency":{"type":"string","description":"The currency code.","example":"EUR"}}},"restocking_fee_amount":{"type":"object","description":"The restocking fee amount.","required":["value","currency"],"properties":{"value":{"type":"number","description":"The amount value.","example":30},"currency":{"type":"string","description":"The currency code.","example":"EUR"}}},"taxes":{"type":"object","description":"The total taxes amount.","required":["value","currency"],"properties":{"value":{"type":"number","description":"The amount value.","example":30},"currency":{"type":"string","description":"The currency code.","example":"EUR"}}},"total_outstanding_amount":{"type":"object","description":"The total outstanding amount.","required":["value","currency"],"properties":{"value":{"type":"number","description":"The amount value.","example":30},"currency":{"type":"string","description":"The currency code.","example":"EUR"}}},"return_item_discount_amount":{"type":"object","description":"The total discount amount applied to returned items.","required":["value","currency"],"properties":{"value":{"type":"number","description":"The amount value.","example":30},"currency":{"type":"string","description":"The currency code.","example":"EUR"}}},"customer_collect_amount":{"type":"object","description":"The amount to be collected from or refunded to the customer. Positive values (> 0) represent the expected amount to collect from the customer. Negative values (< 0) represent the expected amount to refund to the customer, while a value of zero (0) indicates no amount to collect or refund.\n","required":["value","currency"],"properties":{"value":{"type":"number","description":"The amount value.","example":30},"currency":{"type":"string","description":"The currency code.","example":"EUR"}}},"restocking_percentage":{"type":"number","description":"The restocking percentage applied to the return.","example":10},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string","format":"uri","example":"http://api-docs.talkdesk.org/erc/ecommerce/return/calculations"}}}}}}},"examples":{"Return Calculations Response":{"value":{"taxes_included":true,"return_item_amount":{"value":-600,"currency":"EUR"},"exchange_item_amount":{"value":1232.45,"currency":"EUR"},"subtotal_amount":{"value":632.45,"currency":"EUR"},"return_shipping_fee_amount":{"value":20,"currency":"EUR"},"restocking_fee_amount":{"value":48.79,"currency":"EUR"},"customer_collect_amount":{"value":701.24,"currency":"EUR"},"taxes":{"value":112.45,"currency":"EUR"},"total_outstanding_amount":{"value":0,"currency":"EUR"},"return_item_discount_amount":{"value":10,"currency":"EUR"},"restocking_percentage":10,"_links":{"self":{"href":"http://api-docs.talkdesk.org/erc/ecommerce/return/calculations"}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234010","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234030","message":"Required scopes are missing."}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234040","message":"Resource not found."}}}},"405":{"description":"Method not supported","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234050","message":"Method not allowed."}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3235000","message":"Internal Server Error."}}}},"502":{"description":"Bad Gateway","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3235020","message":"Bad Gateway."}}}}}}},"/erc/ecommerce/order/cancel-return/{return_id}":{"post":{"tags":["ERC ECommerce Connections"],"description":"Cancel a return.","security":[{"GA":["erc-ecommerce-return:write"]}],"parameters":[{"name":"return_id","in":"path","required":true,"description":"The return ID from the get order items endpoint.","schema":{"type":"string","example":"return123"}},{"name":"brand","in":"query","required":false,"description":"Optional brand identifier for the return operation. If the account is multi-brand, this parameter is required.\n","schema":{"type":"string","maxLength":255,"minLength":1,"example":"Brand 123"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234010","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234030","message":"Required scopes are missing."}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234040","message":"Resource not found."}}}},"405":{"description":"Method not supported","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234050","message":"Method not allowed."}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234220","message":"Unprocessable entity"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3235000","message":"Internal Server Error."}}}},"502":{"description":"Bad Gateway","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3235020","message":"Bad Gateway."}}}}}}},"/erc/ecommerce/order/create-return":{"post":{"tags":["ERC ECommerce Connections"],"description":"Create a new return.","security":[{"GA":["erc-ecommerce-return:write"]}],"requestBody":{"description":"Create Return Request.","content":{"application/json":{"schema":{"type":"object","description":"The create return request body.","required":["order_id","return_line_items"],"properties":{"order_id":{"type":"string","description":"The order ID.","minLength":1,"maxLength":255,"example":"order789"},"brand":{"type":"string","description":"Optional brand identifier for the create return operation. If the account is multi-brand, this parameter is required.\n","minLength":1,"maxLength":255,"example":"The Brand"},"return_line_items":{"type":"array","description":"The line items to be returned.","minItems":1,"items":{"allOf":[{"type":"object","required":["line_item_id","quantity"],"properties":{"line_item_id":{"type":"string","description":"The ID of the item from the Get Order Items API.","minLength":1,"maxLength":255,"example":"orderLineItemID123"},"delivery_id":{"type":"string","description":"The ID of the order delivery from the Get Order Items API.","minLength":1,"maxLength":255,"example":"deliveryID123"},"quantity":{"type":"integer","description":"The quantity to return, which must be positive.","minimum":1,"default":1,"maximum":100000,"example":1},"restocking_percentage":{"type":"integer","description":"The restocking fee percentage, which must be between 1 and 99.","minimum":1,"maximum":99,"example":10}}},{"type":"object","required":["reason"],"properties":{"reason":{"type":"string","description":"The reason type for the return item from the Get Return Reasons API.","example":"SIZE_TOO_LARGE"},"reason_note":{"type":"string","description":"The additional notes for the return reason.","example":"The item's size is too large.","maxLength":255,"default":""}}}]}},"exchange_line_items":{"type":"array","description":"The line items to be exchanged.","items":{"type":"object","required":["variant_id","quantity"],"properties":{"variant_id":{"type":"string","description":"The product variant ID.","minLength":1,"maxLength":255,"example":"123123"},"quantity":{"type":"integer","description":"The quantity to exchange, which must be positive.","minimum":1,"default":1,"maximum":100000,"example":1},"applied_discount":{"type":"object","description":"The discount applied to the exchange item.","properties":{"description":{"type":"string","description":"The discount description","example":"Exchange discount"},"amount":{"type":"number","description":"The amount discount.","example":30},"percentage":{"type":"integer","description":"The percentage discount, which must be between 1 and 100.","minimum":1,"maximum":100,"example":50}},"oneOf":[{"required":["amount"]},{"required":["percentage"]}]}}}},"return_shipping_fee":{"type":"number","description":"The return shipping fee.","example":30}}},"examples":{"Create Return Request":{"value":{"order_id":"123123","brand":"The Brand","return_line_items":[{"line_item_id":"line_item_1","delivery_id":"delivery_1","quantity":1,"restocking_percentage":10,"reason":"SIZE_TOO_SMALL","reason_note":"The item is too small."},{"line_item_id":"line_item_2","delivery_id":"delivery_2","quantity":2,"reason":"SIZE_TOO_SMALL","reason_note":"The item is too small."}],"exchange_line_items":[{"variant_id":"variant_1","quantity":1,"applied_discount":{"description":"Exchange discount","amount":5}},{"variant_id":"variant_2","quantity":1,"applied_discount":{"description":"Exchange discount","percentage":20}}],"return_shipping_fee":7.5}}}}}},"responses":{"200":{"description":"The create return response.","content":{"application/json":{"schema":{"type":"object","description":"The create return response body.","required":["order_id","return_id","status","_links"],"properties":{"order_id":{"type":"string","description":"The unique identifier of the order.","example":"order789"},"return_id":{"type":"string","description":"The unique identifier of the return.","example":"return001"},"status":{"type":"string","description":"The status of the return.","example":"OPEN"},"name":{"type":"string","description":"The name of the return.","example":"return123"},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string","format":"uri","example":"http://api-docs.talkdesk.org/erc/ecommerce/order/create-return"}}}}}}},"examples":{"Create Return Response":{"value":{"order_id":"order789","return_id":"return001","status":"OPEN","name":"return123","_links":{"self":{"href":"http://api-docs.talkdesk.org/erc/ecommerce/order/create-return"}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234010","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234030","message":"Required scopes are missing."}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234040","message":"Resource not found."}}}},"405":{"description":"Method not supported","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3234050","message":"Method not allowed."}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3235000","message":"Internal Server Error."}}}},"502":{"description":"Bad Gateway","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3235020","message":"Bad Gateway."}}}}}}},"/ccaas/users/{id}/status":{"put":{"description":"Update user status.
    \nNote that the user status cannot be set from neither to the following statuses: busy, after_call_work, offline.","security":[{"EarlyAccess":["ccaas-user-status:write"]}],"parameters":[{"name":"id","in":"path","description":"The user id","required":true,"schema":{}}],"requestBody":{"description":"The body of the request","content":{"application/json":{"schema":{"type":"object","properties":{"current_status":{"type":"string","description":"The (assumed) current user status. Possible values are: available, away and custom status starting with away_ or busy_.
    \nNote that custom statuses must already exist in the user's account."},"new_status":{"type":"string","description":"The desired new user status. Possible values are: available, away and custom status starting with away_ or busy_.
    \nNote that custom statuses must already exist in the user's account."}}},"example":{"current_status":"away","new_status":"available"}}}},"tags":["ccaas-user-status-api"],"responses":{"204":{"description":"No content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid status transition":{"value":{"code":"1580001","message":"The requested status transition is invalid","description":"The requested status transition is invalid."}},"Invalid current status":{"value":{"code":"1580002","message":"The received current status does not match the actual current status","description":"The received current status does not match the actual current status."}},"Invalid new status":{"value":{"code":"1580003","message":"New status is invalid","description":"The new status is invalid."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1580004","message":"Unauthorized","description":"The provided JWT is not valid."}}}},"403":{"description":"Forbidden access","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1580005","message":"Forbidden","description":"Forbidden - Insufficient permissions."}}}},"404":{"description":"User not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1580006","message":"User not found","description":"User ID does not belong to this account."}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Internal Server Error":{"value":{"code":"1580007","message":"Internal Server Error","description":"Internal Server Error"}}}}}}}}},"/ccaas/users/status":{"post":{"description":"Get users status","security":[{"EarlyAccess":["ccaas-user-status:read"]}],"requestBody":{"description":"The body of the request","content":{"application/json":{"schema":{"type":"object","properties":{"user_ids":{"type":"array","description":"The ids of the users that will be returned along with their statuses.
    \nNote that the maximum number of user ids that can be passed is 20.","items":{"type":"string"}}}},"example":{"user_ids":["6137b440d1da6d00183c08fc","5e26fcw3a632f60006980002"]}}}},"tags":["ccaas-user-status-api"],"responses":{"200":{"description":"If the request for the status of said users was successful","content":{"application/json":{"schema":{"description":"Array with objects containing user ids and their corresponding statuses","type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"User ID"},"status":{"type":"string","description":"User's current status"}}}},"example":[{"id":"6137b440d1da6d00183c08fc","status":"available"},{"id":"5e26fcw3a632f60006980002","status":"offline"}]}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid status transition":{"value":{"code":"1580008","message":"The number of requested agents status exceeds the limit of 20","description":"The number of requested user status exceeds the limit of 20."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1580004","message":"Unauthorized","description":"The provided JWT is not valid."}}}},"403":{"description":"Forbidden access","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1580005","message":"Forbidden","description":"Forbidden - Insufficient permissions."}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Internal Server Error":{"value":{"code":"1580007","message":"Internal Server Error","description":"Internal Server Error"}}}}}}}}},"/ccaas/queues":{"post":{"x-namespace":"/ccaas","description":"Create queue","security":[{"EarlyAccess":["queues:write"]}],"summary":"Create queue","tags":["Queues API"],"operationId":"CreateQueue","requestBody":{"description":"The queue to be created","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The name of the Queue. It does not accept upper case letters, cannot begin or end with empty spaces, and can only contain alphabetic characters, punctuation, digits, currency symbols, and whitespace characters.","minLength":1,"maxLength":50},"description":{"type":"string","description":"A quick description of the purpose of the queue","minLength":0,"maxLength":250}},"required":["name","description"]},"example":{"name":"queue_name","description":"my queue has a description"}}}},"responses":{"201":{"description":"Queue created successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","description":"A quick description of the purpose of the queue"},"created_at":{"type":"string","description":"Date when the Queue was created.","format":"date-time"},"updated_at":{"type":"string","description":"Date when the Queue was last updated.","format":"date-time"},"settings":{"type":"object","description":"The settings of a queue","properties":{"voice":{"type":"object","description":"A queue's settings for voice channel","properties":{"transfers":{"type":"object","description":"Transfer operation for voice channel","properties":{"agent_waiting_music":{"type":"object","description":"Waiting music while on a transfer (default or audio prompt) - per queue","properties":{"type":{"type":"string","enum":["PROMPT","URL"],"description":"The type of waiting music"},"value":{"type":"string","description":"The value of waiting music"}}},"maximum_waiting_time":{"type":"integer","description":"Maximum waiting time (in seconds) - per queue"},"offer_time":{"type":"integer","description":"Offering timeout (in seconds) - per queue"}}}}}}}},"required":["id","name","description","created_at"]},"example":{"id":"queue_id","name":"queue_name","description":"my queue has a description","created_at":"2023-04-05T09:45:00Z","updated_at":"2023-04-05T09:45:00Z","settings":{"voice":{"transfers":{"agent_waiting_music":{"type":"PROMPT","value":"prompt_id"},"maximum_waiting_time":1,"offer_time":35}}}}}}},"400":{"description":"Malformed request.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0490002","message":"Malformed request"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0490000","message":"Unauthorized."}}}},"403":{"description":"Insufficient permissions.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0490003","message":"Forbidden."}}}},"409":{"description":"Conflict on create queue.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Queue with given name already exists":{"value":{"code":"0490005","message":"This queue name is already taken"}},"Queue's account limit exceeded":{"value":{"code":"0490022","message":"The number of queues exceeds the limit number of queues an account can have"}}}}}},"422":{"description":"Unprocessable Entity.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid Fields Length":{"value":{"code":"0490007","message":"Invalid queue","fields":[{"name":"name","description":"size must be between 1 and 50"},{"name":"description","description":"size must be between 0 and 250"}]}},"Name Starting With Empty Space":{"value":{"code":"0490007","message":"Invalid queue","fields":[{"name":"name","description":"cannot start with empty space"}]}},"Name Ending With Empty Space":{"value":{"code":"0490007","message":"Invalid queue","fields":[{"name":"name","description":"cannot end with empty space"}]}},"Name Contains Upper Case Letters":{"value":{"code":"0490007","message":"Invalid queue","fields":[{"name":"name","description":"cannot contain upper case letters"}]}},"Name Contains Invalid Characters":{"value":{"code":"0490007","message":"Invalid queue","fields":[{"name":"name","description":"can only contain alphabetic characters, punctuation, digits, currency symbols and whitespace characters"}]}}}}}},"500":{"description":"An unexpected error has occurred.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0490001","message":"An unexpected error has occurred. Contact Talkdesk Support."}}}}}}},"/locations-directory/locations":{"get":{"operationId":"getLocations","tags":["Locations Directory"],"description":"Get the paginated list of locations","security":[{"GA":["locations-directory:read"]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","example":1,"minimum":1,"default":1}},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","example":5,"minimum":1,"maximum":50,"default":50}},{"name":"search","in":"query","required":false,"schema":{"type":"string","example":"Liberdade","description":"Search location by location name or city","default":"","minLength":0,"maxLength":255}},{"name":"external_id","in":"query","required":false,"schema":{"type":"string","example":"external-location-001","description":"The external_id of the location","default":"","minLength":0,"maxLength":9999}},{"name":"location_name","in":"query","required":false,"schema":{"type":"string","example":"Store Avenida da Liberdade","description":"The name of the location","default":"","minLength":0,"maxLength":150}},{"name":"alternative_name","in":"query","required":false,"schema":{"type":"string","example":"Store ADL","description":"The alternative name of the location","default":"","minLength":0,"maxLength":150}},{"name":"location_type","in":"query","required":false,"schema":{"type":"string","example":"Store","description":"The type of the location","default":"","minLength":0,"maxLength":150}},{"name":"address","in":"query","required":false,"schema":{"type":"string","example":"Avenida da Liberdade, 10","description":"The name of the address","default":"","minLength":0,"maxLength":150}},{"name":"zip_code","in":"query","required":false,"schema":{"type":"string","example":"1250-142","description":"The zip-code of the location","default":"","minLength":0,"maxLength":20}},{"name":"city","in":"query","required":false,"schema":{"type":"string","example":"Lisbon","description":"The city of the location","default":"","minLength":0,"maxLength":100}},{"name":"country_name","in":"query","required":false,"schema":{"type":"string","example":"Portugal","description":"The country name","default":"","minLength":0,"maxLength":100}},{"name":"region_name","in":"query","required":false,"schema":{"type":"string","example":"Lisbon","description":"The region name (country subdivision)","default":"","minLength":0,"maxLength":100}},{"name":"latitude","in":"query","required":false,"schema":{"type":"number","format":"double","example":38.698943,"description":"
    • Latitude and longitude are used together with distance. The search parameters include latitude and longitude to retrieve a list of all locations within a certain radius.
    • Currently, these three parameters can only be used when the Feature Flag is enabled.
    ","minimum":-90,"maximum":90}},{"name":"longitude","in":"query","required":false,"schema":{"type":"number","format":"double","example":-9.18423,"description":"
    • Latitude and longitude are used together with distance. The search parameters include latitude and longitude to retrieve a list of all locations within a certain radius.
    • Currently, these three parameters can only be used when the Feature Flag is enabled.
    ","default":"","minimum":-180,"maximum":180}},{"name":"distance","in":"query","required":false,"schema":{"type":"number","format":"double","example":10000,"description":"
    • Distance is measured in meters.
    • If no distance is provided, the default distance configured in Industries-settings will be used.
    • Currently, these three parameters can only be used when the Feature Flag is enabled.
    ","minimum":0}},{"name":"service_id","in":"query","required":false,"schema":{"type":"string","example":"id","description":"The id of the service","default":"","minLength":0,"maxLength":150}},{"name":"service_name","in":"query","required":false,"schema":{"type":"string","example":"service name","description":"The name of the service provided by location","default":"","minLength":0,"maxLength":9999}},{"name":"service_type","in":"query","required":false,"schema":{"type":"string","example":"service type","description":"The type of the service provided by location","default":"","minLength":0,"maxLength":9999}},{"name":"staff_id","in":"query","required":false,"schema":{"type":"string","example":"id","description":"The id of the staff","default":"","minLength":0,"maxLength":150}},{"name":"staff_name","in":"query","required":false,"schema":{"type":"string","example":"staff name","description":"The name of the staff belongs to location","default":"","minLength":0,"maxLength":9999}},{"name":"staff_specialty","in":"query","required":false,"schema":{"type":"string","example":"staff specialty","description":"The specialty of the staff belongs to location","default":"","minLength":0,"maxLength":9999}},{"name":"staff_visit_type","in":"query","required":false,"schema":{"type":"string","example":"type name","description":"The visit type name of the staff belongs to location","default":"","minLength":0,"maxLength":9999}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","example":5,"description":"The return services count for per location","minimum":1,"maximum":2147483647,"default":15}},{"name":"order_by","in":"query","required":false,"schema":{"type":"string","example":"proximity_distance","description":" Specifies the field to order the results by. Currently, only the following value is supported:
    • proximity_distance: Orders the results based on their proximity to the provided latitude and longitude.
      • **Important:** If order_by is set to proximity_distance, you must also provide the latitude and longitude query parameters. Failure to do so will result in a 400 Bad Request error.
    ","default":"","minLength":0,"maxLength":9999}}],"responses":{"200":{"description":"The paginated list of locations","content":{"application/json":{"schema":{"type":"object","description":"Represents a paginated list of locations","required":["count","total","total_pages","page","per_page","_embedded","_links"],"properties":{"count":{"type":"integer","format":"int32","description":"The number of results in the current page","example":40},"total":{"type":"integer","format":"int32","description":"The total of results","example":90},"page":{"type":"integer","format":"int32","description":"The current page","example":2},"per_page":{"type":"integer","format":"int32","description":"The number of results per page","example":50},"total_pages":{"type":"integer","format":"int32","description":"The total number of result pages","example":2},"_embedded":{"type":"object","required":["locations"],"properties":{"locations":{"type":"array","description":"The list of locations in the current page","items":{"allOf":[{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The location identifier","minLength":1,"example":"d08d05cc-ac7a-11ed-afa1-0242ac120002"}}},{"type":"object","required":["name","time_zone","address"],"properties":{"name":{"type":"string","description":"The name of the location","minLength":1,"example":"Store Avenida da Liberdade"},"alternative_names":{"type":"array","description":"The alternative names of the location","example":["Liberdade Store","Lisboa Flagship"],"items":{"type":"string","description":"The alternative name (e.g., Liberdade Store, Lisboa Flagship)","minLength":1,"maxLength":9999,"example":"Liberdade Store"}},"external_id":{"type":"string","description":"The external id of the location","minLength":1,"example":123},"type":{"type":"string","description":"The type of the location","minLength":1,"example":"Store"},"time_zone":{"type":"string","description":"The time zone of the location, according to IANA.","minLength":1,"example":"Europe/Lisbon"},"phone_numbers":{"type":"array","items":{"type":"object","description":"Represents the phone numbers of a location","required":["phone_number"],"properties":{"phone_number":{"type":"string","description":"The phone number of one person.","example":"+351123456789","minLength":1},"name":{"type":"string","description":"The phone number name","example":"Home","minLength":1}}}},"image_url":{"type":"string","description":"The URL of an image of the location","minLength":1,"example":"https://my-image-cdn.com/path/to/my/store/image.png"},"address":{"type":"object","description":"Represents the address of a location","required":["address","zip_code","country_name"],"properties":{"address":{"type":"string","description":"The address line of the location. Typically the street, number, etc.","example":"Lisbon","minLength":1},"zip_code":{"type":"string","description":"The zip-code of the location","example":"20000000","minLength":1},"city":{"type":"string","description":"The city of the location","example":"Lisbon","minLength":1},"region_name":{"type":"string","description":"The region name (country subdivision)","example":"Lisbon","minLength":1},"country_name":{"type":"string","description":"The country name","example":"Portugal","minLength":1},"coordinates":{"type":"object","required":["latitude","longitude"],"properties":{"latitude":{"type":"number","format":"double","minimum":-90,"maximum":90,"example":38.736946},"longitude":{"type":"number","format":"double","minimum":-180,"maximum":180,"example":-9.142685}}}}},"opening_status":{"type":"string","description":"The status of the location, if it is opened or closed","minLength":1,"enum":["OPEN","CLOSED"],"example":"OPEN"},"services":{"type":"array","description":"The list of services","items":{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","description":"The id of service","minLength":1,"maxLength":9999,"example":"d06b0425-c9eb-d8a3-a7c0-ce14d96a651f"},"name":{"type":"string","description":"The name of service","minLength":1,"maxLength":9999,"example":"name"}}}}}}]}}}},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string","format":"uri","example":"http://api-docs.talkdesk.org/locations-directory/locations?page=1&per_page=10"}}},"next":{"type":"object","required":["href"],"properties":{"href":{"type":"string","format":"uri","example":"http://api-docs.talkdesk.org/locations-directory/locations?page=2&per_page=10"}}}}}}},"example":{"_embedded":{"locations":[{"id":"d08d05cc-ac7a-11ed-afa1-0242ac120002","name":"Store Avenida da Liberdade","alternative_names":["Liberdade Store","Lisboa Flagship"],"type":"Store","external_id":123,"phone_numbers":[{"phone_number":"+351123456789","name":"Home"},{"phone_number":"+351123456780","name":"Personal"}],"time_zone":"Europe/Lisbon","image_url":"https://my-image-cdn.com/path/to/my/avenida-da-liberdade-store/image.png","address":{"address":"Avenida da Liberdade, 10","zip_code":"1250-142","city":"Lisbon","region_name":"Lisbon","country_name":"Portugal","coordinates":{"latitude":38.736946,"longitude":-9.142685}}},{"id":"e740d8ce-ac7b-11ed-afa1-0242ac120002","phone_numbers":[{"phone_number":"+351123456789","name":"Home"},{"phone_number":"+351123456780","name":"Personal"}],"time_zone":"Europe/Lisbon","name":"Store Avenida dos Aliados","external_id":123,"image_url":"https://my-image-cdn.com/path/to/my/avenida-dos-aliados-store/image.png","address":{"address":"Avenida dos Aliados","zip_code":"4000-066","city":"Porto","region_name":"Porto","country_name":"Portugal","coordinates":{"latitude":41.15,"longitude":-8.61024}},"services":[{"id":"d06b0425-c9eb-d8a3-a7c0-ce14d96a651f","name":"name"},{"id":"f06b0425-c9eb-d8a3-a7c0-ce14d96a651f","name":"name1"}]}]},"_links":{"self":{"href":"http://api-docs.talkdesk.org/locations-directory/locations?page=1&per_page=2"},"next":{"href":"http://api-docs.talkdesk.org/locations-directory/locations?page=2&per_page=2"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"4034000","message":"Bad request."}}}}}}},"/locations-directory/locations/cities":{"get":{"operationId":"getLocationCities","tags":["Locations Directory"],"description":"Get location cities","security":[{"EarlyAccess":["locations-directory:read"]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","example":"1","minimum":1,"default":1}},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","example":"5","minimum":1,"maximum":50,"default":50}},{"name":"location_name","in":"query","required":false,"schema":{"type":"string","example":"Store Avenida da Liberdade","description":"The name of the location","default":"","minLength":0,"maxLength":150}},{"name":"alternative_name","in":"query","required":false,"schema":{"type":"string","example":"Store ADL","description":"The alternative name of the location","default":"","minLength":0,"maxLength":150}},{"name":"zip_code","in":"query","required":false,"schema":{"type":"string","example":"1250-142","description":"The zip-code of the location, if both zip_code and city have filter, will return records matched zip_code filter or city filter","default":"","minLength":0,"maxLength":9999}},{"name":"city","in":"query","required":false,"schema":{"type":"string","example":"Lisbon","description":"The city of the location, if both zip_code and city have filter, will return records matched zip_code filter or city filter","default":"","minLength":0,"maxLength":9999}},{"name":"latitude","in":"query","required":false,"schema":{"type":"number","format":"double","example":38.698943,"description":"
    • Latitude and longitude are used together with distance. The search parameters include latitude and longitude to retrieve a list of all locations within a certain radius.
    • Currently, these three parameters can only be used when the Feature Flag is enabled.
    ","minimum":-90,"maximum":90}},{"name":"longitude","in":"query","required":false,"schema":{"type":"number","format":"double","example":-9.18423,"description":"
    • Latitude and longitude are used together with distance. The search parameters include latitude and longitude to retrieve a list of all locations within a certain radius.
    • Currently, these three parameters can only be used when the Feature Flag is enabled.
    ","default":"","minimum":-180,"maximum":180}},{"name":"distance","in":"query","required":false,"schema":{"type":"number","format":"double","example":10000,"description":"
    • Distance is measured in meters.
    • If no distance is provided, the default distance configured in Industries-settings will be used.
    • Currently, these three parameters can only be used when the Feature Flag is enabled.
    ","minimum":0}},{"name":"specialities","in":"query","required":false,"description":"The list of staff speciality, multiple values should split by ',' , like speciality1,speciality2","schema":{"type":"string","minLength":1,"example":"IT support"}},{"name":"service_names","in":"query","required":false,"schema":{"type":"string","example":"serviceName","description":"The name list of the service, multiple values should split by ',' , like serviceName1,serviceName2","minLength":0,"maxLength":150}}],"responses":{"200":{"description":"Get location cities successfully","content":{"application/json":{"schema":{"type":"object","required":["_embedded","total"],"properties":{"count":{"type":"integer","description":"the number of results in the current page"},"total":{"type":"integer","description":"the total of results in the account"},"page":{"type":"integer","description":"the current page"},"per_page":{"type":"integer","description":"the number of results per page"},"total_pages":{"type":"integer","description":"the number of the total of result pages"},"_embedded":{"type":"object","required":["cities"],"properties":{"cities":{"type":"array","items":{"type":"string","example":"Lisbon"}}}},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","example":"https://api-docs.talkdesk.org/"}}}}}}},"example":{"_embedded":{"cities":["Lisbon","New York"]},"count":1,"total":2,"page":1,"per_page":1,"total_pages":2,"_links":{"self":{"href":"http://api-docs.talkdesk.org/locations-directory/locations/cities?page=1&per_page=20"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"4034000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484010","message":"Invalid JWT token."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484030","message":"Required scopes are missing."}}}}}}},"/locations-directory/locations/names":{"get":{"operationId":"getLocationNames","tags":["Locations Directory"],"description":"Get location names","security":[{"EarlyAccess":["locations-directory:read"]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","example":"1","minimum":1,"default":1}},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","example":"5","minimum":1,"maximum":50,"default":50}},{"name":"location_name","in":"query","required":false,"schema":{"type":"string","example":"Store Avenida da Liberdade","description":"The name of the location","default":"","minLength":0,"maxLength":150}},{"name":"latitude","in":"query","required":false,"schema":{"type":"number","format":"double","example":38.698943,"description":"
    • Latitude and longitude are used together with distance. The search parameters include latitude and longitude to retrieve a list of all locations within a certain radius.
    • Currently, these three parameters can only be used when the Feature Flag is enabled.
    ","minimum":-90,"maximum":90}},{"name":"longitude","in":"query","required":false,"schema":{"type":"number","format":"double","example":-9.18423,"description":"
    • Latitude and longitude are used together with distance. The search parameters include latitude and longitude to retrieve a list of all locations within a certain radius.
    • Currently, these three parameters can only be used when the Feature Flag is enabled.
    ","default":"","minimum":-180,"maximum":180}},{"name":"distance","in":"query","required":false,"schema":{"type":"number","format":"double","example":10000,"description":"
    • Distance is measured in meters.
    • If no distance is provided, the default distance configured in Industries-settings will be used.
    • Currently, these three parameters can only be used when the Feature Flag is enabled.
    ","minimum":0}}],"responses":{"200":{"description":"Get location names successfully","content":{"application/json":{"schema":{"type":"object","required":["_embedded","total"],"properties":{"count":{"type":"integer","description":"the number of results in the current page"},"total":{"type":"integer","description":"the total of results in the account"},"page":{"type":"integer","description":"the current page"},"per_page":{"type":"integer","description":"the number of results per page"},"total_pages":{"type":"integer","description":"the number of the total of result pages"},"_embedded":{"type":"object","required":["locations"],"properties":{"locations":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"the name of the location","example":"Store Avenida da Liberdade"},"id":{"type":"string","description":"the unique identifier of the location","example":"12345678-1234-1234-1234-123456789012"}}}}}},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","example":"https://api-docs.talkdesk.org/"}}}}}}},"example":{"_embedded":{"locations":[{"name":"Store Avenida da Liberdade","id":"12345678-1234-1234-1234-123456789012"},{"name":"Store Rua Augusta","id":"23456789-2345-2345-2345-234567890123"}]},"count":1,"total":2,"page":1,"per_page":1,"total_pages":2,"_links":{"self":{"href":"http://api-docs.talkdesk.org/locations-directory/locations/names?page=1&per_page=20"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"4034000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484010","message":"Invalid JWT token."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484030","message":"Required scopes are missing."}}}}}}},"/locations-directory/locations-agent":{"get":{"operationId":"getLocationsAgent","tags":["Locations Directory"],"description":"Get the paginated list of locations for agent view","security":[{"EarlyAccess":["locations-directory:read"]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","example":1,"minimum":1,"default":1}},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","example":5,"minimum":1,"maximum":100,"default":50}},{"name":"location_type","in":"query","required":false,"schema":{"type":"string","example":"Store","description":"The type of the location","default":"","minLength":0,"maxLength":150}},{"name":"cities","in":"query","required":false,"schema":{"type":"string","example":"cityName","description":"The name list of city, multiple values should split by ',' , like cityName1,cityName2","minLength":0,"maxLength":150}},{"name":"region_name","in":"query","required":false,"schema":{"type":"string","example":"Lisbon","description":"The region name (country subdivision)","default":"","minLength":0,"maxLength":100}},{"name":"country_name","in":"query","required":false,"schema":{"type":"string","example":"Portugal","description":"The country name","default":"","minLength":0,"maxLength":100}},{"name":"latitude","in":"query","required":false,"schema":{"type":"number","format":"double","example":38.698943,"description":"
    • Latitude and longitude are used together with distance. The search parameters include latitude and longitude to retrieve a list of all locations within a certain radius.
    • Currently, these three parameters can only be used when the Feature Flag is enabled.
    ","minimum":-90,"maximum":90}},{"name":"longitude","in":"query","required":false,"schema":{"type":"number","format":"double","example":-9.18423,"description":"
    • Latitude and longitude are used together with distance. The search parameters include latitude and longitude to retrieve a list of all locations within a certain radius.
    • Currently, these three parameters can only be used when the Feature Flag is enabled.
    ","default":"","minimum":-180,"maximum":180}},{"name":"distance","in":"query","required":false,"schema":{"type":"number","format":"double","example":10000,"description":"
    • Distance is measured in meters.
    • If no distance is provided, the default distance configured in Industries-settings will be used.
    • Currently, these three parameters can only be used when the Feature Flag is enabled.
    ","minimum":0}},{"name":"service_names","in":"query","required":false,"schema":{"type":"string","example":"serviceName","description":"The name list of the service, multiple values should split by ',' , like serviceName1,serviceName2","minLength":0,"maxLength":150}},{"name":"service_type","in":"query","required":false,"schema":{"type":"string","example":"service type","description":"The type of the service provided by location","default":"","minLength":0,"maxLength":9999}},{"name":"service_duration","in":"query","required":false,"schema":{"type":"string","example":"service duration","description":"The duration of the service provided by location","default":"","minLength":0,"maxLength":9999}},{"name":"specialities","in":"query","required":false,"description":"The list of staff speciality, multiple values should split by ',' , like speciality1,speciality2","schema":{"type":"string","minLength":1,"example":"IT support"}},{"name":"staff_visit_type","in":"query","required":false,"schema":{"type":"string","example":"type name","description":"The visit type name of the staff belongs to location","default":"","minLength":0,"maxLength":9999}},{"name":"languages","in":"query","required":false,"description":"The list of staff language, multiple values should split by ',' , like English,Chinese","schema":{"type":"string","minLength":1,"example":"English"}},{"name":"gender","in":"query","required":false,"schema":{"type":"string","example":"Female","description":"The gender of the staff belongs to location, if gender = 'Other', it will return all staffs which gender is not in ['Female', 'Male']","default":"","minLength":0,"maxLength":9999}}],"responses":{"200":{"description":"The paginated list of locations","content":{"application/json":{"schema":{"type":"object","description":"Represents a paginated list of locations","required":["count","total","total_pages","page","per_page","_embedded","_links"],"properties":{"count":{"type":"integer","format":"int32","description":"The number of results in the current page","example":40},"total":{"type":"integer","format":"int32","description":"The total of results","example":90},"page":{"type":"integer","format":"int32","description":"The current page","example":2},"per_page":{"type":"integer","format":"int32","description":"The number of results per page","example":50},"total_pages":{"type":"integer","format":"int32","description":"The total number of result pages","example":2},"_embedded":{"type":"object","required":["locations"],"properties":{"locations":{"type":"array","description":"The list of locations in the current page","items":{"allOf":[{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The location identifier","minLength":1,"example":"d08d05cc-ac7a-11ed-afa1-0242ac120002"},"opening_hours":{"type":"array","description":"The List of the location opening hours for the next 7 days order by date.","items":{"allOf":[{"type":"object","description":"Represents the opening hours of a given date.","required":["id","date"],"properties":{"id":{"type":"integer","description":"The value of the day of week for a special date","minLength":1,"example":1},"date":{"type":"string","format":"date","description":"The ISO-formatted date to which the open hours refer to.","minLength":1,"example":"2023-05-01"},"special_date_name":{"type":"string","description":"Name of the special date, if it is defined.","example":"International Workers' Day","minLength":1}}},{"type":"object","required":["day_of_week","slots"],"properties":{"day_of_week":{"type":"string","description":"The day of the week to which the open hours refer to","minLength":1,"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"example":"TUESDAY"},"slots":{"type":"array","items":{"type":"object","required":["open_at","close_at"],"properties":{"open_at":{"type":"string","description":"The hour at which the location opens, in the location's time zone. Formatted according to the ISO-8601 standard.","minLength":1,"pattern":"^\\d\\d\\:\\d\\d\\:\\d\\d$","example":"09:00:00"},"close_at":{"type":"string","description":"The hour at which the location closes, in the location's time zone. Formatted according to the ISO-8601 standard.","minLength":1,"pattern":"^\\d\\d\\:\\d\\d\\:\\d\\d$","example":"18:00:00"}}}}}}]}},"specialities":{"type":"array","items":{"type":"string","example":"IT support"}},"service_names":{"type":"array","items":{"type":"string","example":"ServiceName"}}}},{"type":"object","required":["name","time_zone","address"],"properties":{"name":{"type":"string","description":"The name of the location","minLength":1,"example":"Store Avenida da Liberdade"},"alternative_names":{"type":"array","description":"The alternative names of the location","example":["Liberdade Store","Lisboa Flagship"],"items":{"type":"string","description":"The alternative name (e.g., Liberdade Store, Lisboa Flagship)","minLength":1,"maxLength":9999,"example":"Liberdade Store"}},"external_id":{"type":"string","description":"The external id of the location","minLength":1,"example":123},"type":{"type":"string","description":"The type of the location","minLength":1,"example":"Store"},"time_zone":{"type":"string","description":"The time zone of the location, according to IANA.","minLength":1,"example":"Europe/Lisbon"},"phone_numbers":{"type":"array","items":{"type":"object","description":"Represents the phone numbers of a location","required":["phone_number"],"properties":{"phone_number":{"type":"string","description":"The phone number of one person.","example":"+351123456789","minLength":1},"name":{"type":"string","description":"The phone number name","example":"Home","minLength":1}}}},"image_url":{"type":"string","description":"The URL of an image of the location","minLength":1,"example":"https://my-image-cdn.com/path/to/my/store/image.png"},"address":{"type":"object","description":"Represents the address of a location","required":["address","zip_code","country_name"],"properties":{"address":{"type":"string","description":"The address line of the location. Typically the street, number, etc.","example":"Lisbon","minLength":1},"zip_code":{"type":"string","description":"The zip-code of the location","example":"20000000","minLength":1},"city":{"type":"string","description":"The city of the location","example":"Lisbon","minLength":1},"region_name":{"type":"string","description":"The region name (country subdivision)","example":"Lisbon","minLength":1},"country_name":{"type":"string","description":"The country name","example":"Portugal","minLength":1},"coordinates":{"type":"object","required":["latitude","longitude"],"properties":{"latitude":{"type":"number","format":"double","minimum":-90,"maximum":90,"example":38.736946},"longitude":{"type":"number","format":"double","minimum":-180,"maximum":180,"example":-9.142685}}}}},"opening_status":{"type":"string","description":"The status of the location, if it is opened or closed","minLength":1,"enum":["OPEN","CLOSED"],"example":"OPEN"},"services":{"type":"array","description":"The list of services","items":{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","description":"The id of service","minLength":1,"maxLength":9999,"example":"d06b0425-c9eb-d8a3-a7c0-ce14d96a651f"},"name":{"type":"string","description":"The name of service","minLength":1,"maxLength":9999,"example":"name"}}}}}}]}}}},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string","format":"uri","example":"http://api-docs.talkdesk.org/locations-directory/locations-agent?page=1&per_page=10"}}},"next":{"type":"object","required":["href"],"properties":{"href":{"type":"string","format":"uri","example":"http://api-docs.talkdesk.org/locations-directory/locations-agent?page=2&per_page=10"}}}}}}},"example":{"_embedded":{"locations":[{"id":"d08d05cc-ac7a-11ed-afa1-0242ac120002","name":"Store Avenida da Liberdade","type":"Store","external_id":123,"phone_numbers":[{"phone_number":"+351123456789","name":"Home"},{"phone_number":"+351123456780","name":"Personal"}],"time_zone":"Europe/Lisbon","opening_status":"CLOSED","image_url":"https://my-image-cdn.com/path/to/my/avenida-da-liberdade-store/image.png","address":{"address":"Avenida da Liberdade, 10","zip_code":"1250-142","city":"Lisbon","region_name":"Lisbon","country_name":"Portugal","coordinates":{"latitude":38.736946,"longitude":-9.142685}},"opening_hours":[{"id":1,"date":"2023-05-01","day_of_week":"MONDAY","external_id":123,"special_date_name":"International Workers' Day","slots":[{"open_at":"09:00:00","close_at":"11:00:00"},{"open_at":"20:00:00","close_at":"23:00:00"}]}],"service_names":["ServiceName1","ServiceName2"],"specialities":["IT support","Diagnostic specialist"]}]},"_links":{"self":{"href":"http://api-docs.talkdesk.org/locations-directory/locations-agent?page=1&per_page=2"},"next":{"href":"http://api-docs.talkdesk.org/locations-directory/locations-agent?page=2&per_page=2"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"4034000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484010","message":"Invalid JWT token."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484030","message":"Required scopes are missing."}}}}}}},"/locations-directory/locations-staffs":{"post":{"operationId":"getLocationsStaffView","tags":["Locations Directory"],"description":"Get the list of locations and staffs for agent view","security":[{"EarlyAccess":["locations-directory:read"]}],"requestBody":{"description":"Locations & Staffs list filter parameters","required":true,"content":{"application/hal+json":{"schema":{"type":"object","description":"Request body for Locations & Staffs list (previously query parameters)","properties":{"entity_type":{"type":"string","description":"The type of the entity, can be location or staff","example":"location","default":"","minLength":0,"maxLength":50},"search_term":{"type":"string","description":"The type of the entity, can be location or staff","example":"location","default":"","minLength":0,"maxLength":100},"latitude":{"type":"number","format":"double","example":38.698943,"description":"
      \n
    • Latitude and longitude are used together with distance. The search parameters include latitude and longitude to retrieve a list of all locations within a certain radius.
      • \n
    • Currently, these three parameters can only be used when the Feature Flag is enabled.
      • \n
    \n","minimum":-90,"maximum":90},"longitude":{"type":"number","format":"double","example":-9.18423,"description":"
      \n
    • Latitude and longitude are used together with distance. The search parameters include latitude and longitude to retrieve a list of all locations within a certain radius.
      • \n
    • Currently, these three parameters can only be used when the Feature Flag is enabled.
      • \n
    \n","default":"","minimum":-180,"maximum":180},"distance":{"type":"number","format":"double","example":10000,"description":"
      \n
    • Distance is measured in meters.
      • \n
    • If no distance is provided, the default distance configured in Industries-settings will be used.
      • \n
    • Currently, these three parameters can only be used when the Feature Flag is enabled.
      • \n
    \n","minimum":0},"location_ids":{"type":"string","example":"loc1,loc2","description":"The name list of the location, multiple values should split by ',' , like locationName1,locationName2","minLength":0,"maxLength":150},"service_ids":{"type":"string","example":"ser_id1,ser_id2","description":"The name list of the service, multiple values should split by ',' , like serviceName1,serviceName2","minLength":0,"maxLength":150},"service_type":{"type":"string","example":"service type","description":"The type of the service provided by location","default":"","minLength":0,"maxLength":9999},"service_duration":{"type":"string","example":"service duration","description":"The duration of the service provided by location","default":"","minLength":0,"maxLength":9999},"staff_specialities":{"type":"string","description":"The list of staff speciality, multiple values should split by ',' , like speciality1,speciality2","minLength":1,"example":"IT support"},"staff_languages":{"type":"string","description":"The list of staff language, multiple values should split by ',' , like English,Chinese","minLength":1,"maxLength":50,"example":"English"},"staff_gender":{"type":"string","example":"Female","description":"The gender of the staff belongs to location, if gender = 'Other', it will return all staffs which gender is not in ['Female', 'Male']","default":"","minLength":0,"maxLength":50},"staff_tags":{"type":"string","example":"tag1,tag2","description":"The list of staff tags, multiple values should split by ',' , like tag1,tag2","default":"","minLength":0,"maxLength":50}}},"example":{"entity_type":"location","search_term":"location","latitude":38.698943,"longitude":-9.18423,"distance":10000,"location_ids":"loc1,loc2","service_ids":"ser_id1,ser_id2","service_type":"service type","service_duration":"service duration","staff_specialities":"IT support,Finance","staff_languages":"English,Spanish","staff_gender":"Female","staff_tags":"tag1,tag2"}}}},"responses":{"200":{"description":"The list of locations and staffs for agent view","content":{"application/json":{"schema":{"type":"array","description":"Represents Top 100 locations list and staffs list","items":{"type":"object","required":["id","name","type","external_id","phone_numbers","time_zone","opening_status","image_url","address","opening_hours"],"properties":{"id":{"type":"string","description":"The location identifier or The staff identifier.","minLength":1,"example":"d08d05cc-ac7a-11ed-afa1-0242ac120002"},"name":{"type":"string","description":"The name of the location or The name of the staff.","minLength":1,"example":"Store Avenida da Liberdade"},"entity_type":{"type":"string","description":"The type of the entity, either \"location\" or \"staff\".","minLength":1,"example":"location"},"external_id":{"type":"string","description":"The external identifier of the location or staff.","minLength":1,"example":"123"},"phone_numbers":{"type":"array","description":"The list of phone numbers associated with the location or staff.","items":{"type":"object","required":["phone_number"],"properties":{"phone_number":{"type":"string","description":"The phone number in E.164 format.","minLength":1,"maxLength":20,"example":"+351123456789"},"phone_number_name":{"type":"string","description":"The name of the phone number.","minLength":1,"maxLength":50,"example":"Home"}}}},"services":{"type":"array","description":"The list of service names associated with the location or staff.","items":{"type":"object","required":["id","service_name","description"],"properties":{"id":{"type":"string","description":"The id of service","example":"a78d05cc-ac7a-11ed-afa1-0242ac120012"},"service_name":{"type":"string","description":"The name of service","example":"Shopping"},"service_type":{"type":"string","description":"The type of service","example":"Online"},"duration":{"type":"string","description":"The duration of service","example":"30-45 minutes"},"time_zone":{"type":"string","description":"The time zone of the service, according to IANA.","minLength":1,"example":"Europe/Lisbon"}}}},"rank":{"type":"number","description":"The rank of the location or staff in the list.","example":0.6011113},"location_alternative_names":{"type":"array","description":"The alternative names of the location","example":["Liberdade Store","Lisboa Flagship"],"items":{"type":"string","description":"The alternative name (e.g., Liberdade Store, Lisboa Flagship)","minLength":1,"maxLength":9999,"example":"Liberdade Store"}},"location_type":{"type":"string","description":"The type of the location","minLength":1,"example":"Store"},"location_image_url":{"type":"string","description":"The URL of an image of the location","minLength":1,"example":"https://my-image-cdn.com/path/to/my/store/image.png"},"location_opening_status":{"type":"string","description":"The status of the location, if it is opened or closed","minLength":1,"enum":["OPEN","CLOSED"],"example":"OPEN"},"location_time_zone":{"type":"string","description":"The time zone of the location, according to IANA.","minLength":1,"example":"Europe/Lisbon"},"location_address":{"type":"object","description":"Represents the address of a location","required":["address","zip_code","country_name"],"properties":{"address":{"type":"string","description":"The address line of the location. Typically the street, number, etc.","example":"Lisbon","minLength":1},"zip_code":{"type":"string","description":"The zip-code of the location","example":"20000000","minLength":1},"city":{"type":"string","description":"The city of the location","example":"Lisbon","minLength":1},"region_name":{"type":"string","description":"The region name (country subdivision)","example":"Lisbon","minLength":1},"country_name":{"type":"string","description":"The country name","example":"Portugal","minLength":1},"coordinates":{"type":"object","required":["latitude","longitude"],"properties":{"latitude":{"type":"number","format":"double","minimum":-90,"maximum":90,"example":38.736946},"longitude":{"type":"number","format":"double","minimum":-180,"maximum":180,"example":-9.142685}}}}},"location_business_hours":{"type":"array","description":"The list of business hours for the location.","items":{"type":"array","description":"The list of business hours for the location.","items":{"type":"object","required":["open_at","close_at"],"properties":{"open_at":{"type":"string","description":"The hour at which the location opens, in the location's time zone. Formatted according to the ISO-8601 standard.","minLength":1,"pattern":"^\\d\\d\\:\\d\\d\\:\\d\\d$","example":"09:00:00"},"close_at":{"type":"string","description":"The hour at which the location closes, in the location's time zone. Formatted according to the ISO-8601 standard.","minLength":1,"pattern":"^\\d\\d\\:\\d\\d\\:\\d\\d$","example":"18:00:00"}}}}},"staff_location_name":{"type":"array","description":"The list of locations where the staff works","items":{"type":"string","description":"The name of the location where the staff works","minLength":1,"maxLength":9999,"example":"Store Avenida"}},"staff_description":{"type":"string","description":"The description of staff","minLength":1,"maxLength":9999,"example":"I am a Doctor"},"staff_industry":{"type":"string","description":"The industry of staff","minLength":1,"maxLength":9999,"example":"Doctor"},"staff_status":{"type":"string","description":"The status of staff","minLength":1,"maxLength":9999,"example":"Active"},"staff_photo_url":{"type":"string","description":"The photo url of staff","minLength":1,"maxLength":9999,"example":"https://images/1.png"},"staff_gender":{"type":"string","description":"The gender of staff","minLength":1,"maxLength":9999,"example":"male"},"staff_languages":{"type":"array","description":"The languages of staff","items":{"type":"string","minLength":1,"maxLength":9999,"description":"The language of staff","example":"English"}},"staff_job_title":{"type":"string","description":"Professional title (e.g. Mid Market Customer Success Manager)","minLength":1,"maxLength":9999,"example":"Success Manager"},"staff_manager":{"type":"string","description":"Name of direct manager","minLength":1,"maxLength":9999,"example":"Maike"},"staff_pronouns":{"type":"string","description":"Understand the employee pronouns (e.g. she/her, he/his)","minLength":1,"maxLength":9999,"example":"she"},"staff_specialities":{"type":"array","description":"The specialties of staff","items":{"type":"string","description":"The specialty or areas of expertise (e.g., cardiology, pediatrics)","minLength":1,"maxLength":9999,"example":"cardiology"}},"staff_date_of_birth":{"type":"string","description":"The dateOfBirth of staff","minLength":1,"maxLength":9999,"example":"1987-01-23"},"staff_date_of_hire":{"type":"string","description":"The dateOfHire of staff","minLength":1,"maxLength":9999,"example":"2021-03-23"},"staff_visit_types":{"type":"array","description":"The visit type list of staff","items":{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","description":"The id of visit type, can be anything","minLength":1,"maxLength":9999,"example":"d06b0425-c9eb-d8a3-a7c0-ce14d96a651f"},"name":{"type":"string","description":"The name of visit type, can be anything","minLength":1,"maxLength":9999,"example":"name"}}}},"staff_tags":{"description":"Tag list","type":"array","items":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The id of tag","minLength":1,"maxLength":9999,"example":"d06b0425-c9eb-d8a3-a7c0-ce14d96a651f"},"value":{"type":"string","description":"The value of tag","minLength":1,"maxLength":9999,"example":"VIP"},"color":{"type":"string","description":"The color of tag","minLength":1,"maxLength":9999,"example":"#EFDBFF"}}}}}}},"example":[{"id":"d08d05cc-ac7a-11ed-afa1-0242ac120002","name":"Store Avenida da Liberdade","entity_type":"location","external_id":"123","phone_numbers":[{"phone_number":"+351123456789","phone_number_name":"Home"},{"phone_number":"+351123456780","phone_number_name":"Personal"}],"services":[{"id":"a78d05cc-ac7a-11ed-afa1-0242ac120012","service_name":"Shopping","description":"Shopping service","service_type":"Online","duration":"30-45 minutes","time_zone":"Europe/Lisbon"}],"rank":0.6011113,"location_alternative_names":["Liberdade Store","Lisboa Flagship"],"location_type":"Store","location_image_url":"https://my-image-cdn.com/path/to/my/store/image.png","location_opening_status":"CLOSED","location_time_zone":"Europe/Lisbon","location_address":{"address":"Avenida da Liberdade, 10","zip_code":"1250-142","city":"Lisbon","region_name":"Lisbon","country_name":"Portugal","coordinates":{"latitude":38.736946,"longitude":-9.142685}},"location_business_hours":[{"open_at":"09:00:00","close_at":"12:00:00"},{"open_at":"14:00:00","close_at":"18:00:00"}],"staff_location_name":["Store Avenida"],"staff_description":"I am a Doctor","staff_industry":"Doctor","staff_status":"Active","staff_photo_url":"https://images","staff_gender":"female","staff_languages":["English","Spanish"],"staff_job_title":"Success Manager","staff_manager":"Maike","staff_pronouns":"she","staff_specialities":["cardiology","pediatrics"],"staff_date_of_birth":"1987-01-23","staff_date_of_hire":"2021-03-23","staff_visit_types":[{"id":"d06b0425-c9eb-d8a3-a7c0-ce14d96a651f","name":"name"}],"staff_tags":[{"id":"tag1","value":"Tag 1","color":"#FF5733"},{"id":"tag2","value":"Tag 2","color":"#33FF57"}]}]}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"4034000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484010","message":"Invalid JWT token."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484030","message":"Required scopes are missing."}}}}}}},"/locations-directory/locations/customer-address":{"get":{"operationId":"getCustomerAddresses","tags":["Locations Directory"],"description":"get customer addresses","security":[{"EarlyAccess":["locations-directory:read"]}],"parameters":[{"name":"interaction_id","in":"query","required":false,"schema":{"type":"string","minLength":0,"maxLength":255}},{"name":"contact_id","in":"query","required":false,"schema":{"type":"string","minLength":0,"maxLength":255}},{"name":"industry","in":"query","required":false,"schema":{"type":"string","minLength":0,"maxLength":255,"enum":["HLS","FSI","Retail"]}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","example":1,"minimum":1,"maximum":1,"default":1}},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","example":20,"minimum":1,"maximum":20,"default":20}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","description":"Represents geo address list.","required":["_embedded","_links"],"properties":{"_embedded":{"type":"object","required":["addresses"],"properties":{"addresses":{"type":"array","description":"The List of the geo address.","items":{"allOf":[{"type":"object","description":"Represents the geo address","required":["id","display_name","address","country_name","zip_code","coordinates"],"properties":{"id":{"type":"string","description":"The unique identifier of this Google geo address.","minLength":1,"example":"ChIJLU7jZClu5kcR4PcOOO6p3I0"},"display_name":{"type":"string","description":"The localized name of the place, suitable as a short human-readable description. For example, 'Google Sydney', 'Starbucks', 'Pyrmont', etc.","minLength":1,"example":"Hard Rock Cafe"},"address":{"type":"string","description":"It is a string containing the human-readable address of this location.","minLength":1,"example":"Avenida da Liberdade, 10"},"zip_code":{"type":"string","description":"The zip-code of the location","example":"1250-142","minLength":1},"city":{"type":"string","description":"The city of the location","example":"Lisbon","minLength":1},"region_name":{"type":"string","description":"The region name (country subdivision)","example":"Lisbon","minLength":1},"country_name":{"type":"string","description":"The country name","example":"Portugal","minLength":1},"coordinates":{"type":"object","required":["latitude","longitude"],"properties":{"latitude":{"type":"number","format":"double","minimum":-90,"maximum":90,"example":38.736946},"longitude":{"type":"number","format":"double","minimum":-180,"maximum":180,"example":-9.142685}}}}}]}}}},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string","format":"uri","example":"https://api-docs.talkdesk.org/locations-directory/locations/customer-address"}}}}}}},"example":{"_embedded":{"addresses":[{"id":"ChIJF9aljh1w5kcRJKA__KGc7W4","display_name":"Hard Rock Cafe","address":"5 Av. de Suffren, 75007 Paris, France","zip_code":"75007","city":"Paris","region_name":"Département de Paris","country_name":"France","coordinates":{"latitude":48.856944,"longitude":2.292222}},{"id":"ChIJFxVi-t9v5kcRyVC-eTkcleg","display_name":"Rock Cafe","address":"67 Av. de la Bourdonnais, 75007 Paris, France","zip_code":"75007","city":"Paris","region_name":"Département de Paris","country_name":"France","coordinates":{"latitude":48.856976,"longitude":2.301632}}]},"_links":{"self":{"href":"https://api-docs.talkdesk.org/locations-directory/locations/customer-address"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"4034000","message":"Bad request."}}}}}}},"/locations-directory/locations/{location_id}":{"get":{"operationId":"getLocationById","tags":["Locations Directory"],"description":"Get a location by id","security":[{"GA":["locations-directory:read"]}],"parameters":[{"name":"location_id","in":"path","required":true,"description":"The location id","schema":{"type":"string","minLength":1,"example":"12345"}}],"responses":{"200":{"description":"The retrieved location","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"allOf":[{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The location identifier","minLength":1,"example":"d08d05cc-ac7a-11ed-afa1-0242ac120002"}}},{"type":"object","required":["name","time_zone","address"],"properties":{"name":{"type":"string","description":"The name of the location","minLength":1,"example":"Store Avenida da Liberdade"},"alternative_names":{"type":"array","description":"The alternative names of the location","example":["Liberdade Store","Lisboa Flagship"],"items":{"type":"string","description":"The alternative name (e.g., Liberdade Store, Lisboa Flagship)","minLength":1,"maxLength":9999,"example":"Liberdade Store"}},"external_id":{"type":"string","description":"The external id of the location","minLength":1,"example":123},"type":{"type":"string","description":"The type of the location","minLength":1,"example":"Store"},"time_zone":{"type":"string","description":"The time zone of the location, according to IANA.","minLength":1,"example":"Europe/Lisbon"},"phone_numbers":{"type":"array","items":{"type":"object","description":"Represents the phone numbers of a location","required":["phone_number"],"properties":{"phone_number":{"type":"string","description":"The phone number of one person.","example":"+351123456789","minLength":1},"name":{"type":"string","description":"The phone number name","example":"Home","minLength":1}}}},"image_url":{"type":"string","description":"The URL of an image of the location","minLength":1,"example":"https://my-image-cdn.com/path/to/my/store/image.png"},"address":{"type":"object","description":"Represents the address of a location","required":["address","zip_code","country_name"],"properties":{"address":{"type":"string","description":"The address line of the location. Typically the street, number, etc.","example":"Lisbon","minLength":1},"zip_code":{"type":"string","description":"The zip-code of the location","example":"20000000","minLength":1},"city":{"type":"string","description":"The city of the location","example":"Lisbon","minLength":1},"region_name":{"type":"string","description":"The region name (country subdivision)","example":"Lisbon","minLength":1},"country_name":{"type":"string","description":"The country name","example":"Portugal","minLength":1},"coordinates":{"type":"object","required":["latitude","longitude"],"properties":{"latitude":{"type":"number","format":"double","minimum":-90,"maximum":90,"example":38.736946},"longitude":{"type":"number","format":"double","minimum":-180,"maximum":180,"example":-9.142685}}}}},"opening_status":{"type":"string","description":"The status of the location, if it is opened or closed","minLength":1,"enum":["OPEN","CLOSED"],"example":"OPEN"},"services":{"type":"array","description":"The list of services","items":{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","description":"The id of service","minLength":1,"maxLength":9999,"example":"d06b0425-c9eb-d8a3-a7c0-ce14d96a651f"},"name":{"type":"string","description":"The name of service","minLength":1,"maxLength":9999,"example":"name"}}}}}}]},{"allOf":[{"type":"object","required":["name","time_zone","address"],"properties":{"name":{"type":"string","description":"The name of the location","minLength":1,"example":"Store Avenida da Liberdade"},"alternative_names":{"type":"array","description":"The alternative names of the location","example":["Liberdade Store","Lisboa Flagship"],"items":{"type":"string","description":"The alternative name (e.g., Liberdade Store, Lisboa Flagship)","minLength":1,"maxLength":9999,"example":"Liberdade Store"}},"external_id":{"type":"string","description":"The external id of the location","minLength":1,"example":123},"type":{"type":"string","description":"The type of the location","minLength":1,"example":"Store"},"time_zone":{"type":"string","description":"The time zone of the location, according to IANA.","minLength":1,"example":"Europe/Lisbon"},"phone_numbers":{"type":"array","items":{"type":"object","description":"Represents the phone numbers of a location","required":["phone_number"],"properties":{"phone_number":{"type":"string","description":"The phone number of one person.","example":"+351123456789","minLength":1},"name":{"type":"string","description":"The phone number name","example":"Home","minLength":1}}}},"image_url":{"type":"string","description":"The URL of an image of the location","minLength":1,"example":"https://my-image-cdn.com/path/to/my/store/image.png"},"address":{"type":"object","description":"Represents the address of a location","required":["address","zip_code","country_name"],"properties":{"address":{"type":"string","description":"The address line of the location. Typically the street, number, etc.","example":"Lisbon","minLength":1},"zip_code":{"type":"string","description":"The zip-code of the location","example":"20000000","minLength":1},"city":{"type":"string","description":"The city of the location","example":"Lisbon","minLength":1},"region_name":{"type":"string","description":"The region name (country subdivision)","example":"Lisbon","minLength":1},"country_name":{"type":"string","description":"The country name","example":"Portugal","minLength":1},"coordinates":{"type":"object","required":["latitude","longitude"],"properties":{"latitude":{"type":"number","format":"double","minimum":-90,"maximum":90,"example":38.736946},"longitude":{"type":"number","format":"double","minimum":-180,"maximum":180,"example":-9.142685}}}}},"opening_status":{"type":"string","description":"The status of the location, if it is opened or closed","minLength":1,"enum":["OPEN","CLOSED"],"example":"OPEN"},"services":{"type":"array","description":"The list of services","items":{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","description":"The id of service","minLength":1,"maxLength":9999,"example":"d06b0425-c9eb-d8a3-a7c0-ce14d96a651f"},"name":{"type":"string","description":"The name of service","minLength":1,"maxLength":9999,"example":"name"}}}}}},{"type":"object","properties":{"open_hours":{"type":"array","items":{"type":"object","required":["day_of_week","slots"],"properties":{"day_of_week":{"type":"string","description":"The day of the week to which the open hours refer to","minLength":1,"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"example":"TUESDAY"},"slots":{"type":"array","items":{"type":"object","required":["open_at","close_at"],"properties":{"open_at":{"type":"string","description":"The hour at which the location opens, in the location's time zone. Formatted according to the ISO-8601 standard.","minLength":1,"pattern":"^\\d\\d\\:\\d\\d\\:\\d\\d$","example":"09:00:00"},"close_at":{"type":"string","description":"The hour at which the location closes, in the location's time zone. Formatted according to the ISO-8601 standard.","minLength":1,"pattern":"^\\d\\d\\:\\d\\d\\:\\d\\d$","example":"18:00:00"}}}}}}},"special_dates":{"type":"array","items":{"type":"object","required":["name","date","repeats"],"properties":{"name":{"type":"string","description":"short name of the special date.","example":"Labor Day","minLength":1},"date":{"type":"string","description":"iso local date where the special should considered. Defined by RFC 3339, section 5.6.","format":"date","example":"1889-05-01","minLength":1},"repeats":{"type":"string","description":"recurrence of the special date.","minLength":1,"enum":["DOES_NOT_REPEATS","MONTHLY","YEARLY"],"example":"YEARLY"},"notes":{"type":"string","description":"special date notes.","example":"1st of may, Workers day"},"slots":{"type":"array","items":{"type":"object","required":["open_at","close_at"],"properties":{"open_at":{"type":"string","description":"The hour at which the location opens, in the location's time zone. Formatted according to the ISO-8601 standard.","minLength":1,"pattern":"^\\d\\d\\:\\d\\d\\:\\d\\d$","example":"09:00:00"},"close_at":{"type":"string","description":"The hour at which the location closes, in the location's time zone. Formatted according to the ISO-8601 standard.","minLength":1,"pattern":"^\\d\\d\\:\\d\\d\\:\\d\\d$","example":"18:00:00"}}}}}}}}}]}]},{"type":"object","required":["_links"],"properties":{"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string","format":"uri","example":"http://api-docs.talkdesk.org/locations-directory/locations/d08d05cc-ac7a-11ed-afa1-0242ac120002"}}}}}}}]},"example":{"id":"d08d05cc-ac7a-11ed-afa1-0242ac120002","name":"Store Avenida da Liberdade","alternative_names":["Liberdade Store","Lisboa Flagship"],"type":"Store","external_id":123,"image_url":"https://my-image-cdn.com/path/to/my/avenida-da-liberdade-store/image.png","address":{"address":"Avenida da Liberdade, 10","zip_code":"1250-142","city":"Lisbon","region_name":"Lisbon","country_name":"Portugal","coordinates":{"latitude":38.736946,"longitude":-9.142685}},"phone_numbers":[{"phone_number":"+351123456789","name":"Home"},{"phone_number":"+351123456780","name":"Personal"}],"time_zone":"Europe/Lisbon","open_hours":[{"day_of_week":"SUNDAY","slots":[]},{"day_of_week":"MONDAY","slots":[{"open_at":"09:00:00","close_at":"12:00:00"},{"open_at":"14:00:00","close_at":"18:00:00"}]},{"day_of_week":"TUESDAY","slots":[{"open_at":"09:00:00","close_at":"12:00:00"},{"open_at":"14:00:00","close_at":"18:00:00"}]},{"day_of_week":"WEDNESDAY","slots":[{"open_at":"09:00:00","close_at":"12:00:00"},{"open_at":"14:00:00","close_at":"18:00:00"}]},{"day_of_week":"THURSDAY","slots":[{"open_at":"09:00:00","close_at":"12:00:00"},{"open_at":"14:00:00","close_at":"18:00:00"}]},{"day_of_week":"FRIDAY","slots":[{"open_at":"09:00:00","close_at":"12:00:00"},{"open_at":"14:00:00","close_at":"18:00:00"}]},{"day_of_week":"SATURDAY","slots":[{"open_at":"09:00:00","close_at":"13:00:00"}]}],"special_dates":[{"name":"1 de may","date":"1981-05-01","repeats":"YEARLY","notes":"note of 1 of may","slots":[{"open_at":"09:00:00","close_at":"23:59:00"}]}],"_links":{"self":{"href":"http://api-docs.talkdesk.org/locations-directory/locations/d08d05cc-ac7a-11ed-afa1-0242ac120002"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"4034000","message":"Bad request."}}}},"404":{"description":"Location not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"4034041","message":"Location {location_id} not found"}}}}}}},"/locations-directory/locations/{location_id}/next-week-opening-hours":{"get":{"operationId":"getLocationNextWeekOpeningHours","tags":["Locations Directory"],"description":"Get a location next week opening hours","security":[{"GA":["locations-directory:read"]}],"parameters":[{"name":"location_id","in":"path","required":true,"schema":{"type":"string","minLength":1,"example":"12345"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","example":1,"minimum":1,"maximum":1,"default":1}},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","example":7,"minimum":7,"maximum":7,"default":7}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","description":"Represents a paginated opening-hours for the next 7 days including today.","required":["_embedded","_links"],"properties":{"_embedded":{"type":"object","required":["opening_hours"],"properties":{"opening_hours":{"type":"array","description":"The List of the opening hours for the next 7 days order by date.","items":{"allOf":[{"type":"object","description":"Represents the opening hours of a given date.","required":["id","date"],"properties":{"id":{"type":"integer","description":"The value of the day of week for a special date","minLength":1,"example":1},"date":{"type":"string","format":"date","description":"The ISO-formatted date to which the open hours refer to.","minLength":1,"example":"2023-05-01"},"special_date_name":{"type":"string","description":"Name of the special date, if it is defined.","example":"International Workers' Day","minLength":1}}},{"type":"object","required":["day_of_week","slots"],"properties":{"day_of_week":{"type":"string","description":"The day of the week to which the open hours refer to","minLength":1,"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"example":"TUESDAY"},"slots":{"type":"array","items":{"type":"object","required":["open_at","close_at"],"properties":{"open_at":{"type":"string","description":"The hour at which the location opens, in the location's time zone. Formatted according to the ISO-8601 standard.","minLength":1,"pattern":"^\\d\\d\\:\\d\\d\\:\\d\\d$","example":"09:00:00"},"close_at":{"type":"string","description":"The hour at which the location closes, in the location's time zone. Formatted according to the ISO-8601 standard.","minLength":1,"pattern":"^\\d\\d\\:\\d\\d\\:\\d\\d$","example":"18:00:00"}}}}}}]}}}},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string","format":"uri","example":"https://api-docs.talkdesk.org"}}}}}}},"example":{"_embedded":{"opening_hours":[{"id":1,"date":"2023-05-01","day_of_week":"MONDAY","special_date_name":"International Workers' Day","slots":[{"open_at":"09:00:00","close_at":"11:00:00"},{"open_at":"20:00:00","close_at":"23:00:00"}]},{"id":2,"date":"2023-05-02","day_of_week":"TUESDAY","slots":[{"open_at":"09:00:00","close_at":"23:00:00"}]},{"id":3,"date":"2023-05-03","day_of_week":"WEDNESDAY","slots":[{"open_at":"09:00:00","close_at":"23:00:00"}]},{"id":4,"date":"2023-05-04","day_of_week":"THURSDAY","slots":[{"open_at":"09:00:00","close_at":"23:00:00"}]},{"id":5,"date":"2023-05-05","day_of_week":"FRIDAY","slots":[{"open_at":"09:00:00","close_at":"23:00:00"}]},{"id":6,"date":"2023-05-06","day_of_week":"SATURDAY","slots":[{"open_at":"09:00:00","close_at":"12:00:00"}]},{"id":7,"date":"2023-05-07","day_of_week":"SUNDAY","slots":[{"open_at":"13:00:00","close_at":"18:00:00"}]}]},"_links":{"self":{"href":"https://api-docs.talkdesk.org"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"4034000","message":"Bad request."}}}},"404":{"description":"Location not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"4034041","message":"Location {location_id} not found"}}}}}}},"/locations-directory/services":{"get":{"operationId":"getServices","tags":["Locations Directory"],"description":"Get the paginated list of services","security":[{"GA":["locations-directory:read"]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","example":1,"minimum":1,"default":1}},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","example":5,"minimum":1,"maximum":50,"default":50}},{"name":"service_name","in":"query","required":false,"schema":{"type":"string","example":"Shopping","description":"The name of the service","default":"","minLength":0,"maxLength":150}},{"name":"service_type","in":"query","required":false,"schema":{"type":"string","example":"Store","description":"The type of the service","default":"","minLength":0,"maxLength":150}},{"name":"location_name","in":"query","required":false,"schema":{"type":"string","example":"Store Avenida da Liberdade","description":"The name of the location","default":"","minLength":0,"maxLength":150}},{"name":"location_type","in":"query","required":false,"schema":{"type":"string","example":"Store","description":"The type of the location","default":"","minLength":0,"maxLength":150}},{"name":"zip_code","in":"query","required":false,"schema":{"type":"string","example":"1250-142","description":"The zip-code of the location which can provide the service","default":"","minLength":0,"maxLength":20}},{"name":"city","in":"query","required":false,"schema":{"type":"string","example":"Lisbon","description":"The city of the location which can provide the service","default":"","minLength":0,"maxLength":100}},{"name":"country_name","in":"query","required":false,"schema":{"type":"string","example":"Portugal","description":"The country name of location which can provide the service","default":"","minLength":0,"maxLength":100}},{"name":"region_name","in":"query","required":false,"schema":{"type":"string","example":"Lisbon","description":"The region name (country subdivision) of location which can provide the service","default":"","minLength":0,"maxLength":100}},{"name":"location_id","in":"query","required":false,"schema":{"type":"string","example":"id","description":"The id of the location","default":"","minLength":0,"maxLength":150}},{"name":"staff_id","in":"query","required":false,"schema":{"type":"string","example":"id","description":"The id of the staff","default":"","minLength":0,"maxLength":150}},{"name":"staff_name","in":"query","required":false,"schema":{"type":"string","example":"staff name","description":"The name of the staff who can provide the service","default":"","minLength":0,"maxLength":9999}},{"name":"staff_specialty","in":"query","required":false,"schema":{"type":"string","example":"staff specialty","description":"The specialty of the staff who can provide the service","default":"","minLength":0,"maxLength":9999}},{"name":"staff_visit_type","in":"query","required":false,"schema":{"type":"string","example":"type name","description":"The visit type name of the staff who can provide the service","default":"","minLength":0,"maxLength":9999}},{"name":"latitude","in":"query","required":false,"schema":{"type":"number","format":"double","example":38.698943,"description":"
    • Latitude and longitude are used together with distance. The search parameters include latitude and longitude to retrieve a list of all services within a certain radius.
    • Currently, these three parameters can only be used when the Feature Flag is enabled.
    ","minimum":-90,"maximum":90}},{"name":"longitude","in":"query","required":false,"schema":{"type":"number","format":"double","example":-9.18423,"description":"
    • Latitude and longitude are used together with distance. The search parameters include latitude and longitude to retrieve a list of all services within a certain radius.
    • Currently, these three parameters can only be used when the Feature Flag is enabled.
    ","default":"","minimum":-180,"maximum":180}},{"name":"distance","in":"query","required":false,"schema":{"type":"number","format":"double","example":10000,"description":"
    • Latitude and longitude are used together with distance. The search parameters include latitude and longitude to retrieve a list of all services within a certain radius.
    • Distance is measured in meters.
    • If no distance is provided, the default distance configured in Industries-settings will be used.
    • Currently, these three parameters can only be used when the Feature Flag is enabled.
    ","minimum":0}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","example":5,"description":"The return locations count for per service","minimum":1,"maximum":2147483647,"default":15}}],"responses":{"200":{"description":"The paginated list of services","content":{"application/json":{"schema":{"type":"object","description":"Represents a paginated list of services","required":["count","total","total_pages","page","per_page","_embedded","_links"],"properties":{"count":{"type":"integer","format":"int32","description":"The number of results in the current page","example":40},"total":{"type":"integer","format":"int32","description":"The total of results","example":90},"page":{"type":"integer","format":"int32","description":"The current page","example":2},"per_page":{"type":"integer","format":"int32","description":"The number of results per page","example":50},"total_pages":{"type":"integer","format":"int32","description":"The total number of result pages","example":2},"_embedded":{"type":"object","required":["services"],"properties":{"services":{"type":"array","description":"The list of services in the current page","items":{"type":"object","required":["id","service_name","description"],"properties":{"id":{"type":"string","description":"The id of service","example":"a78d05cc-ac7a-11ed-afa1-0242ac120012"},"service_name":{"type":"string","description":"The name of service","example":"Shopping"},"external_id":{"type":"string","description":"The external id of the service","minLength":1,"example":123},"service_type":{"type":"string","description":"The type of service","example":"Online"},"duration":{"type":"string","description":"The duration of service","example":"30-45 minutes"},"description":{"type":"string","description":"The note content","example":"Shopping on Internet is amusing"},"virtual_location_url":{"type":"string","description":"The note content","example":"https://www.talkdesk.com/customers/"},"price":{"type":"string","description":"The price of service","example":"3$"},"open_hours":{"type":"array","items":{"type":"object","required":["day_of_week","slots"],"properties":{"day_of_week":{"type":"string","description":"The day of the week to which the open hours refer to","minLength":1,"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"example":"TUESDAY"},"slots":{"type":"array","items":{"type":"object","required":["open_at","close_at"],"properties":{"open_at":{"type":"string","description":"The hour at which the location opens, in the location's time zone. Formatted according to the ISO-8601 standard.","minLength":1,"pattern":"^\\d\\d\\:\\d\\d\\:\\d\\d$","example":"09:00:00"},"close_at":{"type":"string","description":"The hour at which the location closes, in the location's time zone. Formatted according to the ISO-8601 standard.","minLength":1,"pattern":"^\\d\\d\\:\\d\\d\\:\\d\\d$","example":"18:00:00"}}}}}}},"special_dates":{"type":"array","items":{"type":"object","required":["name","date","repeats"],"properties":{"name":{"type":"string","description":"short name of the special date.","example":"Labor Day","minLength":1},"date":{"type":"string","description":"iso local date where the special should considered. Defined by RFC 3339, section 5.6.","format":"date","example":"1889-05-01","minLength":1},"repeats":{"type":"string","description":"recurrence of the special date.","minLength":1,"enum":["DOES_NOT_REPEATS","MONTHLY","YEARLY"],"example":"YEARLY"},"notes":{"type":"string","description":"special date notes.","example":"1st of may, Workers day"},"slots":{"type":"array","items":{"type":"object","required":["open_at","close_at"],"properties":{"open_at":{"type":"string","description":"The hour at which the location opens, in the location's time zone. Formatted according to the ISO-8601 standard.","minLength":1,"pattern":"^\\d\\d\\:\\d\\d\\:\\d\\d$","example":"09:00:00"},"close_at":{"type":"string","description":"The hour at which the location closes, in the location's time zone. Formatted according to the ISO-8601 standard.","minLength":1,"pattern":"^\\d\\d\\:\\d\\d\\:\\d\\d$","example":"18:00:00"}}}}}}},"time_zone":{"type":"string","description":"The time zone of the service, according to IANA.","minLength":1,"example":"Europe/Lisbon"},"phone_numbers":{"type":"array","items":{"type":"object","description":"Represents the phone numbers of a location","required":["phone_number"],"properties":{"phone_number":{"type":"string","description":"The phone number of one person.","example":"+351123456789","minLength":1},"name":{"type":"string","description":"The phone number name","example":"Home","minLength":1}}}},"locations":{"description":"The location list of the service","items":{"type":"object","required":["id","location_name"],"properties":{"id":{"type":"string","example":"000000000000000000000001"},"location_name":{"type":"string","example":"location name"}}}},"created_at":{"type":"string","example":"2024-06-10T10:00:00Z"},"updated_at":{"type":"string","example":"2024-06-10T10:00:00Z"}}}}}},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string","format":"uri","example":"http://api-docs.talkdesk.org/locations-directory/services?page=1&per_page=10"}}},"next":{"type":"object","required":["href"],"properties":{"href":{"type":"string","format":"uri","example":"http://api-docs.talkdesk.org/locations-directory/services?page=2&per_page=10"}}}}}}},"example":{"_embedded":{"services":[{"id":"a78d05cc-ac7a-11ed-afa1-0242ac120012","service_name":"Shopping","service_type":"Online","duration":"30-45 minutes","external_id":"1","description":"Shopping on Internet is amusing","virtual_location_url":"https://www.talkdesk.com/customers/","locations":[{"id":"000000000000000000000001","location_name":"Store Avenida da Liberdade"},{"id":"000000000000000000000002","location_name":"Store Avenida dos Aliados"}],"price":"3$","phone_numbers":[{"phone_number":"+351123456789","name":"Home"},{"phone_number":"+351123456780","name":"Personal"}],"time_zone":"Europe/Lisbon","open_hours":[{"day_of_week":"SUNDAY","slots":[]},{"day_of_week":"MONDAY","slots":[{"open_at":"09:00:00","close_at":"12:00:00"},{"open_at":"14:00:00","close_at":"18:00:00"}]},{"day_of_week":"TUESDAY","slots":[{"open_at":"09:00:00","close_at":"12:00:00"},{"open_at":"14:00:00","close_at":"18:00:00"}]},{"day_of_week":"WEDNESDAY","slots":[{"open_at":"09:00:00","close_at":"12:00:00"},{"open_at":"14:00:00","close_at":"18:00:00"}]},{"day_of_week":"THURSDAY","slots":[{"open_at":"09:00:00","close_at":"12:00:00"},{"open_at":"14:00:00","close_at":"18:00:00"}]},{"day_of_week":"FRIDAY","slots":[{"open_at":"09:00:00","close_at":"12:00:00"},{"open_at":"14:00:00","close_at":"18:00:00"}]},{"day_of_week":"SATURDAY","slots":[{"open_at":"09:00:00","close_at":"13:00:00"}]}],"special_dates":[{"name":"1 de may","date":"1981-05-01","repeats":"YEARLY","notes":"note of 1 of may","slots":[{"open_at":"09:00:00","close_at":"23:59:00"}]}],"created_at":"2024-06-10T10:00:00.000Z","updated_at":"2024-06-10T10:00:00.000Z"},{"id":"b98d05cc-ac7a-11ed-afa1-0242ac120025","service_name":"Shopping","service_type":"Offline","external_id":"2","duration":"30-60 minutes","description":"Shopping on Internet is amusing","virtual_location_url":"https://www.talkdesk.com/customers/","locations":[{"id":"000000000000000000000001","location_name":"Store Avenida da Liberdade"},{"id":"000000000000000000000002","location_name":"Store Avenida dos Aliados"}],"price":"3$","phone_numbers":[{"phone_number":"+351123456789","name":"Home"},{"phone_number":"+351123456780","name":"Personal"}],"time_zone":"Europe/Lisbon","open_hours":[{"day_of_week":"SUNDAY","slots":[]},{"day_of_week":"MONDAY","slots":[{"open_at":"09:00:00","close_at":"12:00:00"},{"open_at":"14:00:00","close_at":"18:00:00"}]},{"day_of_week":"TUESDAY","slots":[{"open_at":"09:00:00","close_at":"12:00:00"},{"open_at":"14:00:00","close_at":"18:00:00"}]},{"day_of_week":"WEDNESDAY","slots":[{"open_at":"09:00:00","close_at":"12:00:00"},{"open_at":"14:00:00","close_at":"18:00:00"}]},{"day_of_week":"THURSDAY","slots":[{"open_at":"09:00:00","close_at":"12:00:00"},{"open_at":"14:00:00","close_at":"18:00:00"}]},{"day_of_week":"FRIDAY","slots":[{"open_at":"09:00:00","close_at":"12:00:00"},{"open_at":"14:00:00","close_at":"18:00:00"}]},{"day_of_week":"SATURDAY","slots":[{"open_at":"09:00:00","close_at":"13:00:00"}]}],"special_dates":[{"name":"1 de may","date":"1981-05-01","repeats":"YEARLY","notes":"note of 1 of may","slots":[{"open_at":"09:00:00","close_at":"23:59:00"}]}],"created_at":"2024-06-10T10:00:00.000Z","updated_at":"2024-06-10T10:00:00.000Z"}]},"_links":{"self":{"href":"http://api-docs.talkdesk.org/locations-directory/services?page=1&per_page=2"},"next":{"href":"http://api-docs.talkdesk.org/locations-directory/services?page=2&per_page=2"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"4034000","message":"Bad request."}}}}}}},"/locations-directory/services-agent":{"get":{"operationId":"getServicesAgent","tags":["Locations Directory"],"description":"Get the paginated list of services for agent view","security":[{"GA":["locations-directory:read"]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","example":1,"minimum":1,"default":1}},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","example":5,"minimum":1,"maximum":50,"default":50}},{"name":"service_name","in":"query","required":false,"schema":{"type":"string","example":"Shopping","description":"The name of the service","default":"","minLength":0,"maxLength":150}},{"name":"service_types","in":"query","required":false,"schema":{"type":"string","example":"Store","description":"The list of service types, multiple values should split by ',' , like type1,type2","default":"","minLength":1}},{"name":"service_durations","in":"query","required":false,"example":"service duration","description":"The list of service durations, multiple values should split by ',' , like duration1,duration2","schema":{"type":"string","default":"","minLength":1}},{"name":"specialities","in":"query","required":false,"description":"The list of staff speciality, multiple values should split by ',' , like speciality1,speciality2","schema":{"type":"string","minLength":1,"example":"IT support"}},{"name":"service_names","in":"query","required":false,"schema":{"type":"string","example":"serviceName","description":"The name list of the service, multiple values should split by ',' , like serviceName1,serviceName2","minLength":1}},{"name":"service_ids","in":"query","required":false,"schema":{"type":"string","example":"serviceId","description":"The id list of the service, multiple values should split by ',' , like serviceId1,serviceId2","minLength":1}},{"name":"languages","in":"query","required":false,"description":"The list of staff language, multiple values should split by ',' , like English,Chinese","schema":{"type":"string","minLength":1,"example":"English"}},{"name":"genders","in":"query","required":false,"schema":{"type":"string","example":"Female","description":"The list of staff genders, multiple values should split by ',' , like Male,Female","default":"","minLength":1}},{"name":"location_id","in":"query","required":true,"schema":{"type":"string","example":"id","description":"The id of the location","default":"","minLength":0,"maxLength":150}},{"name":"visit_type","in":"query","required":false,"schema":{"type":"string","example":"type name","description":"The visit type name of the staff who can provide the service","default":"","minLength":0,"maxLength":9999}},{"name":"tag_values","in":"query","required":false,"schema":{"type":"string","example":"tag","description":"The list of tag values, multiple values should split by ',' , like tag1,tag2","default":"","minLength":1}}],"responses":{"200":{"description":"The paginated list of services","content":{"application/json":{"schema":{"type":"object","description":"Represents a paginated list of services","required":["count","total","total_pages","page","per_page","_embedded","_links"],"properties":{"count":{"type":"integer","format":"int32","description":"The number of results in the current page","example":40},"total":{"type":"integer","format":"int32","description":"The total of results","example":90},"page":{"type":"integer","format":"int32","description":"The current page","example":2},"per_page":{"type":"integer","format":"int32","description":"The number of results per page","example":50},"total_pages":{"type":"integer","format":"int32","description":"The total number of result pages","example":2},"_embedded":{"type":"object","required":["services"],"properties":{"services":{"type":"array","description":"The list of services in the current page","items":{"type":"object","required":["id","service_name","description"],"properties":{"id":{"type":"string","description":"The id of service","example":"a78d05cc-ac7a-11ed-afa1-0242ac120012"},"external_id":{"type":"string","description":"The external id of the service","minLength":1,"example":123},"service_name":{"type":"string","description":"The name of service","example":"Shopping"},"service_type":{"type":"string","description":"The type of service","example":"Online"},"duration":{"type":"string","description":"The duration of service","example":"30-45 minutes"},"description":{"type":"string","description":"The note content","example":"Shopping on Internet is amusing"},"virtual_location_url":{"type":"string","description":"The note content","example":"https://www.talkdesk.com/customers/"},"price":{"type":"string","description":"The price of service","example":"3$"},"open_hours":{"type":"array","items":{"type":"object","required":["day_of_week","slots"],"properties":{"day_of_week":{"type":"string","description":"The day of the week to which the open hours refer to","minLength":1,"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"example":"TUESDAY"},"slots":{"type":"array","items":{"type":"object","required":["open_at","close_at"],"properties":{"open_at":{"type":"string","description":"The hour at which the location opens, in the location's time zone. Formatted according to the ISO-8601 standard.","minLength":1,"pattern":"^\\d\\d\\:\\d\\d\\:\\d\\d$","example":"09:00:00"},"close_at":{"type":"string","description":"The hour at which the location closes, in the location's time zone. Formatted according to the ISO-8601 standard.","minLength":1,"pattern":"^\\d\\d\\:\\d\\d\\:\\d\\d$","example":"18:00:00"}}}}}}},"special_dates":{"type":"array","items":{"type":"object","required":["name","date","repeats"],"properties":{"name":{"type":"string","description":"short name of the special date.","example":"Labor Day","minLength":1},"date":{"type":"string","description":"iso local date where the special should considered. Defined by RFC 3339, section 5.6.","format":"date","example":"1889-05-01","minLength":1},"repeats":{"type":"string","description":"recurrence of the special date.","minLength":1,"enum":["DOES_NOT_REPEATS","MONTHLY","YEARLY"],"example":"YEARLY"},"notes":{"type":"string","description":"special date notes.","example":"1st of may, Workers day"},"slots":{"type":"array","items":{"type":"object","required":["open_at","close_at"],"properties":{"open_at":{"type":"string","description":"The hour at which the location opens, in the location's time zone. Formatted according to the ISO-8601 standard.","minLength":1,"pattern":"^\\d\\d\\:\\d\\d\\:\\d\\d$","example":"09:00:00"},"close_at":{"type":"string","description":"The hour at which the location closes, in the location's time zone. Formatted according to the ISO-8601 standard.","minLength":1,"pattern":"^\\d\\d\\:\\d\\d\\:\\d\\d$","example":"18:00:00"}}}}}}},"time_zone":{"type":"string","description":"The time zone of the service, according to IANA.","minLength":1,"example":"Europe/Lisbon"},"phone_numbers":{"type":"array","items":{"type":"object","description":"Represents the phone numbers of a location","required":["phone_number"],"properties":{"phone_number":{"type":"string","description":"The phone number of one person.","example":"+351123456789","minLength":1},"name":{"type":"string","description":"The phone number name","example":"Home","minLength":1}}}},"locations":{"description":"The location list of the service","items":{"type":"object","required":["id","location_name"],"properties":{"id":{"type":"string","example":"000000000000000000000001"},"location_name":{"type":"string","example":"location name"}}}},"created_at":{"type":"string","example":"2024-06-10T10:00:00Z"},"updated_at":{"type":"string","example":"2024-06-10T10:00:00Z"}}}}}},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string","format":"uri","example":"http://api-docs.talkdesk.org/locations-directory/services-agent?page=1&per_page=10"}}},"next":{"type":"object","required":["href"],"properties":{"href":{"type":"string","format":"uri","example":"http://api-docs.talkdesk.org/locations-directory/services-agent?page=2&per_page=10"}}}}}}},"example":{"_embedded":{"services":[{"id":"a78d05cc-ac7a-11ed-afa1-0242ac120012","service_name":"Shopping","service_type":"Online","external_id":"1","duration":"30-45 minutes","description":"Shopping on Internet is amusing","virtual_location_url":"https://www.talkdesk.com/customers/","locations":[{"id":"000000000000000000000001","location_name":"Store Avenida da Liberdade"},{"id":"000000000000000000000002","location_name":"Store Avenida dos Aliados"}],"price":"3$","phone_numbers":[{"phone_number":"+351123456789","name":"Home"},{"phone_number":"+351123456780","name":"Personal"}],"time_zone":"Europe/Lisbon","open_hours":[{"day_of_week":"SUNDAY","slots":[]},{"day_of_week":"MONDAY","slots":[{"open_at":"09:00:00","close_at":"12:00:00"},{"open_at":"14:00:00","close_at":"18:00:00"}]},{"day_of_week":"TUESDAY","slots":[{"open_at":"09:00:00","close_at":"12:00:00"},{"open_at":"14:00:00","close_at":"18:00:00"}]},{"day_of_week":"WEDNESDAY","slots":[{"open_at":"09:00:00","close_at":"12:00:00"},{"open_at":"14:00:00","close_at":"18:00:00"}]},{"day_of_week":"THURSDAY","slots":[{"open_at":"09:00:00","close_at":"12:00:00"},{"open_at":"14:00:00","close_at":"18:00:00"}]},{"day_of_week":"FRIDAY","slots":[{"open_at":"09:00:00","close_at":"12:00:00"},{"open_at":"14:00:00","close_at":"18:00:00"}]},{"day_of_week":"SATURDAY","slots":[{"open_at":"09:00:00","close_at":"13:00:00"}]}],"special_dates":[{"name":"1 de may","date":"1981-05-01","repeats":"YEARLY","notes":"note of 1 of may","slots":[{"open_at":"09:00:00","close_at":"23:59:00"}]}],"created_at":"2024-06-10T10:00:00.000Z","updated_at":"2024-06-10T10:00:00.000Z"},{"id":"b98d05cc-ac7a-11ed-afa1-0242ac120025","service_name":"Shopping","service_type":"Offline","external_id":"2","duration":"30-60 minutes","description":"Shopping on Internet is amusing","virtual_location_url":"https://www.talkdesk.com/customers/","locations":[{"id":"000000000000000000000001","location_name":"Store Avenida da Liberdade"},{"id":"000000000000000000000002","location_name":"Store Avenida dos Aliados"}],"price":"3$","phone_numbers":[{"phone_number":"+351123456789","name":"Home"},{"phone_number":"+351123456780","name":"Personal"}],"time_zone":"Europe/Lisbon","open_hours":[{"day_of_week":"SUNDAY","slots":[]},{"day_of_week":"MONDAY","slots":[{"open_at":"09:00:00","close_at":"12:00:00"},{"open_at":"14:00:00","close_at":"18:00:00"}]},{"day_of_week":"TUESDAY","slots":[{"open_at":"09:00:00","close_at":"12:00:00"},{"open_at":"14:00:00","close_at":"18:00:00"}]},{"day_of_week":"WEDNESDAY","slots":[{"open_at":"09:00:00","close_at":"12:00:00"},{"open_at":"14:00:00","close_at":"18:00:00"}]},{"day_of_week":"THURSDAY","slots":[{"open_at":"09:00:00","close_at":"12:00:00"},{"open_at":"14:00:00","close_at":"18:00:00"}]},{"day_of_week":"FRIDAY","slots":[{"open_at":"09:00:00","close_at":"12:00:00"},{"open_at":"14:00:00","close_at":"18:00:00"}]},{"day_of_week":"SATURDAY","slots":[{"open_at":"09:00:00","close_at":"13:00:00"}]}],"special_dates":[{"name":"1 de may","date":"1981-05-01","repeats":"YEARLY","notes":"note of 1 of may","slots":[{"open_at":"09:00:00","close_at":"23:59:00"}]}],"created_at":"2024-06-10T10:00:00.000Z","updated_at":"2024-06-10T10:00:00.000Z"}]},"_links":{"self":{"href":"http://api-docs.talkdesk.org/locations-directory/services-agent?page=1&per_page=2"},"next":{"href":"http://api-docs.talkdesk.org/locations-directory/services-agent?page=2&per_page=2"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"4034000","message":"Bad request."}}}}}}},"/locations-directory/services/services-locations":{"get":{"operationId":"getServiceLocations","tags":["Locations Directory"],"description":"Get the paginated list of services","security":[{"GA":["locations-directory:read"]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","example":1,"minimum":1,"default":1}},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","example":5,"minimum":1,"maximum":50,"default":50}},{"name":"service_name","in":"query","required":false,"schema":{"type":"string","example":"Shopping","description":"The name of the service","default":"","minLength":0,"maxLength":150}},{"name":"service_type","in":"query","required":false,"schema":{"type":"string","example":"Store","description":"The type of the service","default":"","minLength":0,"maxLength":150}},{"name":"location_name","in":"query","required":false,"schema":{"type":"string","example":"Store Avenida da Liberdade","description":"The name of the location","default":"","minLength":0,"maxLength":150}},{"name":"location_type","in":"query","required":false,"schema":{"type":"string","example":"Store","description":"The type of the location","default":"","minLength":0,"maxLength":150}},{"name":"zip_code","in":"query","required":false,"schema":{"type":"string","example":"1250-142","description":"The zip-code of the location which can provide the service","default":"","minLength":0,"maxLength":20}},{"name":"city","in":"query","required":false,"schema":{"type":"string","example":"Lisbon","description":"The city of the location which can provide the service","default":"","minLength":0,"maxLength":100}},{"name":"country_name","in":"query","required":false,"schema":{"type":"string","example":"Portugal","description":"The country name of location which can provide the service","default":"","minLength":0,"maxLength":100}},{"name":"region_name","in":"query","required":false,"schema":{"type":"string","example":"Lisbon","description":"The region name (country subdivision) of location which can provide the service","default":"","minLength":0,"maxLength":100}},{"name":"location_id","in":"query","required":false,"schema":{"type":"string","example":"id","description":"The id of the location","default":"","minLength":0,"maxLength":150}},{"name":"staff_id","in":"query","required":false,"schema":{"type":"string","example":"id","description":"The id of the staff","default":"","minLength":0,"maxLength":150}},{"name":"staff_name","in":"query","required":false,"schema":{"type":"string","example":"staff name","description":"The name of the staff who can provide the service","default":"","minLength":0,"maxLength":9999}},{"name":"staff_specialty","in":"query","required":false,"schema":{"type":"string","example":"staff specialty","description":"The specialty of the staff who can provide the service","default":"","minLength":0,"maxLength":9999}},{"name":"staff_visit_type","in":"query","required":false,"schema":{"type":"string","example":"type name","description":"The visit type name of the staff who can provide the service","default":"","minLength":0,"maxLength":9999}},{"name":"latitude","in":"query","required":false,"schema":{"type":"number","format":"double","example":38.698943,"description":"
    • Latitude and longitude are used together with distance. The search parameters include latitude and longitude to retrieve a list of all services within a certain radius.
    • Currently, these three parameters can only be used when the Feature Flag is enabled.
    ","minimum":-90,"maximum":90}},{"name":"longitude","in":"query","required":false,"schema":{"type":"number","format":"double","example":-9.18423,"description":"
    • Latitude and longitude are used together with distance. The search parameters include latitude and longitude to retrieve a list of all services within a certain radius.
    • Currently, these three parameters can only be used when the Feature Flag is enabled.
    ","default":"","minimum":-180,"maximum":180}},{"name":"distance","in":"query","required":false,"schema":{"type":"number","format":"double","example":10000,"description":"
    • Latitude and longitude are used together with distance. The search parameters include latitude and longitude to retrieve a list of all services within a certain radius.
    • Distance is measured in meters.
    • If no distance is provided, the default distance configured in Industries-settings will be used.
    • Currently, these three parameters can only be used when the Feature Flag is enabled.
    ","minimum":0}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","example":5,"description":"The return locations count for per service","minimum":1,"maximum":2147483647,"default":15}}],"responses":{"200":{"description":"The paginated list of services","content":{"application/json":{"schema":{"type":"object","description":"Represents a paginated list of services","required":["count","total","total_pages","page","per_page","_embedded","_links"],"properties":{"count":{"type":"integer","format":"int32","description":"The number of results in the current page","example":40},"total":{"type":"integer","format":"int32","description":"The total of results","example":90},"page":{"type":"integer","format":"int32","description":"The current page","example":2},"per_page":{"type":"integer","format":"int32","description":"The number of results per page","example":50},"total_pages":{"type":"integer","format":"int32","description":"The total number of result pages","example":2},"_embedded":{"type":"object","required":["services"],"properties":{"services":{"type":"array","description":"The list of services in the current page","items":{"type":"object","required":["id","service_name","description"],"properties":{"id":{"type":"string","description":"The id of service","example":"a78d05cc-ac7a-11ed-afa1-0242ac120012"},"service_name":{"type":"string","description":"The name of service","example":"Shopping"},"service_type":{"type":"string","description":"The type of service","example":"Online"},"duration":{"type":"string","description":"The duration of service","example":"30-45 minutes"},"description":{"type":"string","description":"The note content","example":"Shopping on Internet is amusing"},"virtual_location_url":{"type":"string","description":"The note content","example":"https://www.talkdesk.com/customers/"},"location_id":{"type":"string","description":"The location id","example":"597c54f5-63d8-4f68-82f4-d3a67633300b"},"location_name":{"type":"string","description":"The location name","example":"Canada Place"},"created_at":{"type":"string","example":"2024-06-10T10:00:00Z"},"updated_at":{"type":"string","example":"2024-06-10T10:00:00Z"}}}}}},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string","format":"uri","example":"http://api-docs.talkdesk.org/locations-directory/services/services-locations?page=1&per_page=10"}}},"next":{"type":"object","required":["href"],"properties":{"href":{"type":"string","format":"uri","example":"http://api-docs.talkdesk.org/locations-directory/services/services-locations?page=2&per_page=10"}}}}}}},"example":{"_embedded":{"services":[{"id":"a78d05cc-ac7a-11ed-afa1-0242ac120012","service_name":"Shopping","service_type":"Online","duration":"30-45 minutes","description":"Shopping on Internet is amusing","virtual_location_url":"https://www.talkdesk.com/customers/","location_id":"000000000000000000000002","location_name":"Store Avenida dos Aliados","created_at":"2024-06-10T10:00:00.000Z","updated_at":"2024-06-10T10:00:00.000Z"},{"id":"b98d05cc-ac7a-11ed-afa1-0242ac120025","service_name":"Shopping","service_type":"Offline","duration":"30-60 minutes","description":"Shopping on Internet is amusing","virtual_location_url":"https://www.talkdesk.com/customers/","location_id":"000000000000000000000001","location_name":"Store Avenida da Liberdade","created_at":"2024-06-10T10:00:00.000Z","updated_at":"2024-06-10T10:00:00.000Z"}]},"_links":{"self":{"href":"http://api-docs.talkdesk.org/locations-directory/services/services-locations?page=1&per_page=2"},"next":{"href":"http://api-docs.talkdesk.org/locations-directory/services/services-locations?page=2&per_page=2"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"4034000","message":"Bad request."}}}}}}},"/locations-directory/services/{service_id}":{"get":{"operationId":"getServiceById","tags":["Locations Directory"],"description":"Get a service by id","security":[{"GA":["locations-directory:read"]}],"parameters":[{"name":"service_id","in":"path","required":true,"description":"The service id","schema":{"type":"string","minLength":1,"example":"12345"}}],"responses":{"200":{"description":"The retrieved service","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["id","service_name","description"],"properties":{"id":{"type":"string","description":"The id of service","example":"a78d05cc-ac7a-11ed-afa1-0242ac120012"},"external_id":{"type":"string","description":"The external id of the service","minLength":1,"example":123},"service_name":{"type":"string","description":"The name of service","example":"Shopping"},"service_type":{"type":"string","description":"The type of service","example":"Online"},"duration":{"type":"string","description":"The duration of service","example":"30-45 minutes"},"description":{"type":"string","description":"The note content","example":"Shopping on Internet is amusing"},"virtual_location_url":{"type":"string","description":"The note content","example":"https://www.talkdesk.com/customers/"},"price":{"type":"string","description":"The price of service","example":"3$"},"open_hours":{"type":"array","items":{"type":"object","required":["day_of_week","slots"],"properties":{"day_of_week":{"type":"string","description":"The day of the week to which the open hours refer to","minLength":1,"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"example":"TUESDAY"},"slots":{"type":"array","items":{"type":"object","required":["open_at","close_at"],"properties":{"open_at":{"type":"string","description":"The hour at which the location opens, in the location's time zone. Formatted according to the ISO-8601 standard.","minLength":1,"pattern":"^\\d\\d\\:\\d\\d\\:\\d\\d$","example":"09:00:00"},"close_at":{"type":"string","description":"The hour at which the location closes, in the location's time zone. Formatted according to the ISO-8601 standard.","minLength":1,"pattern":"^\\d\\d\\:\\d\\d\\:\\d\\d$","example":"18:00:00"}}}}}}},"special_dates":{"type":"array","items":{"type":"object","required":["name","date","repeats"],"properties":{"name":{"type":"string","description":"short name of the special date.","example":"Labor Day","minLength":1},"date":{"type":"string","description":"iso local date where the special should considered. Defined by RFC 3339, section 5.6.","format":"date","example":"1889-05-01","minLength":1},"repeats":{"type":"string","description":"recurrence of the special date.","minLength":1,"enum":["DOES_NOT_REPEATS","MONTHLY","YEARLY"],"example":"YEARLY"},"notes":{"type":"string","description":"special date notes.","example":"1st of may, Workers day"},"slots":{"type":"array","items":{"type":"object","required":["open_at","close_at"],"properties":{"open_at":{"type":"string","description":"The hour at which the location opens, in the location's time zone. Formatted according to the ISO-8601 standard.","minLength":1,"pattern":"^\\d\\d\\:\\d\\d\\:\\d\\d$","example":"09:00:00"},"close_at":{"type":"string","description":"The hour at which the location closes, in the location's time zone. Formatted according to the ISO-8601 standard.","minLength":1,"pattern":"^\\d\\d\\:\\d\\d\\:\\d\\d$","example":"18:00:00"}}}}}}},"time_zone":{"type":"string","description":"The time zone of the service, according to IANA.","minLength":1,"example":"Europe/Lisbon"},"phone_numbers":{"type":"array","items":{"type":"object","description":"Represents the phone numbers of a location","required":["phone_number"],"properties":{"phone_number":{"type":"string","description":"The phone number of one person.","example":"+351123456789","minLength":1},"name":{"type":"string","description":"The phone number name","example":"Home","minLength":1}}}},"locations":{"type":"array","description":"The location list of the service","items":{"type":"object","required":["id","location_name"],"properties":{"id":{"type":"string","example":"000000000000000000000001"},"location_name":{"type":"string","example":"location name"}}}},"created_at":{"type":"string","example":"2024-06-10T10:00:00Z"},"updated_at":{"type":"string","example":"2024-06-10T10:00:00Z"}}},{"type":"object","required":["_links"],"properties":{"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string","format":"uri","example":"http://api-docs.talkdesk.org/locations-directory/services/a78d05cc-ac7a-11ed-afa1-0242ac120012"}}}}}}}]},"example":{"id":"a78d05cc-ac7a-11ed-afa1-0242ac120012","service_name":"Shopping","external_id":"1","service_type":"Online","duration":"30-45 minutes","description":"Shopping on Internet is amusing","virtual_location_url":"https://www.talkdesk.com/customers/","locations":[{"id":"000000000000000000000001","location_name":"Store Avenida da Liberdade"},{"id":"000000000000000000000002","location_name":"Store Avenida dos Aliados"}],"price":"3$","phone_numbers":[{"phone_number":"+351123456789","name":"Home"},{"phone_number":"+351123456780","name":"Personal"}],"time_zone":"Europe/Lisbon","open_hours":[{"day_of_week":"SUNDAY","slots":[]},{"day_of_week":"MONDAY","slots":[{"open_at":"09:00:00","close_at":"12:00:00"},{"open_at":"14:00:00","close_at":"18:00:00"}]},{"day_of_week":"TUESDAY","slots":[{"open_at":"09:00:00","close_at":"12:00:00"},{"open_at":"14:00:00","close_at":"18:00:00"}]},{"day_of_week":"WEDNESDAY","slots":[{"open_at":"09:00:00","close_at":"12:00:00"},{"open_at":"14:00:00","close_at":"18:00:00"}]},{"day_of_week":"THURSDAY","slots":[{"open_at":"09:00:00","close_at":"12:00:00"},{"open_at":"14:00:00","close_at":"18:00:00"}]},{"day_of_week":"FRIDAY","slots":[{"open_at":"09:00:00","close_at":"12:00:00"},{"open_at":"14:00:00","close_at":"18:00:00"}]},{"day_of_week":"SATURDAY","slots":[{"open_at":"09:00:00","close_at":"13:00:00"}]}],"special_dates":[{"name":"1 de may","date":"1981-05-01","repeats":"YEARLY","notes":"note of 1 of may","slots":[{"open_at":"09:00:00","close_at":"23:59:00"}]}],"created_at":"2024-06-10T10:00:00.000Z","updated_at":"2024-06-10T10:00:00.000Z","_links":{"self":{"href":"http://api-docs.talkdesk.org/locations-directory/services/a78d05cc-ac7a-11ed-afa1-0242ac120012"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"4034000","message":"Bad request."}}}},"404":{"description":"Service not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"4034041","message":"Service {service_id} not found"}}}}}}},"/locations-directory/services/{service_id}/next-week-opening-hours":{"get":{"operationId":"getServiceNextWeekOpeningHours","tags":["Locations Directory"],"description":"Get a service next week opening hours","security":[{"GA":["locations-directory:read"]}],"parameters":[{"name":"service_id","in":"path","required":true,"schema":{"type":"string","minLength":1,"example":"12345"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","example":1,"minimum":1,"maximum":1,"default":1}},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","example":7,"minimum":7,"maximum":7,"default":7}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","description":"Represents a paginated opening-hours for the next 7 days including today.","required":["_embedded","_links"],"properties":{"_embedded":{"type":"object","required":["opening_hours"],"properties":{"opening_hours":{"type":"array","description":"The List of the opening hours for the next 7 days order by date.","items":{"allOf":[{"type":"object","description":"Represents the opening hours of a given date.","required":["id","date"],"properties":{"id":{"type":"integer","description":"The value of the day of week for a special date","minLength":1,"example":1},"date":{"type":"string","format":"date","description":"The ISO-formatted date to which the open hours refer to.","minLength":1,"example":"2023-05-01"},"special_date_name":{"type":"string","description":"Name of the special date, if it is defined.","example":"International Workers' Day","minLength":1}}},{"type":"object","required":["day_of_week","slots"],"properties":{"day_of_week":{"type":"string","description":"The day of the week to which the open hours refer to","minLength":1,"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"example":"TUESDAY"},"slots":{"type":"array","items":{"type":"object","required":["open_at","close_at"],"properties":{"open_at":{"type":"string","description":"The hour at which the location opens, in the location's time zone. Formatted according to the ISO-8601 standard.","minLength":1,"pattern":"^\\d\\d\\:\\d\\d\\:\\d\\d$","example":"09:00:00"},"close_at":{"type":"string","description":"The hour at which the location closes, in the location's time zone. Formatted according to the ISO-8601 standard.","minLength":1,"pattern":"^\\d\\d\\:\\d\\d\\:\\d\\d$","example":"18:00:00"}}}}}}]}}}},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string","format":"uri","example":"https://api-docs.talkdesk.org"}}}}}}},"example":{"_embedded":{"opening_hours":[{"id":1,"date":"2023-05-01","day_of_week":"MONDAY","special_date_name":"International Workers' Day","slots":[{"open_at":"09:00:00","close_at":"11:00:00"},{"open_at":"20:00:00","close_at":"23:00:00"}]},{"id":2,"date":"2023-05-02","day_of_week":"TUESDAY","slots":[{"open_at":"09:00:00","close_at":"23:00:00"}]},{"id":3,"date":"2023-05-03","day_of_week":"WEDNESDAY","slots":[{"open_at":"09:00:00","close_at":"23:00:00"}]},{"id":4,"date":"2023-05-04","day_of_week":"THURSDAY","slots":[{"open_at":"09:00:00","close_at":"23:00:00"}]},{"id":5,"date":"2023-05-05","day_of_week":"FRIDAY","slots":[{"open_at":"09:00:00","close_at":"23:00:00"}]},{"id":6,"date":"2023-05-06","day_of_week":"SATURDAY","slots":[{"open_at":"09:00:00","close_at":"12:00:00"}]},{"id":7,"date":"2023-05-07","day_of_week":"SUNDAY","slots":[{"open_at":"13:00:00","close_at":"18:00:00"}]}]},"_links":{"self":{"href":"https://api-docs.talkdesk.org"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"4034000","message":"Bad request."}}}},"404":{"description":"Location not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"4034041","message":"Location {location_id} not found"}}}}}}},"/locations-directory/addresses/geo-addresses":{"get":{"operationId":"getGeoAddresses","tags":["Locations Directory"],"description":"Get Google geo addresses. This API actually makes proxy calls to the Text Search of Google Place API.","security":[{"GA":["locations-directory:read"]}],"parameters":[{"name":"address","in":"query","required":true,"schema":{"type":"string","minLength":0,"maxLength":255}},{"name":"language","in":"query","required":false,"schema":{"type":"string","minLength":0,"maxLength":255}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","example":1,"minimum":1,"maximum":1,"default":1}},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","example":20,"minimum":1,"maximum":20,"default":20}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","description":"Represents geo address list.","required":["_embedded","_links"],"properties":{"_embedded":{"type":"object","required":["addresses"],"properties":{"addresses":{"type":"array","description":"The List of the geo address.","items":{"allOf":[{"type":"object","description":"Represents the geo address","required":["id","display_name","address","country_name","zip_code","coordinates"],"properties":{"id":{"type":"string","description":"The unique identifier of this Google geo address.","minLength":1,"example":"ChIJLU7jZClu5kcR4PcOOO6p3I0"},"display_name":{"type":"string","description":"The localized name of the place, suitable as a short human-readable description. For example, 'Google Sydney', 'Starbucks', 'Pyrmont', etc.","minLength":1,"example":"Hard Rock Cafe"},"address":{"type":"string","description":"It is a string containing the human-readable address of this location.","minLength":1,"example":"Avenida da Liberdade, 10"},"zip_code":{"type":"string","description":"The zip-code of the location","example":"1250-142","minLength":1},"city":{"type":"string","description":"The city of the location","example":"Lisbon","minLength":1},"region_name":{"type":"string","description":"The region name (country subdivision)","example":"Lisbon","minLength":1},"country_name":{"type":"string","description":"The country name","example":"Portugal","minLength":1},"coordinates":{"type":"object","required":["latitude","longitude"],"properties":{"latitude":{"type":"number","format":"double","minimum":-90,"maximum":90,"example":38.736946},"longitude":{"type":"number","format":"double","minimum":-180,"maximum":180,"example":-9.142685}}}}}]}}}},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string","format":"uri","example":"https://api-docs.talkdesk.org/locations-directory/addresses/geo-addresses?address=Eiffel%20Tower%20Coffee&language=en"}}}}}}},"example":{"_embedded":{"addresses":[{"id":"ChIJF9aljh1w5kcRJKA__KGc7W4","display_name":"Hard Rock Cafe","address":"5 Av. de Suffren, 75007 Paris, France","zip_code":"75007","city":"Paris","region_name":"Département de Paris","country_name":"France","coordinates":{"latitude":48.856944,"longitude":2.292222}},{"id":"ChIJFxVi-t9v5kcRyVC-eTkcleg","display_name":"Rock Cafe","address":"67 Av. de la Bourdonnais, 75007 Paris, France","zip_code":"75007","city":"Paris","region_name":"Département de Paris","country_name":"France","coordinates":{"latitude":48.856976,"longitude":2.301632}}]},"_links":{"self":{"href":"https://api-docs.talkdesk.org/locations-directory/addresses/geo-addresses?address=Eiffel%20Tower%20Coffee&language=en"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"4034000","message":"Bad request."}}}},"404":{"description":"Location not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"4034041","message":"Location {location_id} not found"}}}}}}},"/locations-directory/addresses/geocoding":{"get":{"operationId":"getGeocoding","tags":["Locations Directory"],"description":"Get Google geocoding. This API actually makes proxy calls to the Google Geocoding API.","security":[{"GA":["locations-directory:read"]}],"parameters":[{"name":"latlng","in":"query","required":false,"description":"
    • The latitude and longitude coordinates specifying the location for which you want the closest, human-readable address.
    • Either the parameter 'latlng' or the parameter 'address' must be passed. If both are passed, the 'address' parameter will prevail.
    • See Google developers documentation for more details: https://developers.google.com/maps/documentation/geocoding/requests-reverse-geocoding#:~:text=Required%20parameters-,latlng,-%E2%80%94%20The%20latitude%20and
    ","schema":{"type":"string","example":"34.041989,-118.235461","minLength":0,"maxLength":255}},{"name":"address","in":"query","required":false,"description":"
    • The street address or plus code that you want to geocode.
    • Either the parameter 'latlng' or the parameter 'address' must be passed. If both are passed, the 'address' parameter will prevail.
    • See Google developers documentation for more details: https://developers.google.com/maps/documentation/geocoding/requests-geocoding#:~:text=You%20must%20specify%20either%20address%20or%20components%20or%20both%20in%20a%20request%3A
    ","schema":{"type":"string","example":"Cafe, Los Angeles","minLength":0,"maxLength":255}},{"name":"language","in":"query","required":false,"schema":{"type":"string","example":"en","minLength":0,"maxLength":255}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","example":1,"minimum":1,"maximum":1,"default":1}},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","example":10,"minimum":10,"maximum":10,"default":10}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","description":"Represents geocoding list.","required":["_embedded","_links"],"properties":{"_embedded":{"type":"object","required":["addresses"],"properties":{"addresses":{"type":"array","description":"The List of the geocoding.","items":{"allOf":[{"type":"object","description":"Represents the geocoding","required":["id","display_name","address","country_name","zip_code","coordinates"],"properties":{"id":{"type":"string","description":"The unique identifier of this Google geocoding address.","minLength":1,"example":"ChIJLU7jZClu5kcR4PcOOO6p3I0"},"display_name":{"type":"string","description":"The localized name of the place, suitable as a short human-readable description. For example, 'Google Sydney', 'Starbucks', 'Pyrmont', etc.","minLength":1,"example":"Hard Rock Cafe"},"address":{"type":"string","description":"It is a string containing the human-readable address of this location.","minLength":1,"example":"Avenida da Liberdade, 10"},"zip_code":{"type":"string","description":"The zip-code of the location","example":"1250-142","minLength":1},"city":{"type":"string","description":"The city of the location","example":"Lisbon","minLength":1},"region_name":{"type":"string","description":"The region name (country subdivision)","example":"Lisbon","minLength":1},"country_name":{"type":"string","description":"The country name","example":"Portugal","minLength":1},"coordinates":{"type":"object","required":["latitude","longitude"],"properties":{"latitude":{"type":"number","format":"double","minimum":-90,"maximum":90,"example":38.736946},"longitude":{"type":"number","format":"double","minimum":-180,"maximum":180,"example":-9.142685}}}}}]}}}},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string","format":"uri","example":"https://api-docs.talkdesk.org/locations-directory/addresses/geocoding?latlng=38.736946,-9.142685&language=en"}}}}}}},"example":{"_embedded":{"addresses":[{"id":"ChIJF9aljh1w5kcRJKA__KGc7W4","display_name":"Hard Rock Cafe","address":"5 Av. de Suffren, 75007 Paris, France","zip_code":"75007","city":"Paris","region_name":"Département de Paris","country_name":"France","coordinates":{"latitude":48.856944,"longitude":2.292222}},{"id":"ChIJFxVi-t9v5kcRyVC-eTkcleg","display_name":"Rock Cafe","address":"67 Av. de la Bourdonnais, 75007 Paris, France","zip_code":"75007","city":"Paris","region_name":"Département de Paris","country_name":"France","coordinates":{"latitude":48.856976,"longitude":2.301632}}]},"_links":{"self":{"href":"https://api-docs.talkdesk.org/locations-directory/addresses/geocoding?latlng=38.736946,-9.142685&language=en"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"4034000","message":"Bad request."}}}},"404":{"description":"Location not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"4034041","message":"Location {location_id} not found"}}}}}}},"/locations-directory/services/types":{"get":{"operationId":"getServiceTypes","tags":["Locations Directory"],"description":"Get the paginated list of service types","security":[{"GA":["locations-directory:read"]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","example":1,"minimum":1,"default":1}},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","example":5,"minimum":1,"maximum":50,"default":50}},{"name":"service_name","in":"query","required":false,"schema":{"type":"string","example":"Shopping","description":"The name of the service","default":"","minLength":0,"maxLength":150}},{"name":"service_type","in":"query","required":false,"schema":{"type":"string","example":"Store","description":"The type of the service","default":"","minLength":0,"maxLength":150}},{"name":"location_name","in":"query","required":false,"schema":{"type":"string","example":"Store Avenida da Liberdade","description":"The name of the location","default":"","minLength":0,"maxLength":150}},{"name":"location_type","in":"query","required":false,"schema":{"type":"string","example":"Store","description":"The type of the location","default":"","minLength":0,"maxLength":150}},{"name":"location_id","in":"query","required":false,"schema":{"type":"string","example":"id","description":"The id of the location","default":"","minLength":0,"maxLength":150}}],"responses":{"200":{"description":"The paginated list of service types","content":{"application/json":{"schema":{"type":"object","description":"Represents a paginated list of service types","required":["count","total","total_pages","page","per_page","_embedded","_links"],"properties":{"count":{"type":"integer","format":"int32","description":"The number of results in the current page","example":40},"total":{"type":"integer","format":"int32","description":"The total of results","example":90},"page":{"type":"integer","format":"int32","description":"The current page","example":2},"per_page":{"type":"integer","format":"int32","description":"The number of results per page","example":50},"total_pages":{"type":"integer","format":"int32","description":"The total number of result pages","example":2},"_embedded":{"type":"object","required":["service_types"],"properties":{"service_types":{"type":"array","description":"The list of services in the current page","items":{"type":"string","description":"The type of service","example":["Online","Offline"]}}}},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string","format":"uri","example":"http://api-docs.talkdesk.org/locations-directory/services/types?page=1&per_page=10"}}},"next":{"type":"object","required":["href"],"properties":{"href":{"type":"string","format":"uri","example":"http://api-docs.talkdesk.org/locations-directory/services/types?page=2&per_page=10"}}}}}}},"example":{"_embedded":{"service_types":["Online","Offline"]},"count":"3,","total_pages":"1,","total":"3,","page":"1,","per_page":"50,","_links":{"self":{"href":"http://api-docs.talkdesk.org/locations-directory/services?page=1&per_page=2"},"next":{"href":"http://api-docs.talkdesk.org/locations-directory/services?page=2&per_page=2"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"4034000","message":"Bad request."}}}}}}},"/locations-directory/services/names":{"get":{"operationId":"getServiceNames","tags":["Locations Directory"],"description":"Get service names","security":[{"EarlyAccess":["locations-directory:read"]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","example":"1","minimum":1,"default":1}},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","example":"5","minimum":1,"maximum":50,"default":50}},{"name":"specialities","in":"query","required":false,"description":"The list of staff speciality, multiple values should split by ',' , like speciality1,speciality2","schema":{"type":"string","minLength":1,"example":"IT support"}},{"name":"service_name","in":"query","required":false,"schema":{"type":"string","example":"serviceName","description":"The name of service, support fuzzy search","minLength":0,"maxLength":150}},{"name":"cities","in":"query","required":false,"schema":{"type":"string","example":"cityName","description":"The name list of city, multiple values should split by ',' , like cityName1,cityName2","minLength":0,"maxLength":150}}],"responses":{"200":{"description":"Get service names successfully","content":{"application/json":{"schema":{"type":"object","required":["_embedded","total"],"properties":{"count":{"type":"integer","description":"the number of results in the current page"},"total":{"type":"integer","description":"the total of results in the account"},"page":{"type":"integer","description":"the current page"},"per_page":{"type":"integer","description":"the number of results per page"},"total_pages":{"type":"integer","description":"the number of the total of result pages"},"_embedded":{"type":"object","required":["services"],"properties":{"services":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"the name of the service","example":"Service Name"},"id":{"type":"string","description":"the unique identifier of the service","example":"12345678-1234-1234-1234-123456789012"}}}}}},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","example":"https://api-docs.talkdesk.org/"}}}}}}},"example":{"_embedded":{"services":[{"name":"Service Name","id":"12345678-1234-1234-1234-123456789012"},{"name":"Another Service Name","id":"23456789-2345-2345-2345-234567890123"}]},"count":1,"total":2,"page":1,"per_page":1,"total_pages":2,"_links":{"self":{"href":"http://api-docs.talkdesk.org/locations-directory/services/names?page=1&per_page=20"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"4034000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484010","message":"Invalid JWT token."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484030","message":"Required scopes are missing."}}}}}}},"/locations-directory/services/durations":{"get":{"operationId":"getServiceDurations","tags":["Locations Directory"],"description":"Get service durations","security":[{"EarlyAccess":["locations-directory:read"]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","example":"1","minimum":1,"default":1}},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","example":"5","minimum":1,"maximum":50,"default":50}},{"name":"service_duration","in":"query","required":false,"schema":{"type":"string","example":"1 hours","description":"The duration of service, support fuzzy search","minLength":0,"maxLength":150}}],"responses":{"200":{"description":"Get service durations successfully","content":{"application/json":{"schema":{"type":"object","required":["_embedded","total"],"properties":{"count":{"type":"integer","description":"the number of results in the current page"},"total":{"type":"integer","description":"the total of results in the account"},"page":{"type":"integer","description":"the current page"},"per_page":{"type":"integer","description":"the number of results per page"},"total_pages":{"type":"integer","description":"the number of the total of result pages"},"_embedded":{"type":"object","required":["service_durations"],"properties":{"service_durations":{"type":"array","items":{"type":"string","example":"Service"}}}},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","example":"https://api-docs.talkdesk.org/"}}}}}}},"example":{"_embedded":{"service_durations":["service1","service2"]},"count":1,"total":2,"page":1,"per_page":1,"total_pages":2,"_links":{"self":{"href":"http://api-docs.talkdesk.org/locations-directory/services/durations?page=1&per_page=20"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"4034000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484010","message":"Invalid JWT token."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484030","message":"Required scopes are missing."}}}}}}},"/locations-directory/staffs":{"get":{"operationId":"getStaffs","tags":["Locations Directory"],"description":"Search staffs by conditions","security":[{"GA":["staffs-directory:read"]}],"parameters":[{"name":"page","in":"query","description":"Desired page","required":false,"example":1,"schema":{"format":"int32","type":"integer","default":1,"minimum":1,"maximum":2147483647}},{"name":"per_page","in":"query","description":"Limit the number of prompts per page","required":false,"example":50,"schema":{"format":"int32","default":50,"minimum":1,"maximum":50,"type":"integer"}},{"name":"name","in":"query","description":"Name of staff","required":false,"example":"Marry","schema":{"default":"","minLength":0,"maxLength":9999,"type":"string"}},{"name":"searchTerm","in":"query","description":"Search term to filter staffs by name or email.","required":false,"example":"Mary","schema":{"default":"","minLength":0,"maxLength":512,"type":"string"}},{"name":"manager","in":"query","description":"Manager of staff","required":false,"example":"Maike","schema":{"default":"","minLength":0,"maxLength":9999,"type":"string"}},{"name":"speciality","in":"query","description":"Speciality of staff","required":false,"example":"cardiology","schema":{"default":"","minLength":0,"maxLength":9999,"type":"string"}},{"name":"job_title","in":"query","description":"Job title of staff","required":false,"example":"Manager","schema":{"default":"","minLength":0,"maxLength":9999,"type":"string"}},{"name":"external_id","in":"query","description":"External id of staff","required":false,"example":1,"schema":{"default":"","minLength":0,"maxLength":9999,"type":"string"}},{"name":"industry","in":"query","description":"Industry of staff","required":false,"example":"Retail","schema":{"default":"","minLength":0,"maxLength":9999,"type":"string"}},{"name":"gender","in":"query","description":"Gender of staff","required":false,"example":"male","schema":{"default":"","minLength":0,"maxLength":9999,"type":"string"}},{"name":"status","in":"query","description":"Status of staff","required":false,"example":"Active","schema":{"default":"","minLength":0,"maxLength":9999,"type":"string"}},{"name":"language","in":"query","description":"Language of staff","required":false,"example":"English","schema":{"default":"","minLength":0,"maxLength":9999,"type":"string"}},{"name":"visit_type","in":"query","description":"Visit type name of staff","required":false,"example":"type","schema":{"default":"","minLength":0,"maxLength":9999,"type":"string"}},{"name":"location_id","in":"query","required":false,"schema":{"type":"string","example":"id","description":"The id of the location","default":"","minLength":0,"maxLength":150}},{"name":"location_name","in":"query","required":false,"schema":{"type":"string","example":"Store Avenida da Liberdade","description":"The name of the location which staff in","default":"","minLength":0,"maxLength":150}},{"name":"location_type","in":"query","required":false,"schema":{"type":"string","example":"Store","description":"The type of the location which staff in","default":"","minLength":0,"maxLength":150}},{"name":"zip_code","in":"query","required":false,"schema":{"type":"string","example":"1250-142","description":"The zip-code of the location which staff in","default":"","minLength":0,"maxLength":20}},{"name":"city","in":"query","required":false,"schema":{"type":"string","example":"Lisbon","description":"The city of the location which staff in","default":"","minLength":0,"maxLength":100}},{"name":"country_name","in":"query","required":false,"schema":{"type":"string","example":"Portugal","description":"The country name of location which staff in","default":"","minLength":0,"maxLength":100}},{"name":"region_name","in":"query","required":false,"schema":{"type":"string","example":"Lisbon","description":"The region name (country subdivision) of location which staff in","default":"","minLength":0,"maxLength":100}},{"name":"service_id","in":"query","required":false,"schema":{"type":"string","example":"id","description":"The id of the service","default":"","minLength":0,"maxLength":150}},{"name":"service_name","in":"query","required":false,"schema":{"type":"string","example":"service name","description":"The name of the service provided by staff","default":"","minLength":0,"maxLength":9999}},{"name":"service_type","in":"query","required":false,"schema":{"type":"string","example":"service type","description":"The type of the service provided by staff","default":"","minLength":0,"maxLength":9999}},{"name":"latitude","in":"query","required":false,"schema":{"type":"number","format":"double","example":38.698943,"description":"
    • Latitude and longitude are used together with distance. The search parameters include latitude and longitude to retrieve a list of all staffs within a certain radius.
    • Currently, these three parameters can only be used when the Feature Flag is enabled.
    ","minimum":-90,"maximum":90}},{"name":"longitude","in":"query","required":false,"schema":{"type":"number","format":"double","example":-9.18423,"description":"
    • Latitude and longitude are used together with distance. The search parameters include latitude and longitude to retrieve a list of all staffs within a certain radius.
    • Currently, these three parameters can only be used when the Feature Flag is enabled.
    ","default":"","minimum":-180,"maximum":180}},{"name":"distance","in":"query","required":false,"schema":{"type":"number","format":"double","example":10000,"description":"
    • Latitude and longitude are used together with distance. The search parameters include latitude and longitude to retrieve a list of all staffs within a certain radius.
    • Distance is measured in meters.
    • If no distance is provided, the default distance configured in Industries-settings will be used.
    • Currently, these three parameters can only be used when the Feature Flag is enabled.
    ","minimum":0}},{"name":"order_by","in":"query","description":"Order by field, should be one of -> name, external_id, manager, speciality, job_title, date_of_hire, created_at, updated_at","required":false,"example":"name","schema":{"default":"name","minLength":0,"maxLength":9999,"type":"string"}},{"name":"sort","in":"query","description":"Sort field, should be one of -> DESC, ASC","required":false,"example":"DESC","schema":{"default":"DESC","minLength":0,"maxLength":9999,"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","required":["_embedded","total"],"properties":{"count":{"type":"integer","format":"int32","description":"the number of results in the current page","minimum":1,"maximum":2147483647,"example":40},"total":{"type":"integer","format":"int32","description":"the total of results in the account","minimum":1,"maximum":2147483647,"example":90},"page":{"type":"integer","format":"int32","description":"the current page","minimum":1,"maximum":2147483647,"example":2},"per_page":{"type":"integer","format":"int32","description":"the number of results per page","minimum":1,"maximum":50,"example":50},"total_pages":{"type":"integer","format":"int32","description":"the number of the total of result pages","minimum":1,"maximum":2147483647,"example":2},"_embedded":{"type":"object","required":["staffs"],"properties":{"staffs":{"type":"array","description":"The list of staffs in the current page","items":{"type":"object","required":["id","name","external_id"],"properties":{"id":{"type":"string","description":"The staff identifier","minLength":1,"maxLength":9999,"example":"d08d05cc-ac7a-11ed-afa1-0242ac120002"},"name":{"type":"string","description":"The name of staff","minLength":1,"maxLength":9999,"example":"New Staff"},"description":{"type":"string","description":"The description of staff","minLength":1,"maxLength":9999,"example":"I am a Doctor"},"contacts":{"type":"array","items":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","description":"The type of contact","minLength":1,"maxLength":9999,"example":"phone"},"value":{"type":"string","description":"The value of contact","minLength":1,"maxLength":9999,"example":"123456"},"description":{"type":"string","description":"The description of contact","minLength":1,"maxLength":9999,"example":"it is my phone"}}},"description":"Employee contact list"},"job_title":{"type":"string","description":"Professional title (e.g. Mid Market Customer Success Manager)","minLength":1,"maxLength":9999,"example":"Success Manager"},"manager":{"type":"string","description":"Name of direct manager","minLength":1,"maxLength":9999,"example":"Maike"},"pronouns":{"type":"string","description":"Understand the employee pronouns (e.g. she/her, he/his)","minLength":1,"maxLength":9999,"example":"she"},"specialities":{"type":"array","description":"The specialties of staff","items":{"type":"string","description":"The specialty or areas of expertise (e.g., cardiology, pediatrics)","minLength":1,"maxLength":9999,"example":"cardiology"}},"external_id":{"type":"string","description":"The external id of staff, should be unique","minLength":1,"maxLength":9999,"example":"1"},"industry":{"type":"string","description":"The industry of staff","minLength":1,"maxLength":9999,"example":"Doctor"},"photo_url":{"type":"string","description":"The photo url of staff","minLength":1,"maxLength":9999,"example":"https://images/1.png"},"gender":{"type":"string","description":"The gender of staff","minLength":1,"maxLength":9999,"example":"male"},"status":{"type":"string","description":"The status of staff","minLength":1,"maxLength":9999,"example":"Active"},"date_of_birth":{"type":"string","description":"The dateOfBirth of staff","minLength":1,"maxLength":9999,"example":"1987-01-23"},"date_of_hire":{"type":"string","description":"The dateOfHire of staff","minLength":1,"maxLength":9999,"example":"2021-03-23"},"languages":{"type":"array","description":"The languages of staff","items":{"type":"string","minLength":1,"maxLength":9999,"description":"The language of staff","example":"English"}},"attributes":{"type":"object","description":"The attributes of staff, attributes should be object, and key can be any value","example":{"note":"note","experience":"6 year"}},"relationships":{"type":"array","description":"The relationship list of staff","items":{"type":"object","description":"Item can only have location or service, if both has value, service should belong to location","properties":{"location":{"type":"object","properties":{"id":{"type":"string","description":"The id of location","minLength":1,"maxLength":9999,"example":"d06b0425-c9eb-d8a3-a7c0-ce14d96a651f"},"name":{"type":"string","description":"The name of location","minLength":1,"maxLength":9999,"example":"location"}}},"service":{"type":"object","properties":{"id":{"type":"string","description":"The id of service","minLength":1,"maxLength":9999,"example":"d06b0425-c9eb-d8a3-a7c0-ce14d96a651f"},"name":{"type":"string","description":"The name of service","minLength":1,"maxLength":9999,"example":"service"}}}}}},"visit_types":{"type":"array","description":"The visit type list of staff","items":{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","description":"The id of visit type, can be anything","minLength":1,"maxLength":9999,"example":"d06b0425-c9eb-d8a3-a7c0-ce14d96a651f"},"name":{"type":"string","description":"The name of visit type, can be anything","minLength":1,"maxLength":9999,"example":"name"}}}},"tags":{"description":"Tag list","type":"array","items":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The id of tag","minLength":1,"maxLength":9999,"example":"d06b0425-c9eb-d8a3-a7c0-ce14d96a651f"},"value":{"type":"string","description":"The value of tag","minLength":1,"maxLength":9999,"example":"VIP"},"color":{"type":"string","description":"The color of tag","minLength":1,"maxLength":9999,"example":"#EFDBFF"}}}}}}}}},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string","format":"uri","minLength":1,"maxLength":9999,"example":"https://api-docs.talkdesk.org/"}}}}}}},"example":{"_embedded":{"staffs":[{"id":"d08d05cc-ac7a-11ed-afa1-0242ac120002","name":"Test-Staff","description":"I am a Doctor","job_title":"title","specialities":["IT support","Diagnostic specialist"],"pronouns":"she","manager":"manager","contacts":[{"type":"phone","value":"+123456789","description":"phone"}],"external_id":"1","industry":"Doctor","photo_url":"https://images/1.png","gender":"male","status":"Active","date_of_birth":"1987-01-23","date_of_hire":"2021-03-23","languages":["English","Chinese"],"attributes":{"note":"note","experience":"6 year"},"relationships":[{"location":{"id":"1","name":"location 1"},"service":{"id":"2","name":"service 1"}},{"location":{"id":"3","name":"location 2"}},{"service":{"id":"4","name":"service 2"}}],"visit_types":[{"id":"1","name":"name"}],"tags":[{"id":"1","value":"VIP","color":"#EFDBFF"},{"id":"2","value":"VVIP","color":"#EFDBFF"}]}]},"count":1,"total":2,"page":1,"per_page":1,"total_pages":2,"_links":{"self":{"href":"http://api-docs.talkdesk.org/locations-directory/staffs?page=1&per_page=20"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484010","message":"Invalid JWT token."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484030","message":"Required scopes are missing."}}}}}}},"/locations-directory/staffs/specialities":{"get":{"operationId":"getStaffSpecialities","tags":["Locations Directory"],"description":"Get staff specialities","security":[{"EarlyAccess":["staffs-directory:read"]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","example":"1","minimum":1,"default":1}},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","example":"5","minimum":1,"maximum":50,"default":50}},{"name":"speciality","in":"query","required":false,"description":"The staff speciality, support fuzzy search","schema":{"type":"string","minLength":1,"example":"IT support"}},{"name":"location_id","in":"query","required":false,"schema":{"type":"string","example":"id","description":"The id of the location","default":"","minLength":0,"maxLength":150}},{"name":"service_id","in":"query","required":false,"schema":{"type":"string","example":"id","description":"The id of the service","default":"","minLength":0,"maxLength":150}},{"name":"service_names","in":"query","required":false,"schema":{"type":"string","example":"serviceName","description":"The name list of the service, multiple values should split by ',' , like serviceName1,serviceName2","minLength":0,"maxLength":150}},{"name":"cities","in":"query","required":false,"schema":{"type":"string","example":"cityName","description":"The name list of city, multiple values should split by ',' , like cityName1,cityName2","minLength":0,"maxLength":150}}],"responses":{"200":{"description":"Get staff specialities successfully","content":{"application/json":{"schema":{"type":"object","required":["_embedded","total"],"properties":{"count":{"type":"integer","description":"the number of results in the current page"},"total":{"type":"integer","description":"the total of results in the account"},"page":{"type":"integer","description":"the current page"},"per_page":{"type":"integer","description":"the number of results per page"},"total_pages":{"type":"integer","description":"the number of the total of result pages"},"_embedded":{"type":"object","required":["specialities"],"properties":{"specialities":{"type":"array","items":{"type":"string","example":"IT support"}}}},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","example":"https://api-docs.talkdesk.org/"}}}}}}},"example":{"_embedded":{"specialities":["IT support","Diagnostic specialist"]},"count":1,"total":2,"page":1,"per_page":1,"total_pages":2,"_links":{"self":{"href":"http://api-docs.talkdesk.org/locations-directory/staffs/specialities?page=1&per_page=20"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"4034000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484010","message":"Invalid JWT token."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484030","message":"Required scopes are missing."}}}}}}},"/locations-directory/staffs-agent":{"get":{"operationId":"getStaffsAgent","tags":["Locations Directory"],"description":"Get the paginated list of staffs for agent view","security":[{"EarlyAccess":["staffs-directory:read"]}],"parameters":[{"name":"page","in":"query","description":"Desired page","required":false,"example":1,"schema":{"format":"int32","type":"integer","default":1,"minimum":1,"maximum":2147483647}},{"name":"per_page","in":"query","description":"Limit the number of prompts per page","required":false,"example":50,"schema":{"format":"int32","default":50,"minimum":1,"maximum":50,"type":"integer"}},{"name":"staff_name","in":"query","description":"Name of staff","required":false,"example":"Marry","schema":{"default":"","minLength":0,"maxLength":9999,"type":"string"}},{"name":"visit_type","in":"query","description":"Visit type name of staff","required":false,"example":"type","schema":{"default":"","minLength":0,"maxLength":9999,"type":"string"}},{"name":"location_id","in":"query","required":true,"example":"id","description":"The id of the location","schema":{"type":"string","default":"","minLength":0,"maxLength":150}},{"name":"service_types","in":"query","required":false,"schema":{"type":"string","example":"Store","description":"The list of service types, multiple values should split by ',' , like type1,type2","default":"","minLength":1}},{"name":"service_durations","in":"query","required":false,"example":"service duration","description":"The list of service durations, multiple values should split by ',' , like duration1,duration2","schema":{"type":"string","default":"","minLength":1}},{"name":"specialities","in":"query","required":false,"description":"The list of staff speciality, multiple values should split by ',' , like speciality1,speciality2","schema":{"type":"string","minLength":1,"example":"IT support"}},{"name":"service_names","in":"query","required":false,"schema":{"type":"string","example":"serviceName","description":"The name list of the service, multiple values should split by ',' , like serviceName1,serviceName2","minLength":0,"maxLength":150}},{"name":"service_ids","in":"query","required":false,"schema":{"type":"string","example":"serviceId","description":"The id list of the service, multiple values should split by ',' , like serviceId1,serviceId2","minLength":1}},{"name":"languages","in":"query","required":false,"description":"The list of staff language, multiple values should split by ',' , like English,Chinese","schema":{"type":"string","minLength":1,"example":"English"}},{"name":"genders","in":"query","required":false,"schema":{"type":"string","example":"Female","description":"The list of staff genders, multiple values should split by ',' , like Male,Female","default":"","minLength":1}},{"name":"tag_values","in":"query","required":false,"schema":{"type":"string","example":"tag","description":"The list of tag values, multiple values should split by ',' , like tag1,tag2","default":"","minLength":1}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","required":["_embedded","total"],"properties":{"count":{"type":"integer","format":"int32","description":"the number of results in the current page","minimum":1,"maximum":2147483647,"example":40},"total":{"type":"integer","format":"int32","description":"the total of results in the account","minimum":1,"maximum":2147483647,"example":90},"page":{"type":"integer","format":"int32","description":"the current page","minimum":1,"maximum":2147483647,"example":2},"per_page":{"type":"integer","format":"int32","description":"the number of results per page","minimum":1,"maximum":50,"example":50},"total_pages":{"type":"integer","format":"int32","description":"the number of the total of result pages","minimum":1,"maximum":2147483647,"example":2},"_embedded":{"type":"object","required":["staffs"],"properties":{"staffs":{"type":"array","description":"The list of staffs in the current page","items":{"type":"object","required":["id","name","external_id"],"properties":{"id":{"type":"string","description":"The staff identifier","minLength":1,"maxLength":9999,"example":"d08d05cc-ac7a-11ed-afa1-0242ac120002"},"name":{"type":"string","description":"The name of staff","minLength":1,"maxLength":9999,"example":"New Staff"},"description":{"type":"string","description":"The description of staff","minLength":1,"maxLength":9999,"example":"I am a Doctor"},"contacts":{"type":"array","items":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","description":"The type of contact","minLength":1,"maxLength":9999,"example":"phone"},"value":{"type":"string","description":"The value of contact","minLength":1,"maxLength":9999,"example":"123456"},"description":{"type":"string","description":"The description of contact","minLength":1,"maxLength":9999,"example":"it is my phone"}}},"description":"Employee contact list"},"job_title":{"type":"string","description":"Professional title (e.g. Mid Market Customer Success Manager)","minLength":1,"maxLength":9999,"example":"Success Manager"},"manager":{"type":"string","description":"Name of direct manager","minLength":1,"maxLength":9999,"example":"Maike"},"pronouns":{"type":"string","description":"Understand the employee pronouns (e.g. she/her, he/his)","minLength":1,"maxLength":9999,"example":"she"},"specialities":{"type":"array","description":"The specialties of staff","items":{"type":"string","description":"The specialty or areas of expertise (e.g., cardiology, pediatrics)","minLength":1,"maxLength":9999,"example":"cardiology"}},"external_id":{"type":"string","description":"The external id of staff, should be unique","minLength":1,"maxLength":9999,"example":"1"},"industry":{"type":"string","description":"The industry of staff","minLength":1,"maxLength":9999,"example":"Doctor"},"photo_url":{"type":"string","description":"The photo url of staff","minLength":1,"maxLength":9999,"example":"https://images/1.png"},"gender":{"type":"string","description":"The gender of staff","minLength":1,"maxLength":9999,"example":"male"},"status":{"type":"string","description":"The status of staff","minLength":1,"maxLength":9999,"example":"Active"},"date_of_birth":{"type":"string","description":"The dateOfBirth of staff","minLength":1,"maxLength":9999,"example":"1987-01-23"},"date_of_hire":{"type":"string","description":"The dateOfHire of staff","minLength":1,"maxLength":9999,"example":"2021-03-23"},"languages":{"type":"array","description":"The languages of staff","items":{"type":"string","minLength":1,"maxLength":9999,"description":"The language of staff","example":"English"}},"attributes":{"type":"object","description":"The attributes of staff, attributes should be object, and key can be any value","example":{"note":"note","experience":"6 year"}},"relationships":{"type":"array","description":"The relationship list of staff","items":{"type":"object","description":"Item can only have location or service, if both has value, service should belong to location","properties":{"location":{"type":"object","properties":{"id":{"type":"string","description":"The id of location","minLength":1,"maxLength":9999,"example":"d06b0425-c9eb-d8a3-a7c0-ce14d96a651f"},"name":{"type":"string","description":"The name of location","minLength":1,"maxLength":9999,"example":"location"}}},"service":{"type":"object","properties":{"id":{"type":"string","description":"The id of service","minLength":1,"maxLength":9999,"example":"d06b0425-c9eb-d8a3-a7c0-ce14d96a651f"},"name":{"type":"string","description":"The name of service","minLength":1,"maxLength":9999,"example":"service"}}}}}},"visit_types":{"type":"array","description":"The visit type list of staff","items":{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","description":"The id of visit type, can be anything","minLength":1,"maxLength":9999,"example":"d06b0425-c9eb-d8a3-a7c0-ce14d96a651f"},"name":{"type":"string","description":"The name of visit type, can be anything","minLength":1,"maxLength":9999,"example":"name"}}}},"tags":{"description":"Tag list","type":"array","items":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The id of tag","minLength":1,"maxLength":9999,"example":"d06b0425-c9eb-d8a3-a7c0-ce14d96a651f"},"value":{"type":"string","description":"The value of tag","minLength":1,"maxLength":9999,"example":"VIP"},"color":{"type":"string","description":"The color of tag","minLength":1,"maxLength":9999,"example":"#EFDBFF"}}}}}}}}},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string","format":"uri","minLength":1,"maxLength":9999,"example":"https://api-docs.talkdesk.org/"}}}}}}},"example":{"_embedded":{"staffs":[{"id":"d08d05cc-ac7a-11ed-afa1-0242ac120002","name":"Test-Staff","description":"I am a Doctor","job_title":"title","specialities":["IT support","Diagnostic specialist"],"pronouns":"she","manager":"manager","contacts":[{"type":"phone","value":"+123456789","description":"phone"}],"external_id":"1","industry":"Doctor","photo_url":"https://images/1.png","gender":"male","status":"Active","date_of_birth":"1987-01-23","date_of_hire":"2021-03-23","languages":["English","Chinese"],"attributes":{"note":"note","experience":"6 year"},"relationships":[{"location":{"id":"1","name":"location 1"},"service":{"id":"2","name":"service 1"}},{"location":{"id":"3","name":"location 2"}},{"service":{"id":"4","name":"service 2"}}],"visit_types":[{"id":"1","name":"name"}],"tags":[{"id":"1","value":"VIP","color":"#EFDBFF"},{"id":"2","value":"VVIP","color":"#EFDBFF"}]}]},"count":1,"total":2,"page":1,"per_page":1,"total_pages":2,"_links":{"self":{"href":"http://api-docs.talkdesk.org/locations-directory/staffs-agent?page=1&per_page=20"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484010","message":"Invalid JWT token."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484030","message":"Required scopes are missing."}}}}}}},"/locations-directory/staffs/specialities-services-locations":{"get":{"operationId":"getSpecialtiesServicesLocations","tags":["Locations Directory"],"description":"Get the paginated list of specialties","security":[{"GA":["staffs-directory:read"]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","example":1,"minimum":1,"default":1}},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","example":5,"minimum":1,"maximum":50,"default":50}},{"name":"zip_code","in":"query","required":false,"schema":{"type":"string","example":"1250-142","description":"The zip-code of the location which can provide the service","default":"","minLength":0,"maxLength":20}},{"name":"city","in":"query","required":false,"schema":{"type":"string","example":"Lisbon","description":"The city of the location which can provide the service","default":"","minLength":0,"maxLength":100}},{"name":"country_name","in":"query","required":false,"schema":{"type":"string","example":"Portugal","description":"The country name of location which can provide the service","default":"","minLength":0,"maxLength":100}},{"name":"region_name","in":"query","required":false,"schema":{"type":"string","example":"Lisbon","description":"The region name (country subdivision) of location which can provide the service","default":"","minLength":0,"maxLength":100}},{"name":"speciality","in":"query","required":false,"schema":{"type":"string","example":"speciality","description":"The specialty of the staff who can provide the service","default":"","minLength":0,"maxLength":9999}},{"name":"latitude","in":"query","required":false,"schema":{"type":"number","format":"double","example":38.698943,"description":"
    • Latitude and longitude are used together with distance. The search parameters include latitude and longitude to retrieve a list of all services within a certain radius.
    • Currently, these three parameters can only be used when the Feature Flag is enabled.
    ","minimum":-90,"maximum":90}},{"name":"longitude","in":"query","required":false,"schema":{"type":"number","format":"double","example":-9.18423,"description":"
    • Latitude and longitude are used together with distance. The search parameters include latitude and longitude to retrieve a list of all services within a certain radius.
    • Currently, these three parameters can only be used when the Feature Flag is enabled.
    ","default":"","minimum":-180,"maximum":180}},{"name":"distance","in":"query","required":false,"schema":{"type":"number","format":"double","example":10000,"description":"
    • Latitude and longitude are used together with distance. The search parameters include latitude and longitude to retrieve a list of all services within a certain radius.
    • Distance is measured in meters.
    • If no distance is provided, the default distance configured in Industries-settings will be used.
    • Currently, these three parameters can only be used when the Feature Flag is enabled.
    ","minimum":0}}],"responses":{"200":{"description":"The paginated list of services","content":{"application/json":{"schema":{"type":"object","description":"Represents a paginated list of services","required":["count","total","total_pages","page","per_page","_embedded","_links"],"properties":{"count":{"type":"integer","format":"int32","description":"The number of results in the current page","example":40},"total":{"type":"integer","format":"int32","description":"The total of results","example":90},"page":{"type":"integer","format":"int32","description":"The current page","example":2},"per_page":{"type":"integer","format":"int32","description":"The number of results per page","example":50},"total_pages":{"type":"integer","format":"int32","description":"The total number of result pages","example":2},"_embedded":{"type":"object","required":["specialities"],"properties":{"specialities":{"type":"array","description":"The list of specialities in the current page","items":{"type":"object","required":["id","speciality","locationId","locationName","serviceName","serviceId","staffName","staffId","createdAt","updatedAt"],"properties":{"id":{"type":"string","description":"The id of speciality","example":"1735627055-45272"},"speciality":{"type":"string","description":"The name of speciality","example":"Shopping"},"service_name":{"type":"string","description":"The name of service","example":"shopping service"},"service_id":{"type":"string","description":"The id of the service","example":"5d9162f6-5c09-4817-afcf-b94752467e52"},"location_id":{"type":"string","description":"The location id","example":"6f2e1b2a-4373-477d-ad74-6d38034fa61d"},"location_name":{"type":"string","description":"The location name","example":"Store XYZ"},"staff_name":{"type":"string","description":"The name of the staff","example":"Test-Staff"},"staff_id":{"type":"string","description":"The id of the staff","example":"ceb3aa83-1f1e-4952-9507-7f5bed037e32"},"created_by":{"type":"string","description":"The creator of the record","example":"zhangjunli"},"created_at":{"type":"string","description":"The creation timestamp","example":"2024-12-31T04:32:14.241400Z"},"updated_by":{"type":"string","description":"The last updater of the record","example":"zhangjunli"},"updated_at":{"type":"string","description":"The last updated timestamp","example":"2024-12-31T04:32:14.257507Z"}}}}}},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string","format":"uri","example":"http://api-docs.talkdesk.org/locations-directory/staffs/specialities-services-locations?page=1&per_page=10"}}},"next":{"type":"object","required":["href"],"properties":{"href":{"type":"string","format":"uri","example":"http://api-docs.talkdesk.org/locations-directory/staffs/specialities-services-locations?page=2&per_page=10"}}}}}}},"example":{"_embedded":{"specialities":[{"id":"1735627055-45272","speciality":"Shopping","service_name":"shopping service","service_id":"5d9162f6-5c09-4817-afcf-b94752467e52","location_id":"6f2e1b2a-4373-477d-ad74-6d38034fa61d","location_name":"Store XYZ","staff_name":"Test-Staff","staff_id":"ceb3aa83-1f1e-4952-9507-7f5bed037e32","created_by":"zhangjunli","created_at":"2024-12-31T04:32:14.241400Z","updated_by":"zhangjunli","updated_at":"2024-12-31T04:32:14.257507Z"},{"id":"1735627055-45273","speciality":"Shopping","service_name":"movie service","service_id":"5d9162f6-5c09-4817-afcf-b94752467e52","location_id":"6f2e1b2a-4373-477d-ad74-6d38034fa61d","location_name":"Cinema XYZ","staff_name":"Test-Staff","staff_id":"ceb3aa83-1f1e-4952-9507-7f5bed037e32","created_by":"zhangjunli","created_at":"2024-12-31T04:32:14.241400Z","updated_by":"zhangjunli","updated_at":"2024-12-31T04:32:14.257507Z"}]},"_links":{"self":{"href":"http://api-docs.talkdesk.org/locations-directory/staffs/specialities-services-locations?page=1&per_page=10"},"next":{"href":"http://api-docs.talkdesk.org/locations-directory/staffs/specialities-services-locations?page=2&per_page=10"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"4034000","message":"Bad request."}}}}}}},"/locations-directory/staffs/genders":{"get":{"operationId":"getStaffGenders","tags":["Locations Directory"],"description":"Get staff genders","security":[{"EarlyAccess":["staffs-directory:read"]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","example":"1","minimum":1,"default":1}},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","example":"5","minimum":1,"maximum":50,"default":50}},{"name":"gender","in":"query","required":false,"schema":{"type":"string","example":"male","description":"The gender of the staff, support fuzzy search","minLength":0,"maxLength":150}}],"responses":{"200":{"description":"Get staff genders successfully","content":{"application/json":{"schema":{"type":"object","required":["_embedded","total"],"properties":{"count":{"type":"integer","description":"the number of results in the current page"},"total":{"type":"integer","description":"the total of results in the account"},"page":{"type":"integer","description":"the current page"},"per_page":{"type":"integer","description":"the number of results per page"},"total_pages":{"type":"integer","description":"the number of the total of result pages"},"_embedded":{"type":"object","required":["genders"],"properties":{"genders":{"type":"array","items":{"type":"string","example":"Male"}}}},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","example":"https://api-docs.talkdesk.org/"}}}}}}},"example":{"_embedded":{"genders":["Male","Female"]},"count":1,"total":2,"page":1,"per_page":1,"total_pages":2,"_links":{"self":{"href":"http://api-docs.talkdesk.org/locations-directory/staffs/genders?page=1&per_page=20"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"4034000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484010","message":"Invalid JWT token."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1484030","message":"Required scopes are missing."}}}}}}},"/industries-scheduler/teams":{"get":{"tags":["Industries Scheduler"],"description":"Get teams associated to an account by team id","security":[{"GA":["industries-scheduler-teams:read"]}],"parameters":[{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer","default":0,"minimum":0,"maximum":99}},{"name":"size","in":"query","description":"Page size","required":false,"schema":{"type":"integer","default":10,"minimum":1,"maximum":250}}],"responses":{"200":{"description":"Teams details","content":{"application/json":{"schema":{"type":"object","required":["_embedded","total_pages","total","count","page","per_page","_links"],"properties":{"_embedded":{"type":"object","description":"The embedded object","properties":{"teams":{"type":"array","items":{"type":"object","required":["id","topic","account_id","sub_topics"],"properties":{"id":{"type":"string","description":"The ID number that uniquely identifies the team"},"topic":{"type":"object","description":"The team's details","required":["name","meetings_duration","working_time_start","working_time_end","working_days","time_zone"],"properties":{"name":{"type":"string","description":"Topic name"},"meetings_duration":{"type":"integer","description":"the meetings duration in minutes"},"members":{"type":"array","description":"List of members. In subTopics are only allowed member presented in main topic","items":{"type":"object","required":["email","provider"],"properties":{"name":{"type":"string","description":"Team member name"},"email":{"type":"string","description":"Team member email"},"provider":{"type":"string","description":"Team member email provider","enum":["GOOGLE","OUTLOOK"]},"status":{"type":"string","description":"Team member status - ACTIVE after the member has given access to his calendar, otherwise is PENDING","enum":["ACTIVE","PENDING"]},"fallback_link":{"type":"string","description":"The default long-term meeting link of the specialist","maxLength":512}}}},"status":{"type":"string","description":"Topic status - active when one of the member is ACTIVE, otherwise PENDING","enum":["ACTIVE","PENDING"]},"working_time_start":{"type":"string","description":"Working time start"},"working_time_end":{"type":"string","description":"Working time end"},"working_days":{"type":"array","description":"List of week days that the members in the topic are available"},"time_zone":{"type":"string","description":"Timezone specification"},"topic_type":{"type":"string","description":"The topic type creation method","enum":["MANUAL_INPUT","DIRECTORY_LINKED"]}}},"account_id":{"type":"string","description":"The account id"},"sub_topics":{"type":"array","description":"Sub topic have the sub-teams details","items":{"type":"object","description":"The team's details","required":["name","meetings_duration","working_time_start","working_time_end","working_days","time_zone"],"properties":{"name":{"type":"string","description":"Topic name"},"meetings_duration":{"type":"integer","description":"the meetings duration in minutes"},"members":{"type":"array","description":"List of members. In subTopics are only allowed member presented in main topic","items":{"type":"object","required":["email","provider"],"properties":{"name":{"type":"string","description":"Team member name"},"email":{"type":"string","description":"Team member email"},"provider":{"type":"string","description":"Team member email provider","enum":["GOOGLE","OUTLOOK"]},"status":{"type":"string","description":"Team member status - ACTIVE after the member has given access to his calendar, otherwise is PENDING","enum":["ACTIVE","PENDING"]},"fallback_link":{"type":"string","description":"The default long-term meeting link of the specialist","maxLength":512}}}},"status":{"type":"string","description":"Topic status - active when one of the member is ACTIVE, otherwise PENDING","enum":["ACTIVE","PENDING"]},"working_time_start":{"type":"string","description":"Working time start"},"working_time_end":{"type":"string","description":"Working time end"},"working_days":{"type":"array","description":"List of week days that the members in the topic are available"},"time_zone":{"type":"string","description":"Timezone specification"},"topic_type":{"type":"string","description":"The topic type creation method","enum":["MANUAL_INPUT","DIRECTORY_LINKED"]}}}},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}}}}}}}}},"total_pages":{"type":"integer","description":"The total pages present"},"total":{"type":"integer","description":"The number of teams"},"count":{"type":"integer","description":"The count"},"page":{"type":"integer","description":"Page number"},"per_page":{"type":"integer","description":"Page size"},"_links":{"type":"object","required":["self","next","prev","first","last"],"properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}},"next":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}},"prev":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}},"first":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}},"last":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}}}}}},"example":{"_embedded":{"teams":[{"id":"630cf527257249351c204bd4","topic":{"name":"First team","meetings_duration":30,"members":[{"name":"Joe","email":"joe@mail.com","provider":"GOOGLE","status":"PENDING","fallback_link":"https://meet.google.com/abc-defg-hij"},{"name":"Bob","email":"bob@mail.com","provider":"OUTLOOK","status":"ACTIVE","fallback_link":"https://outlook.office.com/meet/xyz-uvw-rst"}],"status":"ACTIVE","working_time_start":"09:00","working_time_end":1080,"working_days":["MONDAY","THURSDAY"],"time_zone":"Europe/Lisbon","topic_type":"MANUAL_INPUT"},"account_id":"5fce39cfe2f4600001d3f625","sub_topics":[{"name":"Mortgage Loans","meetings_duration":60,"members":[{"name":"Joe","email":"joe@mail.com","provider":"GOOGLE","status":"PENDING","fallback_link":"https://meet.google.com/abc-defg-hij"}],"status":"PENDING","working_time_start":"09:00","working_time_end":1080,"working_days":["MONDAY","SUNDAY"],"time_zone":"Europe/Lisbon","topic_type":"MANUAL_INPUT"},{"name":"Car Loans","meetings_duration":30,"members":[{"name":"Bob","email":"bob@mail.com","provider":"OUTLOOK","status":"ACTIVE","fallback_link":"https://outlook.office.com/meet/xyz-uvw-rst"}],"status":"ACTIVE","working_time_start":"09:00","working_time_end":1080,"working_days":["MONDAY","FRIDAY"],"time_zone":"Europe/Lisbon","topic_type":"MANUAL_INPUT"}]},{"id":"630cf527257249351c204bd5","topic":{"name":"Second team","meetings_duration":30,"members":[{"name":"Joe","email":"joe@mail.com","provider":"GOOGLE","status":"PENDING","fallback_link":"https://meet.google.com/abc-defg-hij"},{"name":"Bob","email":"bob@mail.com","provider":"OUTLOOK","status":"ACTIVE","fallback_link":"https://outlook.office.com/meet/xyz-uvw-rst"}],"status":"PENDING","working_time_start":"09:00","working_time_end":1080,"working_days":["MONDAY","THURSDAY"],"time_zone":"Europe/Lisbon","topic_type":"DIRECTORY_LINKED"},"account_id":"5fce39cfe2f4600001d3f625","sub_topics":[{"name":"Mortgage Loans","meetings_duration":60,"members":[{"name":"Joe","email":"joe@mail.com","provider":"GOOGLE","status":"PENDING","fallback_link":"https://meet.google.com/abc-defg-hij"}],"status":"PENDING","working_time_start":"09:00","working_time_end":1080,"working_days":["MONDAY","SUNDAY"],"time_zone":"Europe/Lisbon","topic_type":"DIRECTORY_LINKED"},{"name":"Car Loans","meetings_duration":30,"members":[{"name":"Bob","email":"bob@mail.com","provider":"OUTLOOK","status":"ACTIVE","fallback_link":"https://outlook.office.com/meet/xyz-uvw-rst"}],"status":"PENDING","working_time_start":"09:00","working_time_end":1080,"working_days":["MONDAY","FRIDAY"],"time_zone":"Europe/Lisbon","topic_type":"DIRECTORY_LINKED"}]}]},"_links":{"self":{"href":"https://api.talkdeskapp.com/industries-scheduler/teams/"},"next":{"href":"https://api.talkdeskapp.com/industries-scheduler/teams/?page=1&per_page=10"},"prev":{"href":"https://api.talkdeskapp.com/industries-scheduler/teams/?page=-1&per_page=10"},"first":{"href":"https://api.talkdeskapp.com/industries-scheduler/teams/?page=1&per_page=10"},"last":{"href":"https://api.talkdeskapp.com/industries-scheduler/teams/?page=1&per_page=10"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3224000","message":"Bad request"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3224010","message":"Unauthorized."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3224030","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3224040","message":"Resource not found."}}}}}}},"/industries-scheduler/availabilities":{"post":{"tags":["Industries Scheduler"],"description":"Get availabilities of one or more emails","security":[{"GA":["industries-scheduler-availabilities:read"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["team_members","meeting_duration","working_time"],"properties":{"team_members":{"type":"array","description":"List of emails to retrieve the availabilities.","items":{"type":"object","required":["address","provided"],"properties":{"address":{"type":"string","description":"The email","minimum":1,"maximum":50},"provider":{"type":"string","description":"Team member email provider","enum":["GOOGLE","OUTLOOK"]}}}},"meeting_duration":{"type":"string","description":"The meeting duration in minutes","minimum":1,"maximum":500},"working_time":{"type":"array","description":"List of working times. The availabilities returned are included in these working times.","items":{"type":"object","required":["start","end"],"properties":{"start":{"type":"number","description":"Start unix epoch time in seconds"},"end":{"type":"number","description":"End unix epoch time in seconds"}}}}}},"example":{"team_members":[{"address":"joe@mail.com","provider":"GOOGLE"},{"address":"bob@mail.com","provider":"OUTLOOK"}],"meeting_duration":25,"working_time":[{"start":1673514000,"end":1673524800},{"start":1673532000,"end":1673550000}]}}}},"responses":{"200":{"description":"Availabilities response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","required":["id","calendar_id","free_time_periods"],"properties":{"id":{"type":"string","description":"id"},"calendar_id":{"type":"string","description":"The user email"},"free_time_periods":{"type":"array","items":{"type":"object","required":["start","end"],"properties":{"start":{"type":"number","description":"Start free availability unix epoch time in milliseconds"},"end":{"type":"number","description":"End free availability unix epoch time in milliseconds"}}}}}}},"example":[{"calendar_id":"joe@mail.com","free_time_periods":[{"start":1673515800000,"end":1673517600000},{"start":1673518500000,"end":1673520300000},{"start":1673523300000,"end":1673524800000},{"start":1673532000000,"end":1673542800000},{"start":1673546400000,"end":1673550000000}]},{"calendar_id":"bob@mail.com","free_time_periods":[{"start":1673515800000,"end":1673517600000},{"start":1673518500000,"end":1673520300000},{"start":1673523300000,"end":1673524800000},{"start":1673532000000,"end":1673542800000},{"start":1673546400000,"end":1673550000000}]}]}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3224000","message":"Bad request"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3224010","message":"Unauthorized."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3224030","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3224040","message":"Resource not found."}}}}}}},"/industries-scheduler/appointment":{"get":{"tags":["Industries Scheduler"],"description":"Get appointments associated to an account","security":[{"GA":["industries-scheduler-appointment:read"]}],"parameters":[{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer","default":0,"minimum":0,"maximum":99}},{"name":"size","in":"query","description":"Page size","required":false,"schema":{"type":"integer","default":10,"minimum":1,"maximum":250}}],"responses":{"200":{"description":"Appointments details","content":{"application/json":{"schema":{"type":"object","required":["_embedded","total_pages","total","count","page","per_page","_links"],"properties":{"_embedded":{"type":"object","description":"The embedded object","properties":{"teams":{"type":"array","items":{"type":"object","required":["id","account_id","team_member","calendar_event_id","start","end","team_id","conference_link"],"properties":{"id":{"type":"string","description":"The appointment ID.","minLength":1,"maxLength":50},"account_id":{"type":"string","description":"The account ID associated with the team.","minLength":1,"maxLength":50},"team_member":{"description":"The team member information.","type":"object","properties":{"name":{"type":"string","description":"The name of the team member.","minLength":1,"maxLength":50},"email":{"type":"string","format":"email","description":"The email address of the team member.","minLength":1,"maxLength":50},"status":{"type":"string","enum":["ACTIVE","PENDING"],"description":"The status of the team member.","minLength":1,"maxLength":50},"provider":{"type":"string","enum":["OUTLOOK","GOOGLE"],"description":"The email provider used by the team member's email address.","minLength":1,"maxLength":50},"fallback_link":{"type":"string","description":"The default long-term meeting link of the specialist.","minLength":1,"maxLength":512}}},"calendar_event_id":{"type":"string","description":"The calendar event ID.","minLength":1,"maxLength":50},"start":{"type":"integer","format":"integer","description":"The start time of the appointment in UTC timestamp (milliseconds).","minLength":1,"maxLength":50},"end":{"type":"integer","format":"integer","description":"The end time of the appointment in UTC timestamp (milliseconds).","minLength":1,"maxLength":50},"team_id":{"type":"string","description":"The ID of the team associated with the appointment.","minLength":1,"maxLength":50},"client_name":{"type":"string","description":"The name of the client associated with the appointment.","minLength":1,"maxLength":50},"client_email":{"type":"string","description":"The email of the client associated with the appointment.","minLength":1,"maxLength":50},"notes":{"type":"string","description":"The notes associated with the appointment.","minLength":1,"maxLength":50},"contact_id":{"type":"string","description":"The contact id with the appointment.","minLength":1,"maxLength":50},"external_contact_id":{"type":"string","description":"The contact id with the appointment.","minLength":1,"maxLength":50},"industry":{"type":"string","description":"The contact id with the appointment.","minLength":1,"maxLength":50,"enum":["none","fs-banking","fs-insurance","hls-providers","erc_retail"],"default":"fs-banking"},"interaction_id":{"type":"string","description":"The interaction ID associated with the appointment.","minLength":1,"maxLength":50},"create_at":{"type":"string","format":"date-time","description":"The create time of with the appointment.","minLength":1,"maxLength":50},"reschedule_count":{"type":"integer","description":"The reschedule count of the appointment.","minLength":1,"maxLength":50},"conference_link":{"type":"string","description":"The conference link associated with the appointment.","minLength":1,"maxLength":512},"conference_link_type":{"type":"string","enum":["AUTO_GENERATED_LINK","FALL_BACK_LINK","CUSTOM_DEFINE_LINK","NO_LINK"],"description":"The type of conference link to be generated for the appointment, default NO_LINK.","minLength":1,"maxLength":20}}}}}},"total_pages":{"type":"integer","description":"The total pages present","minLength":1,"maxLength":50},"total":{"type":"integer","description":"The number of teams","minLength":1,"maxLength":50},"count":{"type":"integer","description":"The count","minLength":1,"maxLength":50},"page":{"type":"integer","description":"Page number","minLength":1,"maxLength":50},"per_page":{"type":"integer","description":"Page size","minLength":1,"maxLength":50},"_links":{"type":"object","required":["self","next","prev","first","last"],"properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}},"next":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}},"prev":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}},"first":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}},"last":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}}}}}},"example":{"_embedded":{"teams":[{"id":"654321","account_id":"123456","team_member":{"name":"John Doe","email":"john.doe@gmail.com","status":"ACTIVE","provider":"GOOGLE"},"calendar_event_id":"abc123","start":1678960800000,"end":1678964400000,"team_id":"0b1a2c"},{"id":"123456","account_id":"123456","team_member":{"name":"Steve Smith","email":"steve.smith@gmail.com","status":"ACTIVE","provider":"GOOGLE"},"calendar_event_id":"123abc","start":1680163200000,"end":1680165000000,"team_id":"0b1a2c","client_name":"John Doe","client_email":"john.doe@gmail.com","notes":"Be on time","interaction_id":"12352e9032e431d841743","create_at":"2023-03-15T10:00:00Z","reschedule_count":1,"conference_link":"https://meet.google.com/abc-defg-hij"}]},"_links":{"self":{"href":"https://api.talkdeskapp.com/industries-scheduler/appointment/"},"next":{"href":"https://api.talkdeskapp.com/industries-scheduler/appointment/?page=1&per_page=10"},"prev":{"href":"https://api.talkdeskapp.com/industries-scheduler/appointment/?page=-1&per_page=10"},"first":{"href":"https://api.talkdeskapp.com/industries-scheduler/appointment/?page=1&per_page=10"},"last":{"href":"https://api.talkdeskapp.com/industries-scheduler/appointment/?page=1&per_page=10"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3224000","message":"Bad request"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3224010","message":"Unauthorized."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3224030","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3224040","message":"Resource not found."}}}}}},"post":{"tags":["Industries Scheduler"],"description":"Create calendar event and notify using SMS","security":[{"GA":["industries-scheduler-appointment:write"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["member_email","start","meting_duration","team_id","sms_notification","client_name","client_email"],"properties":{"member_email":{"description":"The team member email information.","type":"object","properties":{"address":{"type":"string","format":"email","description":"The email address.","minLength":1,"maxLength":50},"provider":{"type":"string","enum":["OUTLOOK","GOOGLE"],"description":"The email provider used by the email address.","minLength":1,"maxLength":50}},"required":["address","provider"]},"start":{"type":"string","format":"date-time","description":"Meeting start unix epoch time in seconds","minLength":1,"maxLength":50},"meeting_duration":{"type":"integer","minimum":0,"maximum":500,"description":"The duration of the appointment in minutes."},"team_id":{"type":"string","description":"The ID of the team associated with the appointment.","minLength":1,"maxLength":50},"sms_notification":{"description":"The SMS notification information.","type":"object","properties":{"body":{"type":"string","description":"The body of the SMS notification.","minLength":1,"maxLength":500},"talkdesk_phone_number":{"type":"string","description":"The Talkdesk phone number used to send the SMS notification.","minLength":1,"maxLength":20},"contact_phone_number":{"type":"string","description":"The contact phone number that will receive the SMS notification.","minLength":1,"maxLength":20}},"required":["body","talkdesk_phone_number","contact_phone_number"]},"contact_id":{"type":"string","description":"The contact id with the appointment.","minLength":1,"maxLength":50},"external_contact_id":{"type":"string","description":"The contact id with the appointment.","minLength":1,"maxLength":50},"industry":{"type":"string","description":"The contact id with the appointment.","minLength":1,"maxLength":50,"enum":["none","fs-banking","fs-insurance","hls-providers","erc_retail"],"default":"fs-banking"},"client_name":{"type":"string","description":"The name of the client associated with the appointment.","minLength":1,"maxLength":50},"client_email":{"type":"string","description":"The email of the client associated with the appointment.","minLength":1,"maxLength":50},"notes":{"type":"string","description":"The notes associated with the appointment.","minLength":1,"maxLength":50},"interaction_id":{"type":"string","description":"The interaction ID associated with the appointment.","minLength":1,"maxLength":50},"conference_link_type":{"type":"string","enum":["AUTO_GENERATED_LINK","FALL_BACK_LINK","CUSTOM_DEFINE_LINK","NO_LINK"],"description":"The type of conference link to be generated for the appointment, default NO_LINK.","minLength":1,"maxLength":20},"conference_link":{"type":"string","description":"The custom link provided by the customers.","minLength":1,"maxLength":512},"location":{"type":"string","description":"The location of the appointment.","minLength":1,"maxLength":512},"service":{"type":"string","description":"The service of the appointment.","minLength":1,"maxLength":512},"visit_type":{"type":"string","description":"The visit type of the appointment.","minLength":1,"maxLength":512},"appointment_type":{"type":"string","description":"The appointment type of the appointment.","enum":["IN_PERSON","REMOTE"]}}},"example":{"member_email":{"address":"john.doe@gmail.com","provider":"GOOGLE"},"start":"1678960800","meeting_duration":60,"team_id":"0b1a2c","sms_notification":{"body":"Your meeting with John Doe is scheduled for tomorrow.","talkdesk_phone_number":"+14155552671","contact_phone_number":"+14155552672"},"contact_id":"contact_12345","external_contact_id":"external_contact_12345","industry":"fs-banking","client_name":"John Doe","client_email":"john.doe@gmail.com","notes":"Be on time","interaction_id":"12352e9032e431d841743","conference_link_type":"AUTO_GENERATED_LINK","conference_link":"https://meet.google.com/customers_custom_link","location":"123 Main St, Springfield","service":"General Consultation","visit_type":"Initial Visit","appointment_type":"REMOTE"}}}},"responses":{"200":{"description":"Appointment creation and sms notification sent successfully","content":{"application/json":{"schema":{"type":"object","required":["id","account_id","team_member","calendar_event_id","start","end","team_id","conference_link"],"properties":{"id":{"type":"string","description":"The appointment ID.","minLength":1,"maxLength":50},"account_id":{"type":"string","description":"The account ID associated with the team.","minLength":1,"maxLength":50},"team_member":{"description":"The team member information.","type":"object","properties":{"name":{"type":"string","description":"The name of the team member.","minLength":1,"maxLength":50},"email":{"type":"string","format":"email","description":"The email address of the team member.","minLength":1,"maxLength":50},"status":{"type":"string","enum":["ACTIVE","PENDING"],"description":"The status of the team member.","minLength":1,"maxLength":50},"provider":{"type":"string","enum":["OUTLOOK","GOOGLE"],"description":"The email provider used by the team member's email address.","minLength":1,"maxLength":50},"fallback_link":{"type":"string","description":"The default long-term meeting link of the specialist.","minLength":1,"maxLength":512}}},"calendar_event_id":{"type":"string","description":"The calendar event ID.","minLength":1,"maxLength":50},"start":{"type":"integer","format":"integer","description":"The start time of the appointment in UTC timestamp (milliseconds).","minLength":1,"maxLength":50},"end":{"type":"integer","format":"integer","description":"The end time of the appointment in UTC timestamp (milliseconds).","minLength":1,"maxLength":50},"team_id":{"type":"string","description":"The ID of the team associated with the appointment.","minLength":1,"maxLength":50},"client_name":{"type":"string","description":"The name of the client associated with the appointment.","minLength":1,"maxLength":50},"client_email":{"type":"string","description":"The email of the client associated with the appointment.","minLength":1,"maxLength":50},"notes":{"type":"string","description":"The notes associated with the appointment.","minLength":1,"maxLength":50},"contact_id":{"type":"string","description":"The contact id with the appointment.","minLength":1,"maxLength":50},"external_contact_id":{"type":"string","description":"The contact id with the appointment.","minLength":1,"maxLength":50},"industry":{"type":"string","description":"The contact id with the appointment.","minLength":1,"maxLength":50,"enum":["none","fs-banking","fs-insurance","hls-providers","erc_retail"],"default":"fs-banking"},"interaction_id":{"type":"string","description":"The interaction ID associated with the appointment.","minLength":1,"maxLength":50},"create_at":{"type":"string","format":"date-time","description":"The create time of with the appointment.","minLength":1,"maxLength":50},"reschedule_count":{"type":"integer","description":"The reschedule count of the appointment.","minLength":1,"maxLength":50},"conference_link":{"type":"string","description":"The conference link associated with the appointment.","minLength":1,"maxLength":512},"conference_link_type":{"type":"string","enum":["AUTO_GENERATED_LINK","FALL_BACK_LINK","CUSTOM_DEFINE_LINK","NO_LINK"],"description":"The type of conference link to be generated for the appointment, default NO_LINK.","minLength":1,"maxLength":20}}},"example":{"id":"654321","account_id":"123456","team_member":{"name":"John Doe","email":"john.doe@gmail.com","status":"ACTIVE","provider":"GOOGLE"},"calendar_event_id":"abc123","start":1678960800000,"end":1678964400000,"team_id":"0b1a2c","client_name":"John Doe","client_email":"john.doe@gmail.com","notes":"Be on time","contact_id":"contact_12345","external_contact_id":"external_contact_12345","industry":"fs-banking","interaction_id":"12352e9032e431d841743","create_at":"2023-03-15T10:00:00Z","reschedule_count":1,"conference_link":"https://meet.google.com/abc-defg-hij","conference_link_type":"AUTO_GENERATED_LINK"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3224000","message":"Bad request"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3224010","message":"Unauthorized."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3224030","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3224040","message":"Resource not found."}}}}}},"put":{"tags":["Industries Scheduler"],"description":"Update an appointment in scheduler by eventId and notify using SMS","security":[{"GA":["industries-scheduler-appointment:write"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["event_id","appointment_dto"],"properties":{"event_id":{"type":"string","description":"The existing event id","minLength":1,"maxLength":50},"appointment_dto":{"description":"The updated appointment details.","type":"object","required":["member_email","start","meting_duration","team_id","sms_notification","client_name","client_email"],"properties":{"member_email":{"description":"The team member email information.","type":"object","properties":{"address":{"type":"string","format":"email","description":"The email address.","minLength":1,"maxLength":50},"provider":{"type":"string","enum":["OUTLOOK","GOOGLE"],"description":"The email provider used by the email address.","minLength":1,"maxLength":50}},"required":["address","provider"]},"start":{"type":"string","format":"date-time","description":"Meeting start unix epoch time in seconds","minLength":1,"maxLength":50},"meeting_duration":{"type":"integer","minimum":0,"maximum":500,"description":"The duration of the appointment in minutes."},"team_id":{"type":"string","description":"The ID of the team associated with the appointment.","minLength":1,"maxLength":50},"sms_notification":{"description":"The SMS notification information.","type":"object","properties":{"body":{"type":"string","description":"The body of the SMS notification.","minLength":1,"maxLength":500},"talkdesk_phone_number":{"type":"string","description":"The Talkdesk phone number used to send the SMS notification.","minLength":1,"maxLength":20},"contact_phone_number":{"type":"string","description":"The contact phone number that will receive the SMS notification.","minLength":1,"maxLength":20}},"required":["body","talkdesk_phone_number","contact_phone_number"]},"contact_id":{"type":"string","description":"The contact id with the appointment.","minLength":1,"maxLength":50},"external_contact_id":{"type":"string","description":"The contact id with the appointment.","minLength":1,"maxLength":50},"industry":{"type":"string","description":"The contact id with the appointment.","minLength":1,"maxLength":50,"enum":["none","fs-banking","fs-insurance","hls-providers","erc_retail"],"default":"fs-banking"},"client_name":{"type":"string","description":"The name of the client associated with the appointment.","minLength":1,"maxLength":50},"client_email":{"type":"string","description":"The email of the client associated with the appointment.","minLength":1,"maxLength":50},"notes":{"type":"string","description":"The notes associated with the appointment.","minLength":1,"maxLength":50},"interaction_id":{"type":"string","description":"The interaction ID associated with the appointment.","minLength":1,"maxLength":50},"conference_link_type":{"type":"string","enum":["AUTO_GENERATED_LINK","FALL_BACK_LINK","CUSTOM_DEFINE_LINK","NO_LINK"],"description":"The type of conference link to be generated for the appointment, default NO_LINK.","minLength":1,"maxLength":20},"conference_link":{"type":"string","description":"The custom link provided by the customers.","minLength":1,"maxLength":512},"location":{"type":"string","description":"The location of the appointment.","minLength":1,"maxLength":512},"service":{"type":"string","description":"The service of the appointment.","minLength":1,"maxLength":512},"visit_type":{"type":"string","description":"The visit type of the appointment.","minLength":1,"maxLength":512},"appointment_type":{"type":"string","description":"The appointment type of the appointment.","enum":["IN_PERSON","REMOTE"]}}}}},"example":{"event_id":"event_id123","appointment_dto":{"member_email":{"address":"john.doe@gmail.com","provider":"GOOGLE"},"start":"1678960800","meeting_duration":60,"team_id":"0b1a2c","sms_notification":{"body":"Your meeting with John Doe is scheduled for tomorrow.","talkdesk_phone_number":"+14155552671","contact_phone_number":"+14155552672"},"client_name":"John Doe","client_email":"john.doe@gmail.com","notes":"Be on time","interactionId":"12352e9032e431d841743","conference_link_type":"AUTO_GENERATED_LINK","conference_link":"https://meet.google.com/customers_custom_link"}}}}},"responses":{"200":{"description":"Appointment update and sms notification sent successfully","content":{"application/json":{"schema":{"type":"object","required":["id","account_id","team_member","calendar_event_id","start","end","team_id","conference_link"],"properties":{"id":{"type":"string","description":"The appointment ID.","minLength":1,"maxLength":50},"account_id":{"type":"string","description":"The account ID associated with the team.","minLength":1,"maxLength":50},"team_member":{"description":"The team member information.","type":"object","properties":{"name":{"type":"string","description":"The name of the team member.","minLength":1,"maxLength":50},"email":{"type":"string","format":"email","description":"The email address of the team member.","minLength":1,"maxLength":50},"status":{"type":"string","enum":["ACTIVE","PENDING"],"description":"The status of the team member.","minLength":1,"maxLength":50},"provider":{"type":"string","enum":["OUTLOOK","GOOGLE"],"description":"The email provider used by the team member's email address.","minLength":1,"maxLength":50},"fallback_link":{"type":"string","description":"The default long-term meeting link of the specialist.","minLength":1,"maxLength":512}}},"calendar_event_id":{"type":"string","description":"The calendar event ID.","minLength":1,"maxLength":50},"start":{"type":"integer","format":"integer","description":"The start time of the appointment in UTC timestamp (milliseconds).","minLength":1,"maxLength":50},"end":{"type":"integer","format":"integer","description":"The end time of the appointment in UTC timestamp (milliseconds).","minLength":1,"maxLength":50},"team_id":{"type":"string","description":"The ID of the team associated with the appointment.","minLength":1,"maxLength":50},"client_name":{"type":"string","description":"The name of the client associated with the appointment.","minLength":1,"maxLength":50},"client_email":{"type":"string","description":"The email of the client associated with the appointment.","minLength":1,"maxLength":50},"notes":{"type":"string","description":"The notes associated with the appointment.","minLength":1,"maxLength":50},"contact_id":{"type":"string","description":"The contact id with the appointment.","minLength":1,"maxLength":50},"external_contact_id":{"type":"string","description":"The contact id with the appointment.","minLength":1,"maxLength":50},"industry":{"type":"string","description":"The contact id with the appointment.","minLength":1,"maxLength":50,"enum":["none","fs-banking","fs-insurance","hls-providers","erc_retail"],"default":"fs-banking"},"interaction_id":{"type":"string","description":"The interaction ID associated with the appointment.","minLength":1,"maxLength":50},"create_at":{"type":"string","format":"date-time","description":"The create time of with the appointment.","minLength":1,"maxLength":50},"reschedule_count":{"type":"integer","description":"The reschedule count of the appointment.","minLength":1,"maxLength":50},"conference_link":{"type":"string","description":"The conference link associated with the appointment.","minLength":1,"maxLength":512},"conference_link_type":{"type":"string","enum":["AUTO_GENERATED_LINK","FALL_BACK_LINK","CUSTOM_DEFINE_LINK","NO_LINK"],"description":"The type of conference link to be generated for the appointment, default NO_LINK.","minLength":1,"maxLength":20}}},"example":{"id":"654321","account_id":"123456","team_member":{"name":"John Doe","email":"john.doe@gmail.com","status":"ACTIVE","provider":"GOOGLE"},"calendar_event_id":"abc123","start":1678960800000,"end":1678964400000,"team_id":"0b1a2c","client_name":"John Doe","client_email":"john.doe@gmail.com","notes":"Be on time","contact_id":"contact_12345","external_contact_id":"external_contact_12345","industry":"fs-banking","interaction_id":"12352e9032e431d841743","create_at":"2023-03-15T10:00:00Z","reschedule_count":1,"conference_link":"https://meet.google.com/abc-defg-hij","conference_link_type":"AUTO_GENERATED_LINK"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3224000","message":"Bad request"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3224010","message":"Unauthorized."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3224030","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3224040","message":"Resource not found."}}}}}}},"/industries-scheduler/appointment/cancel":{"post":{"tags":["Industries Scheduler"],"description":"Delete an appointment in scheduler by eventId","security":[{"GA":["industries-scheduler-appointment:write"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["event_id","sms_notification"],"properties":{"event_id":{"type":"string","description":"The event id","minLength":1,"maxLength":50},"sms_notification":{"description":"The SMS notification information.","type":"object","properties":{"body":{"type":"string","description":"The body of the SMS notification.","minLength":1,"maxLength":500},"talkdesk_phone_number":{"type":"string","description":"The Talkdesk phone number used to send the SMS notification.","minLength":1,"maxLength":20},"contact_phone_number":{"type":"string","description":"The contact phone number that will receive the SMS notification.","minLength":1,"maxLength":20}},"required":["body","talkdesk_phone_number","contact_phone_number"]},"interaction_id":{"type":"string","description":"The interaction ID associated with the appointment.","minLength":1,"maxLength":50},"cancellation_reason":{"type":"string","description":"The cancellation reason for the appointment.","minLength":1,"maxLength":2000}}},"example":{"event_id":"event_id123","sms_notification":{"body":"Your meeting with John Doe was cancelled","talkdesk_phone_number":"+14155552671","contact_phone_number":"+14155552672"},"interaction_id":"12352e9032e431d841743","cancellation_reason":"Client cancelled the meeting"}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3224000","message":"Bad request"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3224010","message":"Unauthorized."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3224030","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3224040","message":"Resource not found."}}}}}}},"/industries-messaging-service/messages":{"post":{"tags":["Industries Messaging Service"],"summary":"Send Message","description":"Send Message","operationId":"send_message","security":[{"GA":["industries-messaging-service:write"]}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["body","contact_phone_number","talkdesk_phone_number"],"properties":{"interaction_id":{"type":"string","description":"Automated Notifications interaction id.","maxLength":32},"body":{"type":"string","description":"Content of the message.","maxLength":2000},"contact_phone_number":{"type":"string","description":"The phone number of the contact.","maxLength":22},"talkdesk_phone_number":{"type":"string","description":"The phone number of Talkdesk.","maxLength":22},"talkdesk_sender":{"type":"string","description":"The sender of Talkdesk (Phone number or Alpha Sender id).","maxLength":32},"origin":{"type":"string","description":"The origin of the message - CONTACT, AGENT, AN (automated notifications).","enum":["AN","AGENT","CONTACT"]},"platform_tid":{"type":"string","description":"Platform tid.","maxLength":32},"timestamp":{"type":"string","format":"datetime","description":"Time of the message."}}},"example":{"studio_interaction_id":"386970ea-7afd-11ed-a1eb-0242ac120002","body":"Hi. Your appointment is scheduled to August 14.","contact_phone_number":"+120255501730","talkdesk_phone_number":"+120255501280","talkdesk_sender":"AlphaSenderId","origin":"AN","platform_tid":"5df77aaa-7afd-11ed-a1eb-0242ac120002","timestamp":"2022-08-13T00:00:00Z"}}},"required":true},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Message id","maxLength":32}}},"example":{"id":"63371b84fe838755e07c5f70"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3714000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3714010","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3714030","message":"Required scopes are missing."}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3714040","message":"Resource not found."}}}}}}},"/industries-messaging-service/emails":{"post":{"tags":["Industries Messaging Service"],"summary":"Send Email","description":"Send Email","operationId":"send_email","security":[{"GA":["industries-messaging-service:write"]}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["subject","from","to","content"],"properties":{"subject":{"type":"string","description":"email subject","maxLength":2000},"from":{"required":["email"],"type":"object","properties":{"name":{"type":"string","maxLength":100},"email":{"type":"string","maxLength":100}},"description":"email and name"},"to":{"type":"array","description":"email send to","minItems":1,"maxItems":1000,"items":{"required":["email"],"type":"object","properties":{"name":{"type":"string","maxLength":100},"email":{"type":"string","maxLength":100}},"description":"email and name"}},"content":{"type":"string","description":"content of email","maxLength":100000}}},"example":{"subject":"Hello","from":{"name":"from","email":"from@email.com"},"to":[{"name":"to","email":"to@email.com"}],"content":"how are you today"}}},"required":true},"responses":{"200":{"description":"Ok","content":{"text/plain":{"schema":{"type":"string","description":"email identifier"},"example":"asdah123uoawhd12321oawoudhauow"}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3714000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3714010","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3714030","message":"Required scopes are missing."}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3714040","message":"Resource not found."}}}}}}},"/interaction-custom-fields":{"post":{"x-namespace":"/interaction-custom-fields","description":"Publish interaction custom fields","security":[{"GA":["interaction-custom-fields:write"]}],"tags":["Reporting Custom Fields API"],"requestBody":{"description":"The interaction custom fields values","required":true,"content":{"application/json":{"schema":{"type":"object","description":"The request to populate interaction custom fields","properties":{"interaction_id":{"type":"string","description":"The interaction ID","minLength":1,"maxLength":100},"text_field_1":{"type":"string","description":"The text field 1","minLength":0,"maxLength":256},"text_field_2":{"type":"string","description":"The text field 2","minLength":0,"maxLength":256},"text_field_3":{"type":"string","description":"The text field 3","minLength":0,"maxLength":256},"text_field_4":{"type":"string","description":"The text field 4","minLength":0,"maxLength":256},"numeric_field_1":{"type":"integer","description":"The numeric field 1","minimum":-2147483648,"maximum":2147483647},"numeric_field_2":{"type":"integer","description":"The numeric field 2","minimum":-2147483648,"maximum":2147483647},"numeric_field_3":{"type":"number","description":"The numeric field 3","format":"float"},"numeric_field_4":{"type":"number","description":"The numeric field 4","format":"float"},"timestamp_field_1":{"type":"string","description":"The timestamp field 1","format":"date-time","maxLength":19}},"required":["interactionId"]},"example":{"interaction_id":"interaction_id","text_field_1":"text field 1","text_field_2":null,"text_field_3":null,"text_field_4":"text field 4","numeric_field_1":1,"numeric_field_2":2,"numeric_field_3":3.12,"numeric_field_4":4.5,"timestamp_field_1":"2021-01-01T00:00:00"}}}},"responses":{"204":{"description":"OK response"},"400":{"description":"Bad request - Request body is not valid.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"The error code"},"message":{"type":"string","description":"The error message"}},"required":["code","message"]},"example":{"code":"2410001","message":"Request body is not a valid format. Please check if there are missing fields or incorrect types."}}}},"401":{"description":"The request is not authorized.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"The error code"},"message":{"type":"string","description":"The error message"}},"required":["code","message"]},"example":{"code":"2410100","message":"Unauthorized"}}}},"403":{"description":"The request is not authorized - Either insufficient scopes or insufficient user permissions.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"The error code"},"message":{"type":"string","description":"The error message"}},"required":["code","message"]},"example":{"code":"2410101","message":"Forbidden"}}}},"500":{"description":"An unexpected error has occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"The error code"},"message":{"type":"string","description":"The error message"}},"required":["code","message"]},"example":{"code":"2410000","message":"Internal server error"}}}}}}},"/knowledge-management/external-sources":{"get":{"operationId":"SearchExternalSources","summary":"Search external sources","description":"Searches the list of external sources according to the specified filters.","parameters":[{"description":"The requested page.","example":1,"in":"query","name":"page","schema":{"type":"integer","default":1,"minimum":1,"maximum":10737419}},{"description":"The maximum amount of items to be returned per page.","example":50,"in":"query","name":"per_page","schema":{"type":"integer","default":50,"minimum":1,"maximum":200}},{"description":"The search query used to filter the external sources name.","in":"query","name":"query_by_name","schema":{"type":"string","minLength":0,"maxLength":2147483647}},{"description":"One or more key-value pairs in the form of `key:value` to filter external sources by their metadata. The `:value` part is optional. If omitted, the server will search for external sources where the value for the specified metadata key is `null` or undefined.\n","in":"query","name":"metadata","schema":{"type":"array","example":["third_party_id:ded93bd5-d854-4078-839a-9ef5779865a5"],"items":{"type":"string","minLength":0,"maxLength":2147483647}}}],"responses":{"200":{"content":{"application/json":{"schema":{"description":"A list of external sources.","properties":{"_embedded":{"description":"Contains the list of external sources.","properties":{"knowledge_bases":{"description":"List of external sources.","items":{"description":"An external source.","readOnly":true,"type":"object","properties":{"details":{"description":"Specific details of the external source.","properties":{"description":{"description":"The description of the external source.","example":"This is a description.","type":"string"},"knowledge_type":{"description":"The type of the external source.","enum":["CUSTOM"],"example":"CUSTOM","type":"string","maxLength":255},"name":{"description":"The name of the external source.","example":"External source XPTO.","type":"string"},"knowledge_segments":{"description":"The knowledge segments of the external source, separated by commas.","example":"sales,vip","type":"string"},"ring_groups":{"description":"The ring groups associated with the external source.","type":"array","example":["agents"],"items":{"type":"string"}},"metadata":{"description":"A set of arbitrary key-value pairs with additional data about the external source.","type":"object","additionalProperties":{"type":"string","minLength":0,"maxLength":2147483647},"example":{"third_party_id":"ded93bd5-d854-4078-839a-9ef5779865a5","source":"Custom External"}}},"type":"object"},"id":{"description":"The id of the external source.","example":"486d70ae-62ad-4115-a1fd-39ceb87aaa5d","type":"string"},"enabled":{"description":"Determines if the data source should be indexed or not.","type":"boolean"}}},"type":"array"}},"type":"object"},"count":{"description":"Number of external sources present in the page.","type":"integer"},"page":{"description":"Page number.","type":"integer"},"per_page":{"description":"Max number of external sources per page.","type":"integer"},"total":{"description":"Total number of external sources.","type":"integer"}},"type":"object"}}},"description":"List of external sources."},"400":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}}}},"description":"Bad Request."},"401":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}}}},"description":"Unauthorized access - invalid or unverifiable JWT."},"403":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}}}},"description":"Forbidden access - can't find the required scope in the JWT."},"500":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}}}},"description":"Internal Server Error."}},"security":[{"EarlyAccess":["km-external-sources:read"]}],"tags":["Knowledge Management"]},"post":{"operationId":"CreateExternalSource","summary":"Create external source","description":"Creates a new external source with the required information to extract articles from the specified source.","requestBody":{"content":{"application/json":{"schema":{"description":"The external source to create.","properties":{"details":{"description":"Specific details of the external source.","properties":{"description":{"description":"The description of the external source.","example":"This is a description.","type":"string","minLength":1,"maxLength":160,"pattern":"\\S+"},"knowledge_type":{"description":"The type of the external source.","enum":["CUSTOM"],"example":"CUSTOM","type":"string","maxLength":255},"name":{"description":"The name of the external source.","example":"External source XPTO.","type":"string","minLength":1,"maxLength":64,"pattern":"\\S+"},"knowledge_segments":{"description":"The knowledge segments of the external source, separated by commas.","example":"sales,vip","minLength":1,"maxLength":1024,"type":"string"},"ring_groups":{"description":"The ring groups associated with the external source.","type":"array","example":["agents"],"maxItems":10,"items":{"type":"string","maxLength":255}},"metadata":{"description":"A set of arbitrary key-value pairs with additional data about the external source.","type":"object","additionalProperties":{"type":"string","minLength":0,"maxLength":2147483647},"example":{"third_party_id":"ded93bd5-d854-4078-839a-9ef5779865a5","source":"Custom External"}}},"required":["name","description","knowledge_type"],"type":"object"},"enabled":{"description":"Determines if the data source should be indexed or not.","type":"boolean"}},"required":["enabled","details"],"type":"object"}}},"description":"The external source to create.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"description":"An external source.","properties":{"details":{"description":"Specific details of the external source.","properties":{"description":{"description":"The description of the external source.","example":"This is a description.","type":"string"},"knowledge_type":{"description":"The type of the external source.","enum":["CUSTOM"],"example":"CUSTOM","type":"string","maxLength":255},"name":{"description":"The name of the external source.","example":"External source XPTO.","type":"string"},"knowledge_segments":{"description":"The knowledge segments of the external source, separated by commas.","example":"sales,vip","type":"string"},"ring_groups":{"description":"The ring groups associated with the external source.","type":"array","example":["agents"],"items":{"type":"string"}},"metadata":{"description":"A set of arbitrary key-value pairs with additional data about the external source.","type":"object","additionalProperties":{"type":"string","minLength":0,"maxLength":2147483647},"example":{"third_party_id":"ded93bd5-d854-4078-839a-9ef5779865a5","source":"Custom External"}}},"type":"object"},"id":{"description":"The id of the external source.","example":"486d70ae-62ad-4115-a1fd-39ceb87aaa5d","type":"string"},"enabled":{"description":"Determines if the data source should be indexed or not.","type":"boolean"}},"type":"object"}}},"description":"The created external source."},"400":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}}}},"description":"Bad Request."},"401":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}}}},"description":"Unauthorized access - invalid or unverifiable JWT."},"403":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}}}},"description":"Forbidden access - can't find the required scope in the JWT."},"500":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}}}},"description":"Internal Server Error."}},"security":[{"EarlyAccess":["km-external-sources:write"]}],"tags":["Knowledge Management"]}},"/knowledge-management/external-sources/{external_source_id}":{"delete":{"operationId":"DeleteExternalSource","summary":"Delete external source","description":"Deletes the specified external source.","parameters":[{"description":"The external source id.","example":"128285ea-1978-42c4-99a4-ed54527011b6","in":"path","name":"external_source_id","required":true,"schema":{"type":"string","minLength":36,"maxLength":36}}],"responses":{"204":{"description":"External source successfully deleted."},"401":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}}}},"description":"Unauthorized access - invalid or unverifiable JWT."},"403":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}}}},"description":"Forbidden access - can't find the required scope in the JWT."},"404":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}}}},"description":"Object Not Found."},"409":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1040404","message":"The requested operation cannot be performed in the current state of the knowledge base."}}},"description":"Conflict - The resource is in a state that prevents the operation."},"500":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}}}},"description":"Internal Server Error."}},"security":[{"EarlyAccess":["km-external-sources:write"]}],"tags":["Knowledge Management"]},"get":{"operationId":"GetExternalSource","summary":"Get external source","description":"Retrieves the details of the specified external source.","parameters":[{"description":"The external source id.","example":"128285ea-1978-42c4-99a4-ed54527011b6","in":"path","name":"external_source_id","required":true,"schema":{"type":"string","minLength":36,"maxLength":36}}],"responses":{"200":{"content":{"application/json":{"schema":{"description":"An external source.","properties":{"details":{"description":"Specific details of the external source.","properties":{"description":{"description":"The description of the external source.","example":"This is a description.","type":"string"},"knowledge_type":{"description":"The type of the external source.","enum":["CUSTOM"],"example":"CUSTOM","type":"string","maxLength":255},"name":{"description":"The name of the external source.","example":"External source XPTO.","type":"string"},"knowledge_segments":{"description":"The knowledge segments of the external source, separated by commas.","example":"sales,vip","type":"string"},"ring_groups":{"description":"The ring groups associated with the external source.","type":"array","example":["agents"],"items":{"type":"string"}},"metadata":{"description":"A set of arbitrary key-value pairs with additional data about the external source.","type":"object","additionalProperties":{"type":"string","minLength":0,"maxLength":2147483647},"example":{"third_party_id":"ded93bd5-d854-4078-839a-9ef5779865a5","source":"Custom External"}}},"type":"object"},"id":{"description":"The id of the external source.","example":"486d70ae-62ad-4115-a1fd-39ceb87aaa5d","type":"string"},"enabled":{"description":"Determines if the data source should be indexed or not.","type":"boolean"}},"type":"object"}}},"description":"The details of the specified external source."},"401":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}}}},"description":"Unauthorized access - invalid or unverifiable JWT."},"403":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}}}},"description":"Forbidden access - can't find the required scope in the JWT."},"404":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}}}},"description":"Object Not Found."},"500":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}}}},"description":"Internal Server Error."}},"security":[{"EarlyAccess":["km-external-sources:read"]}],"tags":["Knowledge Management"]},"put":{"operationId":"UpdateExternalSource","summary":"Update external source.","description":"Updates the specified external source.","parameters":[{"description":"The external source id.","example":"128285ea-1978-42c4-99a4-ed54527011b6","in":"path","name":"external_source_id","required":true,"schema":{"type":"string","minLength":36,"maxLength":36}}],"requestBody":{"content":{"application/json":{"schema":{"description":"Specific details of the external source.","properties":{"description":{"description":"The description of the external source.","example":"This is a description.","type":"string","minLength":1,"maxLength":160,"pattern":"\\S+"},"knowledge_type":{"description":"The type of the external source.","enum":["CUSTOM"],"example":"CUSTOM","type":"string","maxLength":255},"name":{"description":"The name of the external source.","example":"External source XPTO.","type":"string","minLength":1,"maxLength":64,"pattern":"\\S+"},"knowledge_segments":{"description":"The knowledge segments of the external source, separated by commas.","example":"sales,vip","minLength":1,"maxLength":1024,"type":"string"},"ring_groups":{"description":"The ring groups associated with the external source.","type":"array","example":["agents"],"maxItems":10,"items":{"type":"string","maxLength":255}},"metadata":{"description":"A set of arbitrary key-value pairs with additional data about the external source.","type":"object","additionalProperties":{"type":"string","minLength":0,"maxLength":2147483647},"example":{"third_party_id":"ded93bd5-d854-4078-839a-9ef5779865a5","source":"Custom External"}}},"required":["name","description","knowledge_type"],"type":"object"}}},"description":"The updated external source details.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"description":"An external source.","properties":{"details":{"description":"Specific details of the external source.","properties":{"description":{"description":"The description of the external source.","example":"This is a description.","type":"string"},"knowledge_type":{"description":"The type of the external source.","enum":["CUSTOM"],"example":"CUSTOM","type":"string","maxLength":255},"name":{"description":"The name of the external source.","example":"External source XPTO.","type":"string"},"knowledge_segments":{"description":"The knowledge segments of the external source, separated by commas.","example":"sales,vip","type":"string"},"ring_groups":{"description":"The ring groups associated with the external source.","type":"array","example":["agents"],"items":{"type":"string"}},"metadata":{"description":"A set of arbitrary key-value pairs with additional data about the external source.","type":"object","additionalProperties":{"type":"string","minLength":0,"maxLength":2147483647},"example":{"third_party_id":"ded93bd5-d854-4078-839a-9ef5779865a5","source":"Custom External"}}},"type":"object"},"id":{"description":"The id of the external source.","example":"486d70ae-62ad-4115-a1fd-39ceb87aaa5d","type":"string"},"enabled":{"description":"Determines if the data source should be indexed or not.","type":"boolean"}},"type":"object"}}},"description":"The updated external source."},"400":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}}}},"description":"Bad Request."},"401":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}}}},"description":"Unauthorized access - invalid or unverifiable JWT."},"403":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}}}},"description":"Forbidden access - can't find the required scope in the JWT."},"404":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}}}},"description":"Object Not Found."},"409":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1040404","message":"The requested operation cannot be performed in the current state of the knowledge base."}}},"description":"Conflict - The resource is in a state that prevents the operation."},"500":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}}}},"description":"Internal Server Error."}},"security":[{"EarlyAccess":["km-external-sources:write"]}],"tags":["Knowledge Management"]}},"/knowledge-management/external-sources/{external_source_id}/documents/{doc_id}":{"put":{"operationId":"upsertKnowledgeManagementDocument","summary":"Upsert document","description":"Inserts a document into the specified external source if it doesn't contain a document with the specified `doc_id`; updates the specified document otherwise.\nNote: This operation is only valid for external sources of type `CUSTOM`. Attempts to perform it in other types of external sources are rejected with a `400 Bad Request` error.\n","parameters":[{"description":"The external source id.","example":"128285ea-1978-42c4-99a4-ed54527011b6","in":"path","name":"external_source_id","required":true,"schema":{"type":"string","minLength":36,"maxLength":36}},{"description":"The document id.","example":1,"in":"path","name":"doc_id","required":true,"schema":{"type":"string","minLength":1,"maxLength":255}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"A document to upsert in an external source.","properties":{"url":{"description":"The URL of the document.","type":"string","minLength":1,"pattern":"\\S+"},"title":{"description":"The title of the document.","type":"string","minLength":1,"pattern":"\\S+"},"content":{"description":"The content of the document, including HTML tags.","type":"string","minLength":1,"pattern":"\\S+"},"created_at":{"description":"The creation date of the document.","type":"string","format":"date-time","minLength":20},"updated_at":{"description":"The last update date of the document.","type":"string","format":"date-time","minLength":20},"metadata":{"description":"The metadata of the document.","type":"object"}},"required":["url","title","content","created_at"]}}},"description":"Document to be created or updated.","required":true},"responses":{"204":{"description":"Document successfully created/updated."},"400":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}}}},"description":"Unauthorized access - invalid or unverifiable JWT."},"403":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}}}},"description":"Forbidden access - can't find the required scope in the JWT."},"404":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}}}},"description":"Object Not Found."},"500":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}}}},"description":"Internal Server Error."}},"security":[{"EarlyAccess":["km-external-sources:write"]}],"tags":["Knowledge Management"]},"delete":{"operationId":"deleteKnowledgeManagementDocument","summary":"Delete document","description":"Deletes the document with the specified `doc_id` from the specified external source.\nNote: This operation is only valid for external sources of type `CUSTOM`. Attempts to perform it in other types of external sources are rejected with a `400 Bad Request` error.\n","parameters":[{"description":"The external source id.","example":"128285ea-1978-42c4-99a4-ed54527011b6","in":"path","name":"external_source_id","required":true,"schema":{"type":"string","minLength":36,"maxLength":36}},{"description":"The document id.","example":1,"in":"path","name":"doc_id","required":true,"schema":{"type":"string","minLength":1,"maxLength":255}}],"responses":{"204":{"description":"Document successfully deleted."},"400":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}}}},"description":"Unauthorized access - invalid or unverifiable JWT."},"403":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}}}},"description":"Forbidden access - can't find the required scope in the JWT."},"404":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}}}},"description":"Object Not Found."},"500":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}}}},"description":"Internal Server Error."}},"security":[{"EarlyAccess":["km-external-sources:write"]}],"tags":["Knowledge Management"]}},"/omnichannel/interactions/{resource_type}":{"delete":{"operationId":"interactions_elimination","tags":["Dce Tracking"],"summary":"Bulk delete resource of interaction by type and ids","description":"Bulk delete resource of interaction by type and ids","security":[{"EarlyAccess":["omnichannel:interaction-elimination"]}],"parameters":[{"name":"Authorization","in":"header","description":"Authorization header containing the JWT generated by API Gateway","required":true,"schema":{"type":"string"}},{"name":"resource_type","in":"path","description":"The type of the resource to be deleted, currently, only transcript is supported","required":true,"schema":{"type":"string","enum":["transcript"]}}],"requestBody":{"description":"The Request Body","required":true,"content":{"application/json":{"schema":{"required":["interaction_ids"],"type":"object","properties":{"interaction_ids":{"type":"array","description":"list of interaction ids","minItems":1,"maxItems":100,"items":{"type":"string","description":"interaction id","minLength":1,"maxLength":32}}}},"example":{"interaction_ids":["67bbe4ed01ef4b9999262ba7a3740044","67bbe4ed01ef4b9999262ba7a3740045"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"required":["id","has_errors","total_deleted","total_errors","errors"],"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":32,"description":"The ID of the request"},"has_errors":{"type":"boolean","description":"Indicates if there were any errors"},"errors":{"type":"array","items":{"type":"object","required":["interaction_id","code","message"],"properties":{"interaction_id":{"type":"string","minLength":1,"maxLength":32,"description":"The ID of the interaction that caused the error"},"code":{"type":"integer","description":"The error code"},"message":{"type":"string","description":"The detail error message"}}}},"total_deleted":{"type":"integer","description":"The total number of interaction resource deleted"},"total_errors":{"type":"integer","description":"The total number of errors"}}},"example":{"id":"8ec152c3faec44dfba096504938b5ed6","has_errors":true,"errors":[{"interaction_id":"67bbe4ed01ef4b9999262ba7a3740044","code":1540004,"message":"Interaction created less than 24 hours cannot be resolved"}],"total_deleted":1,"total_errors":1}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1000","message":"Invalid input parameters"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"0011003","message":"Unauthorized"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0000013","message":"Forbidden"}}}},"429":{"description":"API rate limit exceeded","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0012001","message":"API rate limit exceeded"}}}}}}},"/industries-settings/configurations/{service}/{type}/{type_id}/filter":{"get":{"tags":["Industries Settings"],"description":"Returns configurations for the provided service and roles.","summary":"Returns configurations for the provided service and roles.","security":[{"GA":["industries-settings-public:read"]}],"parameters":[{"name":"service","in":"path","required":true,"description":"The service regarding the configuration","schema":{"type":"string","minLength":0,"maxLength":255}},{"name":"type","in":"path","required":true,"description":"The type identifier","schema":{"type":"string","minLength":0,"maxLength":255}},{"name":"type_id","in":"path","required":true,"description":"The agent or ring_group identifier (required when type is not ACCOUNT)","schema":{"type":"string","minLength":0,"maxLength":255}},{"name":"rsa-private-key","in":"header","required":false,"description":"private key used to decypher the configuration encryption","schema":{"type":"string","minLength":0,"maxLength":255}},{"name":"keys","in":"query","required":false,"description":"The filter to apply to the configurations","schema":{"type":"array","items":{"type":"string","minLength":0,"maxLength":255}}}],"responses":{"200":{"description":"The configurations for the given service and type.","content":{"application/json":{"schema":{"type":"object","description":"This endpoint will gather all the configurations that match the given criteria, and group them on a map as key,pair values. The parameters below are just an example, and could be completely different for another service.","properties":{"id":{"type":"string","description":"an example Id.","minLength":0,"maxLength":255},"bank_url":{"type":"string","description":"the external banking system url.","minLength":0,"maxLength":255},"show_cobrowse_button":{"type":"boolean","description":"flag indicating wether the cobrowse button should be visible"}}},"example":{"id":"1","bank_url":"https://test.com","show_cobrowse_button":true}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3444000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3444010","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3444030","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3444040","message":"Resource not found."}}}},"405":{"description":"Method not supported","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3444050","message":"Request method not supported."}}}}}}},"/industries-settings/configurations/{service}/{type}/filter":{"get":{"tags":["Industries Settings"],"description":"Returns configurations for the provided service and roles.","summary":"Returns configurations for the provided service and roles.","security":[{"GA":["industries-settings-public:read"]}],"parameters":[{"name":"service","in":"path","required":true,"description":"The service regarding the configuration","schema":{"type":"string","minLength":0,"maxLength":255}},{"name":"type","in":"path","required":true,"description":"The type identifier","schema":{"type":"string","minLength":0,"maxLength":255}},{"name":"rsa-private-key","in":"header","required":false,"description":"private key used to decypher the configuration encryption","schema":{"type":"string","minLength":0,"maxLength":255}},{"name":"keys","in":"query","required":false,"description":"The filter to apply to the configurations","schema":{"type":"array","items":{"type":"string","minLength":0,"maxLength":255}}}],"responses":{"200":{"description":"The configurations for the given service and type.","content":{"application/json":{"schema":{"type":"object","description":"This endpoint will gather all the configurations that match the given criteria, and group them on a map as key,pair values. The parameters below are just an example, and could be completely different for another service.","properties":{"id":{"type":"string","description":"an example Id.","minLength":0,"maxLength":255},"bank_url":{"type":"string","description":"the external banking system url.","minLength":0,"maxLength":255},"show_cobrowse_button":{"type":"boolean","description":"flag indicating wether the cobrowse button should be visible"}}},"example":{"id":"1","bank_url":"https://test.com","show_cobrowse_button":true}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3444000","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3444010","message":"Invalid JWT."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3444030","message":"Required scopes are missing."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3444040","message":"Resource not found."}}}},"405":{"description":"Method not supported","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"3444050","message":"Request method not supported."}}}}}}},"/dialer-integrations/campaigns/{campaign_id}/contacts/{record_id}":{"get":{"x-namespace":"/dialer-integrations","description":"Get the campaign record information","summary":"Get the campaign record information","operationId":"GetCampaignRecord","tags":["Dialer Integrations"],"security":[{"GA":["dialer-integrations-records:read"]}],"parameters":[{"name":"campaign_id","in":"path","description":"The id of the campaign","required":true,"schema":{"type":"string","minLength":1,"maxLength":255,"example":"campaign_id"}},{"name":"record_id","in":"path","description":"The id of the record","required":true,"schema":{"type":"string","minLength":1,"maxLength":255,"example":"record_id"}}],"responses":{"200":{"description":"Success get the campaign record information","content":{"application/json":{"schema":{"type":"object","description":"The response of the campaign record information","properties":{"id":{"type":"string","description":"The id of the request","minLength":1,"maxLength":255},"campaign_id":{"type":"string","description":"The id of the campaign","minLength":1,"maxLength":255},"contact_name":{"type":"string","description":"The name of the contact","minLength":1,"maxLength":255},"campaign_records":{"type":"array","description":"The record information of the campaign","items":{"type":"object","properties":{"key":{"type":"string","description":"The key of the record information","minLength":1,"maxLength":255},"value":{"type":"string","description":"The value of the record information","minLength":1,"maxLength":255}},"required":["key","value"]}}},"required":["campaign_id","contact_name"]},"example":{"id":"uuid","campaign_id":"campaign_id","contact_name":"contact_name","campaign_records":[{"key":"contact_external_id","value":"external_id"},{"key":"contact_email","value":"email@company.com"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530900","message":"Bad request."}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530901","message":"Missing or invalid authentication token."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530902","message":"Insufficient scopes for the requested operation."}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0530910","message":"Resources not found."}}}}}}},"/locations-directory/bulk/{directory_type}":{"post":{"tags":["Locations Directory"],"summary":"Add (or update) a list of locations, services or staffs directories from a CSV file.","description":"Add (or update) a list of locations, services or staffs directories from a CSV file.","operationId":"publicUploadLocationsDirectory","security":[{"GA":["locations-directory-bulk-operation:write"]}],"parameters":[{"name":"directory_type","in":"path","description":"The directory type.","required":true,"schema":{"type":"string","minLength":1,"enum":["locations","services","staffs"],"example":"locations"}}],"requestBody":{"description":"CSV file content","required":true,"content":{"multipart/form-data":{"schema":{"type":"object","required":["file"],"properties":{"file":{"type":"string","format":"text/csv","description":"The file containing the rows to be upload at service directory List table.\nThe file must be a text file with text/csv content format and the allowed columns are:\n * SERVICE_ID\n - identifier of the service, will generate a random one if it empty\n * SERVICE_NAME\n - The name of the service, Any given string. It can include special chars.\n * SERVICE_TYPE\n - The type of the service, Any given string. It can include special chars.\n * DURATION\n - The duration of the service. Typically the time duration, number, etc.\n * DESCRIPTION\n - The DESCRIPTION the service\n * VIRTUAL_LOCATION_URL\n - The virtual_location_url of the service\n * PRICE\n - The price of the service.\n * PHONE_NUMBER\n - The phone number of the service, format should phoneNumber1:phoneNumberName1|phoneNumber2:phoneNumberName2\n * TIMEZONE\n - The time zone of the service, according to IANA.\n * BUSINESS_MON\n - Monday business hours. Example: 10:00AM-01:00PM | 02:00PM-08PM\n * BUSINESS_TUE\n - Tuesday business hours. Example: 10:00AM-01:00PM | 02:00PM-08PM\n * BUSINESS_WED\n - Wednesday business hours. Example: 10:00AM-01:00PM | 02:00PM-08PM\n * BUSINESS_THU\n - Thursday business hours. Example: 10:00AM-01:00PM | 02:00PM-08PM\n * BUSINESS_FRI\n - Friday business hours. Example: 10:00AM-01:00PM | 02:00PM-08PM\n * BUSINESS_SAT\n - Saturday business hours. Example: 10:00AM-01:00PM | 02:00PM-08PM\n * BUSINESS_SUN\n - Sunday business hours. Example: 10:00AM-01:00PM | 02:00PM-08PM\n * LOCATIONS\n - The location external ids of the service\n * SPECIAL_DATES\n - The special dates of the service in JSON format. Example: [{\"name\":\"special date\",\"date\":\"2025-03-20\",\"repeat_rule\":\"DOES_NOT_REPEATS\",\"business_hours\":[{\"open_at\":\"00:03:00\",\"close_at\":\"12:58:00\"}],\"notes\":\"\"}]\n"}}},"example":{"default":{"value":{"file":"SERVICE_ID,SERVICE_NAME,SERVICE_TYPE,DURATION,DESCRIPTION,VIRTUAL_LOCATION_URL,PRICE,PHONE_NUMBER,TIMEZONE,BUSINESS_MON,BUSINESS_TUE,BUSINESS_WED,BUSINESS_THU,BUSINESS_FRI,BUSINESS_SAT,BUSINESS_SUN,LOCATIONS,SPECIAL_DATES\n1,SERVICE_NAME2,SERVICE_TYPE2,DURATION2,DESCRIPTION2,URL,3$,+351 999 999 99:Home,Europe/Lisbon,12:00AM-11:59PM,,,,,,,1|2,\"[{\"\"name\"\":\"\"special date\"\",\"\"date\"\":\"\"2025-03-20\"\",\"\"repeat_rule\"\":\"\"MONTHLY\"\",\"\"business_hours\"\":[{\"\"open_at\"\":\"\"00:03:00\"\",\"\"close_at\"\":\"\"12:58:00\"\"}],\"\"notes\"\":\"\"\"\"}]\"\n"}}}}}},"responses":{"202":{"description":"The file has bean accepted and will be processed async by a task."},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"4034010","message":"Unauthorized."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"4034030","message":"Forbidden."}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"4035000","message":"Internal server error."}}}}}}},"/healthcare/patients/locations":{"get":{"tags":["HLS Providers"],"summary":"Get patient's last known location","description":"Get a list of patient's last known locations.\n","operationId":"getPatientLastLocation","security":[{"GA":["hls-patient-location:read"]}],"parameters":[{"name":"patient_id","in":"query","required":false,"description":"Patient ID","schema":{"type":"string","example":"abc","minLength":1,"maxLength":2147483647}},{"name":"external_id","in":"query","required":false,"description":"External ID","schema":{"type":"string","example":"external-123","minLength":1,"maxLength":2147483647}},{"name":"birth_date","in":"query","required":false,"description":"Patient's birth date","schema":{"type":"string","format":"date","example":"1990-01-15","minLength":1,"maxLength":2147483647}},{"name":"gender","in":"query","required":false,"description":"Gender","schema":{"type":"string","enum":["MALE","FEMALE","OTHER","UNKNOWN"],"example":"MALE"}},{"name":"last_name","in":"query","required":false,"description":"Patient's last name","schema":{"type":"string","example":"Doe","minLength":1,"maxLength":2147483647}},{"name":"first_name","in":"query","required":false,"description":"Patient's first name","schema":{"type":"string","example":"John","minLength":1,"maxLength":2147483647}},{"name":"mrn","in":"query","required":false,"description":"Patient's medical record number","schema":{"type":"string","example":"MRN123456","minLength":1,"maxLength":2147483647}},{"name":"ssn","in":"query","required":false,"description":"Patient's social security number","schema":{"type":"string","example":"123-45-6789","minLength":1,"maxLength":2147483647}},{"name":"zipcode","in":"query","required":false,"description":"Patient's zipcode","schema":{"type":"string","example":"12345","minLength":1,"maxLength":2147483647}},{"name":"page","in":"query","required":false,"description":"The page number to request","schema":{"type":"integer","example":1,"minimum":1,"maximum":2147483647,"default":1}},{"name":"per_page","in":"query","required":false,"description":"The maximum number of items per page","schema":{"type":"integer","example":5,"minimum":1,"maximum":50,"default":10}}],"responses":{"200":{"description":"A list of patient's last known locations","content":{"application/json":{"schema":{"type":"object","required":["count","total","page","per_page","total_pages","_links","_embedded"],"properties":{"count":{"type":"integer","description":"The number of results in the current page"},"total":{"type":"integer","description":"The total of results"},"page":{"type":"integer","description":"The current page"},"per_page":{"type":"integer","description":"The number of results per page"},"total_pages":{"type":"integer","description":"The total number of result pages"},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string"}}}}},"_embedded":{"type":"object","description":"List of patient last locations in current page","required":["patient_last_locations"],"properties":{"patient_last_locations":{"type":"array","items":{"type":"object","required":["id","external_id","location_id","admitted_date"],"properties":{"id":{"description":"Patient unique identifier (per account)","type":"string"},"external_id":{"description":"External patient unique identifier (per account)","type":"string"},"location_id":{"description":"Location identifier","type":"string"},"admitted_date":{"description":"Date when the patient was admitted to the location","type":"string"}}}}}}}},"example":{"count":2,"total":2,"page":1,"per_page":10,"total_pages":1,"_links":{"self":{"href":"https://api.talkdesk.com/healthcare/patients/locations?page=1&per_page=10"}},"_embedded":{"patient_last_locations":[{"id":"patient-123","external_id":"ext-123","location_id":"location-456","admitted_date":"2024-01-15T10:30:00Z"}]}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Generic Bad Request":{"value":{"code":"1484000","message":"Bad request."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"1484010","message":"Invalid JWT token."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Missing Scopes":{"value":{"code":"1484030","message":"Required scopes are missing."}}}}}}}}},"/healthcare/patients/{patient_id}/practices":{"get":{"tags":["HLS Providers"],"summary":"Get the appointment practices of a patient","description":"Get the appointment practices of a patient","operationId":"getPatientPractices","security":[{"GA":["hls-patient-practice:read"]}],"parameters":[{"name":"patient_id","in":"path","description":"The patient id","required":true,"schema":{"type":"string","example":"12724066"}},{"name":"page","in":"query","description":"The page number to request. Starts at 1, defaults to 1 when not provided.","required":false,"schema":{"type":"integer","example":1,"minimum":1,"maximum":2147483647,"default":1}},{"name":"per_page","in":"query","description":"The maximum number of items per page. Defaults to 5 when not provided.","required":false,"schema":{"type":"integer","example":5,"minimum":1,"maximum":50,"default":5}}],"responses":{"200":{"description":"OK","content":{"application/hal+json":{"schema":{"type":"object","required":["count","total","page","per_page","total_pages","_links","_embedded"],"properties":{"count":{"type":"integer","description":"The number of results in the current page"},"total":{"type":"integer","description":"The total of results"},"page":{"type":"integer","description":"The current page"},"per_page":{"type":"integer","description":"The number of results per page"},"total_pages":{"type":"integer","description":"The total number of result pages"},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string"}}}}},"_embedded":{"type":"object","description":"List of practices in current page","required":["practices"],"properties":{"practices":{"type":"array","items":{"type":"object","required":["id"],"properties":{"id":{"description":"The unique identifier for the practice","type":"string"},"name":{"description":"The name of the practice","type":"string"},"patient_id":{"description":"The patient identifier","type":"string"},"appointment_date_time":{"description":"The date and time of the appointment","type":"string","format":"date-time"}}}}}}}},"example":{"count":2,"total":2,"page":1,"per_page":5,"total_pages":1,"_links":{"self":{"href":"https://api.talkdesk.com/healthcare/patients/12724066/practices?page=1&per_page=5"}},"_embedded":{"practices":[{"id":"0004","name":"Main Street Clinic","patient_id":"12724066","appointment_date_time":"2024-01-15T10:00:00Z"},{"id":"0005","name":"Downtown Medical Center","patient_id":"12724066","appointment_date_time":"2024-02-20T14:30:00Z"}]}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Generic Bad Request":{"value":{"code":"1484000","message":"Bad request."}},"Upstream Bad Request":{"value":{"code":"1484001","message":"Bad Request in upstream."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"1484010","message":"Invalid JWT token."}},"No Upstream":{"value":{"code":"1484012","message":"No upstream selected."}},"Upstream Unauthorized":{"value":{"code":"1484014","message":"Unauthorized in upstream."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Missing Scopes":{"value":{"code":"1484030","message":"Required scopes are missing."}},"Account Forbidden":{"value":{"code":"1484031","message":"Account does not have access."}},"Upstream Forbidden":{"value":{"code":"1484032","message":"Forbidden in upstream."}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Not Found":{"value":{"code":"1484040","message":"Resource not found."}},"Upstream Not Found":{"value":{"code":"1484041","message":"Not Found in upstream."}}}}}}}}},"/healthcare/guarantors":{"get":{"tags":["HLS Providers"],"summary":"Get guarantor identifiers","description":"Returns identifiers that uniquely reference a guarantor in the upstream EHR.","operationId":"getGuarantorIdentifiers","security":[{"GA":["hls-guarantor:read"]}],"parameters":[{"name":"date_of_birth","in":"query","description":"Guarantor date of birth used to filter identifiers.","required":false,"schema":{"type":"string","format":"date","example":"1975-08-09"}},{"name":"ssn_last_four","in":"query","description":"Last four digits of the guarantor SSN used to refine the lookup.","required":false,"schema":{"type":"string","pattern":"^\\d{4}$","minLength":4,"maxLength":4,"example":"1234"}},{"name":"guarantor_id","in":"query","description":"Guarantor identifier used to resolve the guarantor in the upstream EHR.","required":true,"schema":{"type":"string","example":"1a2b3c4d-5678-90ab-cdef-1234567890ab"}},{"name":"page","in":"query","description":"The page number to request. Starts at 1, defaults to 1 when not provided.","required":false,"schema":{"type":"integer","example":1,"minimum":1,"maximum":2147483647,"default":1}},{"name":"per_page","in":"query","description":"The maximum number of items per page. Defaults to 25 when not provided.","required":false,"schema":{"type":"integer","example":25,"minimum":1,"maximum":50,"default":25}}],"responses":{"200":{"description":"Identifiers found. An empty `identifiers` array means the upstream returned no matches for the supplied filters.","content":{"application/hal+json":{"schema":{"type":"object","required":["count","total","page","per_page","total_pages","_links","_embedded"],"properties":{"count":{"type":"integer","description":"The number of results in the current page"},"total":{"type":"integer","description":"The total number of results"},"page":{"type":"integer","description":"The current page"},"per_page":{"type":"integer","description":"The number of results per page"},"total_pages":{"type":"integer","description":"The total number of result pages"},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string"}}}}},"_embedded":{"type":"object","description":"List of upstream identifiers for the guarantor context.","required":["identifiers"],"properties":{"identifiers":{"type":"array","items":{"type":"object","description":"Identifier that uniquely references a guarantor in the upstream EHR.","required":["id","type"],"properties":{"id":{"type":"string","description":"Identifier value provided by the upstream EHR.","example":"EPI123456"},"type":{"type":"string","description":"Identifier category (e.g. MRN, CSN).","example":"MRN"}}}}}}}},"example":{"count":2,"total":2,"page":1,"per_page":25,"total_pages":1,"_links":{"self":{"href":"https://api.talkdesk.com/healthcare/guarantors?guarantor_id=1a2b3c4d-5678-90ab-cdef-1234567890ab&page=1&per_page=25"}},"_embedded":{"identifiers":[{"id":"123456789","type":"MRN"},{"id":"987654","type":"CSN"}]}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Generic Bad Request":{"value":{"code":"1484000","message":"Bad request."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"1484010","message":"Invalid JWT token."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Missing Scopes":{"value":{"code":"1484030","message":"Required scopes are missing."}}}}}},"404":{"description":"Upstream guarantor not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Not Found":{"value":{"code":"1484040","message":"Resource not found."}},"Upstream Not Found":{"value":{"code":"1484041","message":"Not Found in upstream."}}}}}}}}}},"components":{"securitySchemes":{"GA":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{"account:read":"Show account details","apps:read":"Get details about app installations for an account","apps:write":"Update an app installation state programatically","attributes:read":"List attributes or attribute categories for an account and get details for a specific attribute","attributes:write":"Create, update and remove attributes or attributes categories for an account","bulk-imports:read":"Get list of imports and export errors into CSV file","bulk-imports:write":"Create and update import data","callback:write":"Request a new direct callback","contacts-integrations:read":"Get details for contacts' integrations","contacts:read":"Get details for contact(s)","contacts:write":"Create, update or delete contacts","contact-gdpr:write":"GDPR Contacts","continuity-settings:read":"Read business continuity settings","continuity-settings:write":"Change business continuity settings","continuity-settings-activation:read":"Read information on activation of the continuity settings","continuity-settings-activation:write":"Edit information on activation of the continuity settings","data-reports:read":"Download previously generated data reports","data-reports:write":"Create new data reports","events:read":"Get details from received events","express-provisioning:read":"Express-provisioning validate if account exists","express-provisioning:write":"Provisioning of an account","express-accounts-usage:read":"Read usage information for an account","express-accounts:read":"Read account information","express-accounts-contracts:read":"Get contract info for express accounts","express-accounts-contracts-actions:write":"Create contract actions for express accounts","express-accounts-contracts-actions:read":"Read contract actions of express accounts","express-products:read":"Read product information","express-accounts-subscriptions:read":"Read subscription information for an account","express-accounts-invoices:read":"Read invoice information for an account","erc-ecommerce-shopify-webhooks-handler-credentials:write":"Create or update Shopify webhook handler credentials","erc-ecommerce-shopify-webhooks-handler-credentials:read":"Read Shopify webhook handler credentials","flows-interactions:start":"Starts an interaction associated with a flow","fsi-accounts:read":"List of accounts associated with a contact","fsi-contacts:write":"Update contact information","fsi-contacts:read":"List and get contact details","fsi-cards:read":"List of cards from a account","fsi-cards:write":"Update the status for a card","fsi-payments:read":"List of payments from a specific account","fsi-transactions:read":"List of transactions for a specific account","fsi-payoff:read":"Get the payoff for an FSI account","fsi-transfers:write":"Create an FSI Transfer","fsi-stop-payment:write":"Cancel a payment before it’s been processed","fsi-travel-notification:write":"Create a new endpoint for Travel Notifications","fsi-checks:read":"Search for a check","fsi-set-ach-transfer:write":"FSI Set ACH Transfer","fsi-unlock-account:write":"Unlock account for a banking customer","fsi-decrypt:read":"The decryption based on AES algorithm","fsi-write-back:write":"FSI Write Data Back","fsi-spend-limit:read":"Daily limit for reading debit cards","fsi-spend-limit:write":"Modify the daily limit of debit cards","guardian-call-quality:read":"Read Guardian call quality data.","guardian-sessions:read":"Read Sessions Guardian data.","guardian-users:read":"Read Users Guardian data.","guardian-cases:read":"Read Cases Guardian data.","identity-activity:read":"Identity activity read access","identity-phone-validation:read":"Identity Phone Validation read access","openid":"User info endpoint","recordings:read":"Get recording files","refresh_token":"Token refresh flow","reports:read":"List previously generated reports and download them","reports:write":"Create new reports or delete existing ones","ring-groups:read":"Get the list of ring groups for an account","user-ring-groups:read":"Include the ring groups of the user in the response","users:read":"List users for an account and get details for a specific user","users:write":"Create, Update and Delete users","interactions:control-recordings":"Control the recording status of an interaction","fsi-workspace-contact-synchronization:write":"Synchronize Talkdesk contact with fsi member information","voicebiometrics-enroll:write":"Update and delete Voice Biometrics enroll data","voicebiometrics-consent:read":"VoiceBiometrics consent read access","voicebiometrics-consent:write":"VoiceBiometrics consent write access","live-queries:read":"Read and list queries from Live API","live-subscriptions:read":"Read subscriptions from Live API","live-subscriptions:write":"Create a new subscription for Live API","wfm-aion-public:write":"Create, Update and Delete WFM Aion related data by an external client.","wfm-request-management-public:write":"Create, Update and Delete WFM Request Management related data by an external client.","wfm-request-management-public:read":"Read WFM Request Management related data by an external client.","account-wallets:read":"Get information about account wallets","bucket-configurations:read":"Get all bucket configurations","cases-public:write":"Create,update and delete case data","cases-public:read":"Read case","case-notes-public:read":"Read case note data","case-notes-public:write":"Create, edit, and delete case note data","case-fields-public:read":"Read case field","do-not-call-lists:manage":"Update a DNCL by adding or deleting a entry on a do not call list","record-lists:manage":"Ability to view, add and update records of a Record List","record-lists:write":"Create and update record lists for an account","campaigns:write":"Create, update and delete campaigns","campaigns:read":"List and view available campaigns","schedule-callbacks:read":"List schedule callbacks","schedule-callbacks:write":"schedule a callbacks or reschedule a callbacks","po-record-list-automations:write":"Custom record list automations for proactive outbound clients","prompts:read":"Read prompts","prompts:write":"Create a prompt","prompts:delete":"Delete a prompt","prompts:download":"Get prompt download link","webhooks-trigger:write":"Create, update and delete a webhook trigger","cfm-public:write":"Collect feedback data","digital-connect:read":"List and Get digital-connect Resources","digital-connect:write":"Create, Update and Delete digital-connect Resources","entitymapper-contact-interactions:write":"Update interaction's contact mappings","locations-directory:read":"Read locations information","staffs-directory:read":"Read staffs information","automated-notifications-management:read":"Read Automated Notifications related account information","automated-notifications-management:write":"Write Automated Notifications related account information","automated-notifications:read":"Read Automated Notifications event information","automated-notifications:write":"Write Automated Notifications event information","automated-notifications-bridge:write":"Write permissions for automated-notifications-bridge webhooks","automated-notifications-subscriptions:read":"Read Automated Notifications subscriptions related to a topic/channel","automated-notifications-subscriptions:write":"Write (subscribe/unsubscribe) Automated Notifications subscriptions related to a topic/channel","entitymapper-map:write":"Write mappings with external entities","entitymapper-contacts:read":"Search Talkdesk contact","entitymapper-contacts:write":"Write Talkdesk contact","appointment-scheduling-va:read":"Read appointment scheduling va entries","hls-coverage:read":"Read healthcare & life sciences coverage information","hls-balance:read":"Read healthcare & life sciences balance information","hls-patient:read":"Read healthcare & life sciences patient information","hls-providers:call-answered":"Write healthcare & life sciences call answered information","hls-appointment:read":"Read healthcare & life sciences patient appointments","hls-medication-order:read":"Read healthcare & life sciences patient medication orders","hls-appointment:write":"Write healthcare & life sciences patient appointments","hls-contact:write":"Write healthcare & life sciences data into talkdesk contact","hls-provider:read":"Read healthcare & life sciences provider appointments","hls-phone-action:write":"Write healthcare & life sciences phone action","hls-click-to-call:write":"Write healthcare & life sciences click-to-call action","hls-epic-outgoing-sms:write":"Trigger outgoing SMS from Epic","hls-epic-agent-status-sync:write":"Trigger agent status sync from Epic","hls-inbasket-message:write":"Send in-basket message to Epic","hls-popup-intent:write":"Save intent of a patient","hls-prescription:read":"Read healthcare & life sciences prescription information","hls-prescription:write":"Write healthcare & life sciences prescription information","hls-encounter:read":"Read healthcare & life sciences patient encounters","hls-service-request:read":"Read healthcare & life sciences patient service requests","hls-procedure:read":"Read healthcare & life sciences patient procedures","hls-payers-connections:read":"Read healthcare & life sciences payers information","hls-payers-connections:write":"Write healthcare & life sciences payers information","hls-symptom-checker:write":"Symptom checker for patient","hls-patient:write":"Write healthcare & life sciences patient information","hls-epic:call-answered":"Write healthcare & life sciences call answered information","hls-sycurio:integrate":"Integrate with Sycurio platform","hls-patient-case:write":"Write healthcare & life sciences patient case information","hls-outstanding-order:read":"Read healthcare & life sciences outstanding orders","hls-medication-order:write":"Write healthcare & life sciences medication order(request)","hls-medication-statement:write":"Write healthcare & life sciences medication statement","hls-medication-statement:read":"Read healthcare & life sciences medication statement","hls-hl7-events:write":"Write healthcare providers HL7 events","erc-ecommerce-connections-orders:write":"Update e-commerce connections orders info","erc-ecommerce-connections-customers:read":"Read e-commerce connections customers info","erc-ecommerce-connections-customers:write":"Write e-commerce connections customers info","erc-ecommerce-connections-orders:read":"Read e-commerce connections orders info","erc-ecommerce-connections-products:read":"Read e-commerce connections products info","erc-ecommerce-customers:read":"Read e-commerce customers info","erc-ecommerce-customers:write":"Write e-commerce customers info","erc-ecommerce-return-reasons:read":"Read e-commerce return reasons","erc-ecommerce-return:read":"Read e-commerce return info","erc-ecommerce-return:write":"Write e-commerce return info","industries-settings-public:write":"Write industries settings","industries-contexts:write":"Create, update, and delete context values","fsi-insurance-connections-automated-notifications:write":"Write Automated Notifications event information","fsi-insurance-connections-contacts:write":"Sync Talkdesk contacts","fsi-insurance-connections-claims:read":"Read claims by id from FSI Insurance","fsi-insurance-integrations-policies:read":"Read policies from FSI Insurance","fsi-insurance-integrations-accounts:read":"Read accounts from FSI Insurance","fsi-insurance-integrations-claims:write":"Write claims from FSI Insurance","fsi-insurance-integrations-billing:read":"Read billing info from FSI Insurance","fsi-insurance-integrations-claims:read":"Read claims from FSI Insurance","fsi-insurance-integrations-contacts:write":"Update contact details from FSI Insurance","fsi-insurance-integrations-send-docs:read":"Send document deliveries from FSI Insurance","automated-notifications-interactions:read":"Read Automated Notifications related with interactions","industries-scheduler-teams:read":"Read teams from industries-scheduler","industries-scheduler-availabilities:read":"Get users availabilities by email","industries-scheduler-appointment:write":"Create cancel event on specialist's calendar","industries-scheduler-appointment:read":"Read appointments from industries-scheduler","industries-messaging-service:write":"Write messages in industries-messaging-service","interaction-custom-fields:write":"Allows to populate interaction custom fields","user-session-public:end":"Terminate a user session","industries-settings-public:read":"Read industries settings","industries-contexts:read":"Read context values","dialer-integrations-records:read":"Read dialer integrations campaign records","scim":"Access SCIM-related routes","hls-epic-my-chart-reset-password:write":"Trigger Epic MyChart password reset","locations-directory-bulk-operation:write":"Write locations directory data","hls-patient-location:read":"Read loction patient data","hls-patient-practice:read":"Read healthcare & life sciences patient practices","hls-guarantor:read":"Read guarantor identifiers from providers"}}}},"Deprecated":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{"attributes:read":"List attributes or attribute categories for an account and get details for a specific attribute"}}}},"EarlyAccess":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{"messages:read":"Ability to read messages from the API","messages:write":"Ability to send messages from the API","presence-account:read":"Read Account presence","presence-user:read":"Read User presence","presence-occupancy:write":"Write User occupancy","presence-status:write":"Write User status","interactions-announcement:write":"Control the announcements in an interaction","industries-event-subscriptions:write":"Create new subscription for industry events","industries-event-subscriptions:read":"Read subscriptions for industry events","contacts-custom-fields:read":"Search the custom fields for a given contact","contacts-activities:read":"List activities for a contact","wfm-public:read":"Get WFM related public data.","wfm-public:write":"Create, Update and Delete WFM related public data.","industries-activity:write":"Create and update industries activities and events","functions:execute":"Execute functions in external provider","phone-details:read":"Show phone details from a specific account","outbound-numbers:read":"List phone numbers that the agent can use for outbounds","user-ring-groups:write":"Update ring groups associated to users","fsi-desktop-app-session:read":"Get FSI Desktop App session","fsi-desktop-app-session:write":"Create a FSI Desktop App session","numbers:read":"List numbers for an account","user-disposition-settings:write":"Update disposition settings for the user","profile-data:write":"write profile data","profile-data:read":"read profile data","event-data:write":"write profile data","role-permissions:skip":"Skip role permissions validation","attachments:download":"Generate a download link that gives temporary access to the attachment data","attachments:read":"Get, and list attachments","attachments:request":"Get request ids and urls for uploading","attachments:write":"Create, and clone attachments","attachments:delete":"Delete an attachment permanently","simulated-emails:write":"Write to the eas send simulated email API","fsi-insurance-connections-contacts:read":"List and get insurance account holders","interactions-public:read":"Read interactions for an account","ccaas-user-status:write":"Update user status in ccaas","ccaas-user-status:read":"Read user status in ccaas","queues:write":"Create/update CCAAS queues details","km-external-sources:read":"Read external sources in Talkdesk Knowledge Management","km-external-sources:write":"Manage external sources in Talkdesk Knowledge Management","omnichannel:interaction-elimination":"Eliminate an omnichannel interaction resource","industries-workato-hub":"Allow calling industries workato using a Talkdesk Id OAuth Client","secure-messaging:read":"Read secure messaging resources","secure-messaging:write":"Create, update secure messaging resources","digital-byob-webhook:write":"Reply, Escalate and Resolve Email interactions via BYOB","customer-data-store:read":"Read the multi-channel message","email-connection-execution:write":"Execute email connection","flows-platform:submit":"Trigger an automation flow associated with an account"}}}}}},"tags":[{"name":"Account","description":" Account related resources"},{"name":"Usage Manager","description":" "},{"name":"Apps","description":" "},{"name":"Channels","description":" "},{"name":"Attachments","description":" Attachments API for public digital attachments"},{"name":"Attributes","description":" "},{"name":"Bulk Import","description":" "},{"name":"Ring Groups","description":" "},{"name":"Recordings","description":" "},{"name":"Calls","description":" "},{"name":"Contacts","description":" "},{"name":"Conversations","description":" "},{"name":"Do Not Call Lists","description":" "},{"name":"Events","description":" "},{"name":"External Credentials","description":" "},{"name":"Fallback Experience","description":" Fallback experience allows our customers to define the behavior that inbound calls should have when faced with an event that seriously compromises their capacity of handling inbound calls (such as an outage, for example)."},{"name":"Flows","description":" "},{"name":"Flows Platform","description":" API responsible for handling Automation Flows actions"},{"name":"Guardian","description":" "},{"name":"Identity","description":" "},{"name":"Interactions","description":" "},{"name":"Messages","description":" "},{"name":"Numbers","description":" Numbers (legacy - DEPRECATED) listing and details resources"},{"name":"Authentication","description":" "},{"name":"Record Lists","description":" "},{"name":"Reports","description":" "},{"name":"Live API","description":" "},{"name":"Users","description":" "},{"name":"Presence","description":" "},{"name":"SCIM","description":" "},{"name":"Explore","description":" "},{"name":"Industries Events","description":" "},{"name":"FSI Accounts","description":" "},{"name":"FSI Payoff","description":" Calculate payoff for an FSI account based on a provided date"},{"name":"FSI Contacts","description":" "},{"name":"FSI Cards","description":" "},{"name":"FSI Payments","description":" "},{"name":"FSI Transfers","description":" Fsi Transfers"},{"name":"FSI Stop Payment","description":" "},{"name":"FSI Create Travel Notifications","description":" "},{"name":"FSI Replace Card","description":" "},{"name":"FSI Set ACH Transfer","description":" "},{"name":"FSI Unlock Account","description":" "},{"name":"FSI Write Data Back","description":" "},{"name":"FSI Spend Limit","description":" "},{"name":"Automated Notifications","description":" "},{"name":"FSI Transactions","description":" "},{"name":"FSI Workspace","description":" "},{"name":"HLS Providers","description":" "},{"name":"Industries External Entity Mapper","description":" API responsible for mapping external entities"},{"name":"Appointment scheduling service","description":" "},{"name":"Voice Biometrics","description":" "},{"name":"WFM","description":" "},{"name":"WFM-Aion","description":" "},{"name":"WFM-Request-Management","description":" "},{"name":"Industries Activity API","description":" "},{"name":"Industries Settings","description":" Industries Settings"},{"name":"Industries Contexts","description":" Industries Contexts"},{"name":"Functions","description":" "},{"name":"Phone Labels","description":" "},{"name":"Cases","description":" "},{"name":"Digital-Connect-Conversations","description":" Digital Connect API endpoints related to Conversations, create, update and manage conversations"},{"name":"Phone Details","description":" Phone details retrieval service"},{"name":"FSI Insurance Connections","description":" "},{"name":"FSI Desktop App","description":" FSI Desktop App API to manage fsi-desktop-app sessions"},{"name":"Cp","description":" Api for Contact profile"},{"name":"Cfm","description":" Api for Cfm"},{"name":"Campaigns","description":" "},{"name":"Schedule Callback","description":" "},{"name":"HLS Payers","description":" "},{"name":"HLS Sycurio Integration","description":" "},{"name":"PO Client Custom Automations","description":" Provides record list custom automations for specific clients, based in proactive outbound events"},{"name":"Webhook trigger","description":" Webhook triggers manager"},{"name":"EXPRESS API","description":" EXPRESS API"},{"name":"express-provisioning","description":" Express Provisioning"},{"name":"Emails","description":" "},{"name":"Prompts","description":" Rest API for audio prompts management"},{"name":"FSI Insurance Integrations","description":" "},{"name":"ERC ECommerce Connections","description":" Endpoints of the ERC ECommerce connections service"},{"name":"ERC ECommerce Shopify Webhooks Handler","description":" Endpoints of the ERC ECommerce Shopify Webhooks Handler service"},{"name":"ccaas-user-status-api","description":" "},{"name":"Queues API","description":" API for CCAAS Queues Management"},{"name":"Locations Directory","description":" API responsible to manage Location data for industry related products (ex. store locations)"},{"name":"Industries Scheduler","description":" Rest API that will support industries-scheduler-admin-app"},{"name":"Industries Messaging Service","description":" API for managing messages"},{"name":"Reporting Custom Fields API","description":" API to publish custom fields to the Custom Fields Report"},{"name":"Knowledge Management","description":" Talkdesk Knowledge Management API"},{"name":"Dce Tracking","description":" Dce Tracking API"},{"name":"Dialer Integrations","description":" "}],"externalDocs":{"description":"External Documentation","url":"https://api-docs.talkdeskapp.com/external_docs"}}