{"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":{"operationId":"account-get","summary":"Get account details","description":"Get Account Details","security":[{"GA":["account:read"]}],"tags":["Accounts API"],"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":{"operationId":"account-wallets-get","summary":"Get account wallet list","description":"Get account wallet list","security":[{"GA":["account-wallets:read"]}],"tags":["Usage-Manager API"],"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":{"operationId":"account-wallets-name-get","summary":"Get single account wallet","description":"Get single account wallet","security":[{"GA":["account-wallets:read"]}],"tags":["Usage-Manager API"],"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":{"operationId":"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 API"],"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":{"operationId":"apps-get","summary":"Get the list of apps","description":"Get the list of apps","security":[{"GA":["apps:read"]}],"tags":["Apps API"],"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":{"operationId":"apps-post","summary":"Submit app","description":"Submit app","security":[{"GA":["apps:write"]}],"tags":["Apps API"],"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":{"operationId":"apps-app-id-get","summary":"Get information about an app","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 API"],"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":{"operationId":"apps-app-id-patch","summary":"Partially updates the app info","description":"Partially updates the app info","security":[{"GA":["apps:write"]}],"tags":["Apps API"],"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":{"operationId":"apps-app-id-installations-id-get","summary":"Get information about installation","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 API"],"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":{"operationId":"apps-app-id-installations-id-users-get","summary":"Get installation enabled users","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 API"],"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":{"operationId":"apps-app-id-installations-id-state-post","summary":"Set the state of the installation","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 API"],"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":{"operationId":"apps-app-id-installations-id-subscription-get","summary":"Get installation subscription","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 API"],"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":{"operationId":"apps-app-id-installations-id-channels-get","summary":"List channels for the installation","description":"list channels for the installation","x-internal":true,"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 API"],"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":{"operationId":"apps-app-id-installations-id-channels-post","summary":"Activate channels for the installation","description":"activate channels for the installation","x-internal":true,"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 API"],"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":{"operationId":"apps-app-id-installations-id-trial-get","summary":"Get the installation trial information","description":"Get 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 API"],"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":{"operationId":"apps-app-id-installations-id-credentials-actions-rotate-post","summary":"Rotates the installation's credentials","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 API"],"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":{"operationId":"apps-app-id-installations-id-credentials-client-id-state-post","summary":"Acknowledge installation credentials","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 API"],"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":{"operationId":"attachments-2023-03-get","x-namespace":"/attachments","tags":["Attachments"],"summary":"List Attachments","description":"Retrieves a paginated list of attachments belonging to the current account. Use this endpoint to browse, search, and filter attachments by name, type, metadata, or state. Supports pagination via the `page` and `per_page` query parameters. Returns an empty list if no attachments match the filters.","x-internal":true,"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":{"operationId":"attachments-2023-03-post","x-namespace":"/attachments","tags":["Attachments"],"summary":"Create Attachment","description":"Creates a new attachment resource and returns it. Use this endpoint after uploading the file content via the upload link to register the attachment with the account. The attachment name must be unique within the account; a 409 error is returned if a duplicate name is detected.","x-internal":true,"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":{"operationId":"attachments-2023-03-upload-link-post","x-namespace":"/attachments","tags":["Attachments"],"summary":"Attachment Upload Request","description":"Initiates the attachment upload process by generating a temporary upload link. Use this endpoint as the first step when adding a new attachment: request an upload link, upload the file content to the provided URL, and then call the Create Attachment endpoint to finalize. The upload link expires after a limited time window.","x-internal":true,"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":{"operationId":"attachments-2023-03-id-get","x-namespace":"/attachments","tags":["Attachments"],"summary":"Get Attachment","description":"Retrieves the details of a specific attachment by its unique identifier. Use this endpoint to fetch metadata such as name, type, state, and associated links for a single attachment. Returns a 404 error if the attachment does not exist or does not belong to the current account.","x-internal":true,"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 unique identifier of the attachment","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":{"operationId":"attachments-2023-03-id-delete","x-namespace":"/attachments","tags":["Attachments"],"summary":"Delete Attachment","description":"Permanently deletes a specific attachment by its unique identifier. Use this endpoint to remove attachments that are no longer needed. This action is irreversible. Returns a 204 status with no content on success, or a 404 error if the attachment does not exist.","x-internal":true,"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":{"operationId":"attachments-2023-03-id-download-link-get","x-namespace":"/attachments","tags":["Attachments"],"summary":"Get the Attachment Download Link","description":"Generates a temporary download link that grants access to the attachment's file content. The link expires after 10 minutes. Use this endpoint when you need to retrieve the actual file data for a specific attachment. Returns a 404 error if the attachment does not exist.","x-internal":true,"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":"Returns a paginated list of attributes for the account.\nUse this endpoint to retrieve attributes for display or filtering purposes, for example when building an agent management UI or verifying configuration.\nFor team-scoped users, only attributes within their team scope are returned. Results can be filtered by name, active status, category, or proficiency type.","security":[{"GA":["attributes:read"]}],"summary":"Attributes List","tags":["Attributes API"],"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,"team_ids":["f3b8d0ea-d40d-417c-ac9c-0931e7fcb8aa"],"_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"},"team_ids":{"type":"array","description":"The team IDs associated with the attribute. For team-scoped users, only teams within their scope are returned.","items":{"type":"string"}},"_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","team_ids","_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":"Creates a new routing attribute in the account.\nUse this endpoint to programmatically add attributes as part of a configuration workflow or integration with an external workforce management system.\nFor team-scoped users, only teams within their scope can be associated with the attribute. The attribute name, active status, category, proficiency type, and default proficiency are required fields.","security":[{"GA":["attributes:write"]}],"summary":"Create a New Attribute","tags":["Attributes API"],"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,"team_ids":["f3b8d0ea-d40d-417c-ac9c-0931e7fcb8aa"],"_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"},"team_ids":{"type":"array","description":"The team IDs associated with the attribute. For team-scoped users, only teams within their scope are returned.","items":{"type":"string"}},"_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","team_ids","_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 or attribute not within team scope.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Insufficient permissions":{"value":{"code":"0360003","message":"Forbidden."}},"Forbidden teams":{"value":{"code":"0360006","message":"One or more provided teams are not authorized for this request."}}}}}},"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},"team_ids":{"type":"array","description":"The team IDs to associate with the attribute. For team-scoped users, this field is required and only teams within their scope are allowed.","items":{"type":"string"}}},"required":["name","active","category_id","proficiency","default_proficiency"]}}}}}},"/attributes/{attribute_id}":{"get":{"x-namespace":"/attributes","description":"Returns the details of a specific attribute by its ID.\nUse this endpoint to retrieve attribute configuration for display or to verify attribute properties before performing updates.\nFor team-scoped users, the attribute must be within their team scope.","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 API"],"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,"team_ids":["f3b8d0ea-d40d-417c-ac9c-0931e7fcb8aa"],"_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"},"team_ids":{"type":"array","description":"The team IDs associated with the attribute. For team-scoped users, only teams within their scope are returned.","items":{"type":"string"}},"_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","team_ids","_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":"Updates the properties of an existing attribute.\nUse this endpoint to modify attribute configuration, such as changing its name, active status, category, or proficiency settings.\nFor team-scoped users, the attribute must be within their team scope. Team-scoped users cannot remove all teams from an attribute — at least one accessible team must remain.","security":[{"GA":["attributes:write"]}],"summary":"Update an Attribute","tags":["Attributes API"],"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,"team_ids":["f3b8d0ea-d40d-417c-ac9c-0931e7fcb8aa"],"_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"},"team_ids":{"type":"array","description":"The team IDs associated with the attribute. For team-scoped users, only teams within their scope are returned.","items":{"type":"string"}},"_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","team_ids","_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 or attribute not within team scope.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Insufficient permissions":{"value":{"code":"0360003","message":"Forbidden."}},"Forbidden teams":{"value":{"code":"0360006","message":"One or more provided teams are not authorized for this request."}}}}}},"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},"team_ids":{"type":"array","description":"The team IDs to assign. For team-scoped users, only teams within their scope can be changed; out-of-scope teams remain unchanged. Note: This field is required for team-scoped users, and they cannot remove all teams from the attribute — at least one accessible team must remain.","items":{"type":"string"},"nullable":true}}}}}}}},"/attributes/{attribute_id}/users":{"get":{"x-namespace":"/attributes","description":"Returns a paginated list of users to whom a specific attribute has been assigned.\nUse this endpoint to inspect attribute membership, for example when auditing agent skill assignments or building an attribute-users management view.\nFor team-scoped users, the attribute must be within their team scope and only users within their teams are returned. Results can be filtered by attribute name.","security":[{"GA":["attributes:read"]}],"summary":"Attribute Users List","tags":["Attributes API"],"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 or attribute/users not within team scope.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Insufficient permissions":{"value":{"code":"0360003","message":"Forbidden."}},"Forbidden teams":{"value":{"code":"0360006","message":"One or more provided teams are not authorized for this request."}}}}}},"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 one or more users with a specific attribute, optionally setting a proficiency level for each user.\nUse this endpoint to assign skills or capabilities to agents programmatically, for example as part of a workforce management integration.\nFor team-scoped users, both the attribute and the users must be within their team scope.","security":[{"GA":["attributes:write"]}],"summary":"Associate Users to an Attribute","tags":["Attributes API"],"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 or attribute/users not within team scope.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Insufficient permissions":{"value":{"code":"0360003","message":"Forbidden."}},"No access to the attribute":{"value":{"code":"0360006","message":"You're not authorized to access this attribute."}},"Users outside team scope":{"value":{"code":"0360006","message":"Cannot manage users outside your team scope."}}}}}},"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":"Removes the association between one or more users and a specific attribute.\nUse this endpoint to unassign skills or capabilities from agents, for example when updating team rosters or revising skill configurations.\nFor team-scoped users, both the attribute and the users must be within their team scope.","security":[{"GA":["attributes:write"]}],"summary":"Remove Association of Users to an Attribute","tags":["Attributes API"],"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 or attribute/users not within team scope.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Insufficient permissions":{"value":{"code":"0360003","message":"Forbidden."}},"No access to the attribute":{"value":{"code":"0360006","message":"You're not authorized to access this attribute."}},"Users outside team scope":{"value":{"code":"0360006","message":"Cannot manage users outside your team scope."}}}}}},"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":"Returns a paginated list of attribute categories in the account.\nUse this endpoint to retrieve available categories for filtering or display, for example when rendering a category selector in an attribute management interface.\nResults can be sorted by name in ascending or descending order.","security":[{"GA":["attributes:read"]}],"summary":"Attributes Categories List","tags":["Attributes API"],"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":"Creates a new attribute category in the account.\nUse this endpoint to programmatically add categories as part of a configuration workflow.\nCategory names must be unique within the account.","security":[{"GA":["attributes:write"]}],"summary":"Create a New Attribute Category","tags":["Attributes API"],"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":"Deletes an existing attribute category by its ID.\nUse this endpoint to remove categories that are no longer needed in your configuration.\nNote: deleting a category may affect attributes currently assigned to it.","security":[{"GA":["attributes:write"]}],"summary":"Delete an Attribute Category","tags":["Attributes API"],"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":"Updates the name of an existing attribute category.\nUse this endpoint to rename a category as part of ongoing configuration management.\nCategory names must be unique within the account.","security":[{"GA":["attributes:write"]}],"summary":"Update an Attribute Category","tags":["Attributes API"],"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":{"operationId":"bulk-imports-users-get","summary":"Get list of imports","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 API"],"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","EXPORT_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"},"export_criteria":{"type":"object","nullable":true,"description":"The criteria used to filter the export (only for EXPORT_USERS).","properties":{"mode":{"type":"string","enum":["ALL","FILTER","USER_IDS"],"description":"The export mode"}}},"_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":{"operationId":"bulk-imports-users-post","summary":"Create a new import","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"},"export_criteria":{"type":"object","nullable":true,"description":"Optional export filter criteria","properties":{"mode":{"type":"string","enum":["ALL","FILTER","USER_IDS"],"description":"The export mode"},"query":{"type":"string","description":"Filter query string (required for FILTER mode, max 4096 bytes)."},"user_ids":{"type":"array","maxItems":100,"description":"List of user IDs to export (required for USER_IDS mode, max 100).","items":{"type":"string"}}}}},"required":["type"]},"examples":{"Export Users":{"value":{"type":"EXPORT_USERS"}}}}}},"tags":["Bulk Import API"],"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","EXPORT_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"},"export_criteria":{"type":"object","nullable":true,"description":"The criteria used to filter the export (only for EXPORT_USERS).","properties":{"mode":{"type":"string","enum":["ALL","FILTER","USER_IDS"],"description":"The export mode"}}},"_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"}},"Invalid Export Criteria":{"value":{"code":"1600022","message":"Invalid Export Criteria","description":"Export criteria is invalid."}}}}}},"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":{"operationId":"bulk-imports-users-import-id-get","summary":"Get an import","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 API"],"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","EXPORT_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"},"export_criteria":{"type":"object","nullable":true,"description":"The criteria used to filter the export (only for EXPORT_USERS).","properties":{"mode":{"type":"string","enum":["ALL","FILTER","USER_IDS"],"description":"The export mode"}}},"_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":{"operationId":"bulk-imports-users-import-id-patch","summary":"Updates one import","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 API"],"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","EXPORT_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"},"export_criteria":{"type":"object","nullable":true,"description":"The criteria used to filter the export (only for EXPORT_USERS).","properties":{"mode":{"type":"string","enum":["ALL","FILTER","USER_IDS"],"description":"The export mode"}}},"_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":{"operationId":"bulk-imports-users-import-id-errors-get","summary":"Get a CSV file containing errors","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 API"],"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":{"operationId":"bulk-imports-users-import-id-outputs-get","summary":"Get the outputs of an export","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 API"],"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":{"operationId":"ring-groups-get","deprecated":true,"summary":"List Ring Groups","description":"Returns a paginated list of ring groups for the account.\nUse this endpoint to retrieve all ring groups and their details, for example to build a directory or to support ring group assignment workflows.\nResults can be filtered by name and sorted by name in ascending or descending order.","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 API"],"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":{"operationId":"ring-groups-id-users-get","deprecated":true,"summary":"List Ring Group Users","description":"Returns a paginated list of users assigned to a specific ring group.\nUse this endpoint to inspect ring group membership, for example when auditing agent assignments or displaying ring group details in a management UI.\nResults can be filtered by the user's active status.","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 API"],"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":{"deprecated":true,"summary":"Assign Ring Groups","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","x-internal":true,"security":[{"EarlyAccess":["user-ring-groups:write"]}],"tags":["Ring Groups API"],"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":{"deprecated":true,"summary":"Unassign Ring Groups","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","x-internal":true,"security":[{"EarlyAccess":["user-ring-groups:write"]}],"tags":["Ring Groups API"],"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":{"deprecated":true,"description":"Updates the ring groups associated with a user, replacing the current assignment with the provided list.\nUse this endpoint to manage ring group membership for individual agents, for example when handling role changes or team restructuring.\nFor team-scoped users, the target user must be within the authenticated user's team scope.","summary":"Update User Ring Groups","operationId":"UpdateUserRingGroups","x-namespace":"/users","x-internal":true,"security":[{"EarlyAccess":["user-ring-groups:write"]}],"tags":["Ring Groups API"],"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":{"operationId":"calls-call-id-recordings-get","summary":"Get call recordings list","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 API"],"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":{"operationId":"calls-callback-post","summary":"Request a new direct callback","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":["Callback API"],"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":{"operationId":"list-contacts","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 API"],"x-talkdesk":{"mcp":{"profiles":["PUBLIC","INTERNAL"],"icon":"https://stg-cdn-talkdesk.talkdeskdev.com/cdn-assets/latest/talkdesk/product/app-icons/settings.svg","annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},"token-levels":["USER"],"policies":[{"realm":"MAIN","level":"USER","policy":"contacts.view"}],"realms":["MAIN"]},"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":{"operationId":"get-contact","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 API"],"x-talkdesk":{"mcp":{"profiles":["PUBLIC","INTERNAL"],"icon":"https://stg-cdn-talkdesk.talkdeskdev.com/cdn-assets/latest/talkdesk/product/app-icons/settings.svg","annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},"token-levels":["USER"],"policies":[{"realm":"MAIN","level":"USER","policy":"contacts.view"}],"realms":["MAIN"]},"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":{"operationId":"contacts-contact-id-delete","summary":"Delete a contact by id","description":"Deletes a contact from the system. The contact is not permanently removed right away — it is marked as deleted and can be restored if needed.\n\nUse this when a user explicitly wants to remove a contact.\n**Does not erase personal data.** If the goal is compliance with a data erasure request, use the GDPR endpoint instead.\n","security":[{"GA":["contacts:write"]}],"parameters":[{"name":"contact_id","in":"path","description":"The contact id","required":true,"schema":{"type":"string"}}],"tags":["Contacts API"],"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":{"operationId":"contacts-contact-id-integrations-get","summary":"Get a list of contact's integrations","description":"Returns a list of external tools or systems (e.g. Salesforce, Microsoft Dynamics) that this contact is linked to, along with a URL to view the contact in each of those systems.\n\nUse this when you need to know where a contact exists outside of Talkdesk.\nOnly works for **active contacts** — deleted contacts return **404**.\n","security":[{"GA":["contacts-integrations:read"]}],"parameters":[{"name":"contact_id","in":"path","description":"The contact id","required":true,"schema":{"type":"string"}}],"tags":["Contacts API"],"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":{"operationId":"contacts-contact-id-custom-fields-get","summary":"Get a list of contact's custom fields","description":"Returns the custom fields stored on a contact — additional account-defined attributes (e.g. `loyalty_tier`, `preferred_language`) attached to the contact record beyond the standard fields.\n\nResults are paginated and can be filtered by custom field key using the `search` parameter (matches any of the provided keys).\nOnly works for **active contacts** — deleted contacts return **404**.\n","x-namespace":"/contacts","x-internal":true,"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 API"],"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":{"operationId":"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 API"],"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.","x-internal":true,"security":[{"EarlyAccess":["interactions-public:read"]}],"summary":"Query interactions and their messages based from the provided interaction start date.","tags":["Omnichannel API"],"operationId":"conversations-interactions-get","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)."},"queues":{"type":"array","items":{"type":"string"},"description":"The queues 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"],"queues":["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":{"operationId":"do-not-call-lists-id-entries-id-entry-get","summary":"Get Entry Details","tags":["Campaign Management API"],"description":"Returns the details of a specific entry in a Do Not Call List.\nUse this endpoint to retrieve a single entry by its ID.\n","x-internal":false,"security":[{"GA":["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":{"operationId":"do-not-call-lists-id-entries-id-entry-patch","summary":"Update a Single Entry","tags":["Campaign Management API"],"description":"Updates a specific entry in a Do Not Call List.\nUse this endpoint to modify the expiration date of an entry.\n","x-internal":false,"security":[{"GA":["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":{"operationId":"do-not-call-lists-id-entries-id-entry-delete","summary":"Delete an Entry","tags":["Campaign Management API"],"description":"Deletes a specific entry from a Do Not Call List.\nUse this endpoint to permanently remove a phone number entry from the list.\n","x-internal":false,"security":[{"GA":["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":{"operationId":"do-not-call-lists-id-entries-get","summary":"List Entries","tags":["Campaign Management API"],"description":"Returns a paginated list of entries from a Do Not Call List.\nUse this endpoint to retrieve all phone number entries with optional filtering and sorting.\n","x-internal":false,"security":[{"GA":["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":{"operationId":"do-not-call-lists-id-entries-post","summary":"Create an Entry","tags":["Campaign Management API"],"description":"Creates a new entry in a Do Not Call List.\nUse this endpoint to add a phone number to the list with an optional expiration date.\n","x-internal":false,"security":[{"GA":["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":{"operationId":"do-not-call-lists-id-entries-patch","summary":"Update Multiple Entries","tags":["Campaign Management API"],"description":"Updates multiple entries in a Do Not Call List in a single request.\nUse this endpoint to bulk update expiration dates or other entry attributes.\n","x-internal":false,"security":[{"GA":["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":{"operationId":"do-not-call-lists-id-entries-delete","summary":"Bulk Delete Entries","description":"Deletes multiple entries from a Do Not Call List in a single request.\nUse this endpoint to remove multiple phone number entries at once.\n","x-namespace":"/do-not-call-lists","tags":["Campaign Management API"],"x-internal":false,"security":[{"GA":["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":{"operationId":"events-signature-keys-key-id-get","summary":"Get event validation public key","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 API"],"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","description":"Retrieve JSON Web Key Set (JWKS) used for token verification. Use this endpoint to obtain the public keys needed to validate signed tokens issued by Talkdesk. Results can be filtered by one or more tags using the tag query parameter.","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":"Certificates Endpoint Options","description":"Returns the allowed HTTP methods for the certificates endpoint.","operationId":"external-credentials-options-certificates","tags":["External Credentials"],"responses":{"204":{"description":"OK","headers":{"Allow":{"schema":{"type":"string","example":"GET, OPTIONS"}}}}}}},"/fallback-experience":{"get":{"operationId":"fallback-experience-get","summary":"Get account information regarding continuity settings activation","description":"Retrieve information from Outage Answering Machine about whether fallback experience is 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":{"operationId":"fallback-experience-put","summary":"Enables or disables fallback experience","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":{"operationId":"flows-flow-id-interactions-post","summary":"Execute published flow","description":"Starts an interaction that executes the published version of the flow","security":[{"GA":["flows-interactions:start"]}],"tags":["Flows API"],"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":{"operationId":"flows-platform-flows-flow-id-trigger-post","x-internal":true,"summary":"Trigger Automation Flow","description":"Trigger an automation flow on-demand by its flow ID. Use this endpoint to programmatically start an automation flow. You can pass input variables as key-value pairs in the request body. The flow must be enabled; triggering a disabled flow returns a 409 Conflict error.","security":[{"EarlyAccess":["flows-platform:submit"]}],"parameters":[{"name":"flow_id","in":"path","required":true,"description":"The unique identifier of the automation flow to trigger","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 API"]}},"/guardian/agents":{"get":{"deprecated":true,"x-internal":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 API"]}},"/guardian/agents/{id}":{"get":{"deprecated":true,"x-internal":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 API"]}},"/guardian/agents/{id}/roles":{"get":{"deprecated":true,"x-internal":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 API"]}},"/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 API"]}},"/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 API"]}},"/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 API"]}},"/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 API"]}},"/guardian/calls/call-quality":{"get":{"description":"Returns a paginated list of historical call quality metrics, including jitter, round-trip time (RTT), MOS scores, and packet loss percentages per call.","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 call quality metrics","tags":["Guardian API"]}},"/identity/activities":{"get":{"operationId":"getActivities","summary":"Get activities","description":"Returns the paginated history of contact voice authentication activities for the account, such as authentication attempts and other identity-related events captured during calls.\nUse this endpoint to power dashboards, audit views or reporting flows that need a chronological feed of identity activity for contacts in the account.
    \nThe list is paginated and the maximum page size is 250 items, so larger exports must use the CSV-producing variant of this endpoint instead.\nWhen the contact query parameter is true (the default), activity entries are enriched with the matching contact's name and id resolved from the phone number; setting it to false skips that lookup and returns the raw activity records.","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"},"email_status":{"description":"Is the email address considered safe, suspicious, or high risk?","enum":["HIGH_RISK","SAFE","SUSPICIOUS","ERROR"],"type":"string"},"email_valid":{"description":"Is the email address properly formatted and considered valid?","type":"boolean"},"email_fraud_score":{"description":"The email risk score estimating how likely the address is to be fraudulent. Scores 85+ are high risk.","type":"integer","example":10},"email_disposable":{"description":"Is this email associated with a known disposable email service?","type":"boolean"},"email_deliverability":{"description":"How likely is it that this email address will successfully receive mail? Values are \"high\", \"medium\", or \"low\".","type":"string","example":"high"},"email_catch_all":{"description":"Is this email likely to be a catch-all address for the domain?","type":"boolean"},"email_leaked":{"description":"Was this email address exposed in a data breach?","type":"boolean"},"email_suspect":{"description":"This value indicates the email address may be invalid due to the email domain's SPF record failing.","type":"boolean"},"email_smtp_score":{"description":"Confidence level of the SMTP check. Values range from -1 to 3. Scores of -1 indicate no response from the server.","type":"integer","example":3},"email_overall_score":{"description":"Overall email quality score ranging from 0 to 4 where 4 is the highest quality score.","type":"integer","example":4},"email_first_name":{"description":"Suspected first name based on email. Returns \"CORPORATE\" if suspected of being a generic company email.","type":"string"},"email_common":{"description":"Is this email from common free email providers? (gmail.com, yahoo.com, hotmail.com, etc.)","type":"boolean"},"email_generic":{"description":"Is this email suspected as being a catch all or shared email for a domain? (admin@, webmaster@, etc.)","type":"boolean"},"email_dns_valid":{"description":"Does the email's hostname have valid DNS entries?","type":"boolean"},"email_honeypot":{"description":"Is this email believed to be a \"honeypot\" or \"SPAM trap\"?","type":"boolean"},"email_spam_trap_score":{"description":"Confidence level of the email address being an active SPAM trap. Values can be \"high\", \"medium\", \"low\", or \"none\".","type":"string"},"email_recent_abuse":{"description":"Has this email address been associated with recent or ongoing fraud?","type":"boolean"},"email_frequent_complainer":{"description":"Indicates if this email frequently unsubscribes from marketing lists or reports spam complaints.","type":"boolean"},"email_suggested_domain":{"description":"Indicates if this email's domain should be corrected to a popular mail service (e.g. \"gmai.com\" -> \"gmail.com\"). \"N/A\" if not applicable.","type":"string"},"email_domain_velocity":{"description":"Level of legitimate users interacting with the email address domain. Values can be \"high\", \"medium\", \"low\", or \"none\".","type":"string"},"email_domain_trust":{"description":"Risk classification of the email's domain. Values: \"trusted\", \"positive\", \"neutral\", \"suspicious\", \"malicious\", or \"not rated\".","type":"string"},"email_risky_tld":{"description":"Signals that the domain belongs to a risky TLD extension frequently associated with malware, scams, or phishing.","type":"boolean"},"email_spf_record":{"description":"Confirms if the domain has a proper SPF DNS record.","type":"boolean"},"email_dmarc_record":{"description":"Confirms if the domain has a proper DMARC DNS record.","type":"boolean"},"email_sanitized_email":{"description":"Sanitized email address with all aliases and masking removed.","type":"string"},"email_timed_out":{"description":"Did the email verification connection to the mail service provider timeout?","type":"boolean"},"email_mx_records":{"description":"Comma-separated list of MX records associated with the email's domain name.","type":"string"},"email_a_records":{"description":"Comma-separated list of A records associated with the email's domain name.","type":"string"},"email_first_seen_human":{"description":"Human-readable description of when the email address was first seen (e.g. \"3 months ago\").","type":"string"},"email_first_seen_timestamp":{"description":"Unix timestamp of when the email address was first seen.","type":"integer","format":"int64"},"email_first_seen_iso":{"description":"Date the email address was first seen, in ISO8601 format.","type":"string"},"email_domain_age_human":{"description":"Human-readable description of the email domain's age (e.g. \"3 months ago\").","type":"string"},"email_domain_age_timestamp":{"description":"Unix timestamp of when the email domain was registered.","type":"integer","format":"int64"},"email_domain_age_iso":{"description":"Date the email domain was registered, in ISO8601 format.","type":"string"},"email_request_id":{"description":"A unique identifier for this email validation request that can be used to lookup the request details.","type":"string"},"email_message":{"description":"A generic status message for the email validation, either success or some form of an error notice.","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 API"]}},"/identity/emailvalidations/{email}":{"get":{"description":"Returns reputation and risk information for an email address, such as deliverability and fraud signals.\nUse this endpoint to inspect an email address before deciding how to handle the corresponding contact, for example to flag disposable or high-risk addresses before triggering downstream workflows.
    \nThe email address is passed in the URL path and must be URL-encoded if it contains characters that require escaping.\nEach validation is billable for accounts with an active Identity license.","operationId":"getEmailValidation","parameters":[{"name":"email","in":"path","description":"Email address","required":true,"schema":{"type":"string","minLength":3,"maxLength":254},"example":"user@example.com"}],"responses":{"200":{"content":{"application/json":{"schema":{"description":"Email validation parameters page","required":["_embedded","_links"],"properties":{"_embedded":{"description":"Email validation parameters.","required":["id","status","valid","fraud_score"],"properties":{"id":{"description":"Email address","type":"string"},"status":{"description":"Is the email considered safe, suspicious, or high risk?","enum":["HIGH_RISK","SAFE","SUSPICIOUS","ERROR"],"type":"string"},"valid":{"description":"Does this email address appear valid?","type":"boolean"},"fraud_score":{"description":"The overall Fraud Score of the user based on the email's reputation and recent behavior across the system threat network. Fraud Scores >= 75 are suspicious, but not necessarily fraudulent.","format":"int32","type":"integer"},"disposable":{"description":"Is this email suspected of belonging to a temporary or disposable mail service? Usually associated with fraudsters and scammers.","type":"boolean"},"deliverability":{"description":"How likely is this email to be delivered to the user and land in their mailbox. Values can be \"high\", \"medium\", or \"low\".","type":"string"},"catch_all":{"description":"Is this email likely to be a \"catch all\" where the mail server verifies all emails tested against it as valid?","type":"boolean"},"leaked":{"description":"Was this email address associated with a recent database leak from a third party? Leaked accounts pose a risk as they may have become compromised during a database breach.","type":"boolean"},"suspect":{"description":"Indicates if the mail server is currently replying with a temporary error or if verification is unable to verify the address.","type":"boolean"},"smtp_score":{"description":"Validity score of email server's SMTP setup. Range: \"-1\" to \"3\". Scores above \"-1\" can be associated with a valid email. -1 = invalid email address, 0 = mail server exists but is rejecting all mail, 1 = mail server exists but is showing a temporary error, 2 = mail server exists but accepts all email, 3 = mail server exists and has verified the email address.","format":"int32","type":"integer"},"overall_score":{"description":"Overall email validity score. Range: \"0\" to \"4\". Scores above \"1\" can be associated with a valid email. 0 = invalid email address, 1 = dns valid unreachable mail server, 2 = dns valid temporary mail rejection error, 3 = dns valid accepts all mail, 4 = dns valid verified email exists.","format":"int32","type":"integer"},"first_name":{"description":"Suspected first name based on email. Returns \"CORPORATE\" if the email is suspected of being a generic company email. Returns \"UNKNOWN\" if the first name was not determinable.","type":"string"},"common":{"description":"Is this email from common free email providers? (gmail.com, yahoo.com, hotmail.com, etc.)","type":"boolean"},"generic":{"description":"Is this email suspected as being a catch all or shared email for a domain? (admin@, webmaster@, newsletter@, sales@, contact@, etc.)","type":"boolean"},"dns_valid":{"description":"Does the email's hostname have valid DNS entries? Partial indication of a valid email.","type":"boolean"},"honeypot":{"description":"Is this email believed to be a \"honeypot\" or \"SPAM trap\"? Bulk mail sent to these emails increases your risk of being blacklisted by large ISPs and ending up in the spam folder.","type":"boolean"},"spam_trap_score":{"description":"Intelligent confidence level of the email address being an active SPAM trap. Values can be \"high\", \"medium\", \"low\", or \"none\". We recommend scrubbing emails with a \"high\" status, typically for any promotional mailings.","type":"string"},"recent_abuse":{"description":"This value will indicate if there has been any recently verified abuse across our network for this email address. Abuse could be a confirmed chargeback, fake signup, compromised device, fake app install, or similar malicious behavior within the past few days.","type":"boolean"},"frequent_complainer":{"description":"Indicates if this email frequently unsubscribes from marketing lists or reports spam complaints.","type":"boolean"},"suggested_domain":{"description":"Default value is \"N/A\". Indicates if this email's domain should in fact be corrected to a popular mail service. This field is useful for catching user typos. For example, an email address with \"gmai.com\", would display a suggested domain of \"gmail.com\". This feature supports all major mail service providers.","type":"string"},"domain_velocity":{"description":"Indicates the level of legitimate users interacting with the email address domain. Values can be \"high\", \"medium\", \"low\", or \"none\". Domains like \"IBM.com\", \"Microsoft.com\", \"Gmail.com\", etc. will have \"high\" scores as this value represents popular domains. New domains or domains that are not frequently visited by legitimate users will have a value as \"none\". This field is restricted to upgraded plans.","type":"string"},"domain_trust":{"description":"Risk classification of the email's domain based on past abuse issues and positive behavior signals. Values include: \"trusted\", \"positive\", \"neutral\", \"suspicious\", \"malicious\", or \"not rated\".","type":"string"},"risky_tld":{"description":"Signals that the domain belongs to a risky TLD extension frequently associated with malware, scams, abuse, or phishing.","type":"boolean"},"spf_record":{"description":"Confirms if the domain has a proper SPF DNS record.","type":"boolean"},"dmarc_record":{"description":"Confirms if the domain has a proper DMARC DNS record.","type":"boolean"},"sanitized_email":{"description":"Sanitized email address with all aliases and masking removed, such as multiple periods for Gmail.com.","type":"string"},"timed_out":{"description":"Did the email verification connection to the mail service provider timeout?","type":"boolean"},"mx_records":{"description":"List of MX records associated with the email's domain name.","type":"array","items":{"type":"string"}},"a_records":{"description":"List of A records associated with the email's domain name.","type":"array","items":{"type":"string"}},"first_seen":{"description":"An object containing fields related to when the email address was first seen.","type":"object","required":["timestamp"],"properties":{"human":{"description":"A human description of the email address age, using an estimation of the email creation date when the system first discovered this email address. (e.g. \"3 months ago\")","type":"string","nullable":true},"timestamp":{"description":"The unix time since epoch when this email was first analyzed by the system. (e.g. 1568061634)","type":"integer"},"iso":{"description":"The time this email was first analyzed by the system in ISO8601 format. (e.g. \"2019-09-09T16:40:34-04:00\")","type":"string"}}},"domain_age":{"description":"An object containing fields related to when the domain was registered.","type":"object","required":["timestamp"],"properties":{"human":{"description":"A human description of when this domain was registered. (e.g. \"3 months ago\")","type":"string","nullable":true},"timestamp":{"description":"The unix time since epoch when this domain was first registered. (e.g. 1568061634)","type":"integer"},"iso":{"description":"The time this domain was registered in ISO8601 format. (e.g. \"2019-09-09T16:40:34-04:00\")","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"}},"required":["self"],"type":"object","description":"This page reference links"}},"type":"object"},"example":{"_embedded":{"id":"safe@example.com","status":"SAFE","valid":true,"fraud_score":10,"disposable":false,"deliverability":"high","catch_all":false,"leaked":false,"suspect":false,"smtp_score":3,"overall_score":4,"first_name":"Safe","common":true,"generic":false,"dns_valid":true,"honeypot":false,"spam_trap_score":"none","recent_abuse":false,"frequent_complainer":false,"suggested_domain":"N/A","domain_velocity":"high","domain_trust":"trusted","risky_tld":false,"spf_record":true,"dmarc_record":true,"sanitized_email":"safe@example.com","timed_out":false,"mx_records":["mx1.example.com","mx2.example.com"],"a_records":["93.184.216.34"],"first_seen":{"human":"3 months ago","timestamp":1568061634,"iso":"2019-09-09T16:40:34-04:00"},"domain_age":{"human":"25 years ago","timestamp":873936000,"iso":"1997-09-15T00:00:00-04:00"}},"_links":{"self":{"href":"https://api.talkdesk.com/identity/emailvalidations/safe%40example.com"}}}}},"description":"Email 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":"1910036","message":"Email quality service not available."}}},"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":"1910037","message":"Failed to contact email quality service."}}},"description":"Not Acceptable"},"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":"1910000","message":"An unknown error has occurred."}}},"description":"Internal Server Error"}},"security":[{"GA":["identity-email-validation:read"]}],"summary":"Get an email address validation","tags":["Identity API"]}},"/identity/emailvalidations/{email}/stats":{"get":{"description":"Returns aggregated statistics about how often a given email address has been validated within the current account.\nUse this endpoint to drive reuse and throttling decisions on the caller side, for example to avoid issuing redundant validation calls for emails already checked many times.
    \nThe lookup is local to the account and does not call the external validation provider, so it is not billable and is safe to call frequently.\nThe optional interaction_id query parameter is used purely for correlation in logs and does not affect the returned counts.\nCounts only cover validations performed via the validation endpoint; emails never validated return zero.","operationId":"getEmailValidationStats","parameters":[{"name":"email","in":"path","description":"Email address","required":true,"schema":{"type":"string"},"example":"user@example.com"}],"responses":{"200":{"content":{"application/json":{"schema":{"description":"Email validation stats parameters page","properties":{"_embedded":{"description":"Email validation stats.","properties":{"email":{"description":"Email address","type":"string"},"number_validations_last_24h":{"description":"The number of validations that have been performed on this email 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":{"email":"safe@example.com","number_validations_last_24h":3},"_links":{"self":{"href":"https://api-docs.talkdesk.org/identity/emailvalidations/safe%40example.com/stats"}}}}},"description":"Email validation stats 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-email-validation:read"]}],"summary":"Get an email address validation stats","tags":["Identity API"]}},"/identity/ipvalidations/{ip}":{"get":{"description":"Returns reputation and risk information for an IP address, such as geolocation and fraud signals.\nUse this endpoint to inspect an IP address before deciding how to handle the corresponding contact, for example to flag high-risk addresses before triggering downstream workflows.
    \nThe IP address is passed in the URL path.\nEach validation is billable for accounts with an active Identity license.","operationId":"getIpValidation","parameters":[{"name":"ip","in":"path","description":"IP address","required":true,"schema":{"type":"string"},"example":"8.8.8.8"}],"responses":{"200":{"content":{"application/json":{"schema":{"description":"IP validation parameters page","required":["_embedded","_links"],"properties":{"_embedded":{"description":"IP validation parameters.","required":["id","status","fraud_score"],"properties":{"id":{"description":"IP address","type":"string"},"status":{"description":"Is the IP considered safe, suspicious, or high risk?","enum":["HIGH_RISK","SAFE","SUSPICIOUS","ERROR"],"type":"string"},"fraud_score":{"description":"The overall fraud score of the user based on the IP, user agent, language, and any other optionally passed variables. Fraud Scores >= 75 are suspicious, but not necessarily fraudulent. We recommend flagging or blocking traffic with Fraud Scores >= 90, but you may find it beneficial to use a higher or lower threshold.","format":"int32","type":"integer"},"country_code":{"description":"Two character country code of IP address or \"N/A\" if unknown.","type":"string"},"region":{"description":"Region (state) of IP address if available or \"N/A\" if unknown.","type":"string"},"city":{"description":"City of IP address if available or \"N/A\" if unknown.","type":"string"},"isp":{"description":"ISP if one is known. Otherwise \"N/A\".","type":"string"},"asn":{"description":"Autonomous System Number if one is known. Null if nonexistent.","format":"int32","type":"integer"},"organization":{"description":"Organization if one is known. Can be parent company or sub company of the listed ISP. Otherwise \"N/A\".","type":"string"},"is_crawler":{"description":"Is this IP associated with being a confirmed crawler from any of the following search engines, based on hostname or IP address verification: Baidu, Google, Bing, Yahoo, Yandex, Sogou, Exabot, DuckDuckGo, Facebook, Twitter, Pinterest, Naver, UptimeRobot, AppleBot, ArchiveBot, CoccocBot, YisouBot, PetalBot, ByteDance, and MailRU.","type":"boolean"},"timezone":{"description":"Timezone of IP address if available or \"N/A\" if unknown.","type":"string"},"host":{"description":"Hostname of the IP address if one is available.","type":"string"},"proxy":{"description":"Is this IP address suspected to be a proxy? (SOCKS, Elite, Anonymous, VPN, Tor, etc.)","type":"boolean"},"vpn":{"description":"Is this IP suspected of being a VPN connection? This can include data center ranges which can become active VPNs at any time. The \"proxy\" status will always be true when this value is true.","type":"boolean"},"tor":{"description":"Is this IP suspected of being a TOR connection? This can include previously active TOR nodes and exits which can become active TOR exits at any time. The \"proxy\" status will always be true when this value is true.","type":"boolean"},"active_vpn":{"description":"Identifies active VPN connections used by popular VPN services and private VPN servers.","type":"boolean"},"active_tor":{"description":"Identifies active TOR exits on the TOR network.","type":"boolean"},"recent_abuse":{"description":"This value will indicate if there has been any recently verified abuse across our network for this IP address. Abuse could be a confirmed chargeback, account takeover attack, compromised device, fake application or registration, digital impersonation (stolen user data), bot attack, or similar malicious behavior within the past few days.","type":"boolean"},"bot_status":{"description":"Indicates if bots or non-human traffic has recently used this IP address to engage in automated fraudulent behavior. Provides stronger confidence that the IP address is suspicious.","type":"boolean"},"connection_type":{"description":"Classification of the IP address connection type as \"Residential\", \"Corporate\", \"Education\", \"Mobile\", or \"Data Center\".","type":"string"},"abuse_velocity":{"description":"How frequently the IP address is engaging in abuse. Values can be \"high\", \"medium\", \"low\", or \"none\". Can be used in combination with the Fraud Score to identify bad behavior.","type":"string"},"shared_connection":{"description":"Designates IP addresses which are likely to have more than a few users active on the IP address at the same time, such as mobile networks, corporate exit points, and similar connections. This can also include libraries, coffee shops, hotel lobbies, dormitories, hospitals and medical centers, company VPNs, etc.","type":"boolean"},"dynamic_connection":{"description":"Indicates IP addresses with dynamic assignment protocols, which means that a user on this IP address will likely be assigned a different IP address by this provider in the near future.","type":"boolean"},"frequent_abuser":{"description":"Identifies IP addresses with a consistent history of abusive behavior across 6 months or more. This data point can be helpful in identifying anonymous IP addresses which are frequently used for malicious behavior, compared to an IP address that may be briefly compromised by malware and only temporarily active in a botnet or residential proxy network.","type":"boolean"},"high_risk_attacks":{"description":"Confirms if this IP address has engaged in malicious abuse such as phishing, brute forcing, DDoS, credential stuffing & account takeover, scraping, form submission spam, and similar attacks. This data point has a high correlation with anonymous proxies, open proxies, public VPNs, and easily accessible anonymizers.","type":"boolean"},"security_scanner":{"description":"Indicates a verified online security scanner or endpoint by a trusted security vendor such as Tenable, Qualys, and similar providers.","type":"boolean"},"trusted_network":{"description":"Identifies company networks and corporate access points which have low abuse rates and high security protocols. IP addresses on these networks may still be compromised by malware, however the network overall will be considered trusted if this value is true.","type":"boolean"},"zip_code":{"description":"Postal code of IP address if available or \"N/A\" if unknown.","type":"string"},"latitude":{"description":"Latitude of IP address if available or null if unknown.","format":"float","type":"number"},"longitude":{"description":"Longitude of IP address if available or null if unknown.","format":"float","type":"number"}},"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"}},"required":["self"],"type":"object","description":"This page reference links"}},"type":"object"},"example":{"_embedded":{"id":"8.8.8.8","status":"SAFE","fraud_score":0,"country_code":"US","region":"California","city":"Mountain View","isp":"Google LLC","asn":15169,"organization":"Google LLC","is_crawler":false,"timezone":"America/Los_Angeles","host":"dns.google","proxy":false,"vpn":false,"tor":false,"active_vpn":false,"active_tor":false,"recent_abuse":false,"bot_status":false,"connection_type":"Corporate","abuse_velocity":"none","shared_connection":false,"dynamic_connection":false,"frequent_abuser":false,"high_risk_attacks":false,"security_scanner":false,"trusted_network":true,"zip_code":"94035","latitude":37.405991,"longitude":-122.078514},"_links":{"self":{"href":"https://api.talkdesk.com/identity/ipvalidations/8.8.8.8"}}}}},"description":"IP 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":"1910038","message":"IP quality service not available."}}},"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":"1910039","message":"Failed to contact IP quality service."}}},"description":"Not Acceptable"},"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":"1910000","message":"An unknown error has occurred."}}},"description":"Internal Server Error"}},"security":[{"GA":["identity-ip-validation:read"]}],"summary":"Get an IP address validation","tags":["Identity API"]}},"/identity/phonevalidations/{phone_number}":{"get":{"description":"Returns reputation and quality information for a phone number, such as fraud and risk signals.\nUse this endpoint to inspect a phone number before deciding how to handle the corresponding contact, for example to flag suspicious callers or to route low-risk numbers through a faster path.
    \nThe phone number must be provided in E.164-style format.\nEach validation is billable for accounts with an active Identity license.\nFor aggregate usage information, use the stats variant of this endpoint instead.","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"},"name":{"description":"The name of the owner associated with the phone number, such as the first or last name or business name assigned to the phone number. Might return multiple names in comma-separated format. Value is \"N/A\" if unknown.","type":"string"},"city":{"description":"City of the phone number if available or \"N/A\" if unknown.","type":"string"},"region":{"description":"Region (state) of the phone number if available or \"N/A\" if unknown.","type":"string"},"zip_code":{"description":"Zip or Postal code of the phone number if available or \"N/A\" if unknown.","type":"string"},"timezone":{"description":"Time zone of the phone number if available or \"N/A\" if unknown.","type":"string"},"do_not_call":{"description":"Indicates if the phone number is listed on any Do Not Call (DNC) lists. This parameter is only supported in the USA and Canada.","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"},"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"},"tcpa_blacklist":{"description":"Indicates if the phone number is known to be or associated with repeated TCPA plaintiffs (individuals who frequently file TCPA lawsuits).","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":"+17025551234","status":"SAFE","valid":true,"active":"true","fraud_score":10,"recent_abuse":"true","voip":"true","prepaid":"true","risky":"true","carrier":"Verizon","line_type":"Wireless","country":"US","name":"Joseph Pinetrees","city":"Las Vegas","region":"Nevada","zip_code":"89132","timezone":"America/Los_Angeles","do_not_call":"false","tcpa_blacklist":"false","success":true},"_links":{"self":{"href":"https://api-docs.talkdesk.org/identity/phonevalidations/%2B17025551234"}}}}},"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 API"]}},"/identity/phonevalidations/{phone_number}/stats":{"get":{"description":"Returns aggregated statistics about how often a given phone number has been validated within the current account.\nUse this endpoint to drive reuse and throttling decisions on the caller side, for example to avoid issuing redundant validation calls for numbers already checked many times.
    \nThe lookup is local to the account and does not call the external validation provider, so it is not billable and is safe to call frequently.\nThe optional interaction_id query parameter is used purely for correlation in logs and does not affect the returned counts.\nCounts only cover validations performed via the validation endpoint; numbers never validated return zero.","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 API"]}},"/interactions/{interaction_id}/actions/start_recording":{"post":{"operationId":"interactions-interaction-id-actions-start-recording-post","summary":"Start recording for ongoing interaction","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":["Omnichannel API"],"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":{"operationId":"interactions-interaction-id-actions-pause-recording-post","summary":"Pause recording for ongoing interaction","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":["Omnichannel API"],"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":{"operationId":"interactions-interaction-id-announcement-post","summary":"Play an announcement in an interaction","description":"Play an announcement in an interaction. Example -> Play a beep to announce that the call is being recorded.","x-internal":true,"security":[{"EarlyAccess":["interactions-announcement:write"]}],"parameters":[{"name":"interaction_id","in":"path","description":"The id of the interaction","required":true,"schema":{"type":"string"}}],"tags":["Omnichannel API"],"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":{"operationId":"messages-post","summary":"SMS Message Delivery","description":"Sends an outbound SMS message to a contact phone number using a Talkdesk phone number. The request is processed asynchronously and returns a 202 status on acceptance. Use this endpoint to programmatically deliver SMS notifications or messages to contacts. Phone numbers must be in E.164 format when provided.","x-internal":true,"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":{"operationId":"getAccountNumbers","deprecated":true,"summary":"Get account numbers","description":"[DEPRECATED: use Phone Details API instead] Get numbers belonging to the account","x-internal":true,"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":{"operationId":"getNumberDetail","deprecated":true,"summary":"Get number details","description":"[DEPRECATED: use Phone Details API instead] Get number details given a unique identification","x-internal":true,"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":{"operationId":"oauth-token-post","servers":[{"url":"https://{account_name}.talkdeskid.com","description":"United States (td-us-1)","variables":{"account_name":{"default":"account-name","description":"The customer's Talkdesk account subdomain."}}}],"summary":"Obtain a new access token","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.","minLength":1,"maxLength":32,"enum":["opaque"]},"expires_in":{"type":"integer","description":"Lifetime of the requested token, expressed in seconds. Optional, and only applicable when requesting service tokens. Min: 1 day (86400 seconds). Max: 1 year (31556952 seconds)","minimum":86400,"maximum":31556952},"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://myapp.example.com/oauth/callback","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":{"operationId":"oauth-authorize-get","servers":[{"url":"https://{account_name}.talkdeskid.com","description":"United States (td-us-1)","variables":{"account_name":{"default":"account-name","description":"The customer's Talkdesk account subdomain."}}}],"summary":"Obtain a new authorization code","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":{"operationId":"oauth-introspect-post","servers":[{"url":"https://{account_name}.talkdeskid.com","description":"United States (td-us-1)","variables":{"account_name":{"default":"account-name","description":"The customer's Talkdesk account subdomain."}}}],"summary":"Obtain a service token status","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":{"servers":[{"url":"https://{account_name}.talkdeskid.com","description":"United States (td-us-1)","variables":{"account_name":{"default":"account-name","description":"The customer's Talkdesk account subdomain."}}}],"operationId":"getPublicServerJwkSet","summary":"Obtains the public server JWK set","description":"Obtains the public server JWK set URL.","deprecated":true,"x-internal":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":{"operationId":"oauth-2023-10-certs-get","servers":[{"url":"https://{account_name}.talkdeskid.com","description":"United States (td-us-1)","variables":{"account_name":{"default":"account-name","description":"The customer's Talkdesk account subdomain."}}}],"summary":"Obtains the public server JWK set","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":{"operationId":"oauth-end-user-session-post","summary":"Terminates all of the user's sessions","description":"Terminates all active and inactive sessions for the specified user.","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","minLength":1,"maxLength":64,"enum":["force_logout"]}}},"examples":{"Revoke User Session request":{"value":{"userId":"614cc2eb161fb0e416eb7288","reason":"force_logout"}}}}}}}},"/record-lists":{"get":{"operationId":"record-lists-get","summary":"List Record Lists","x-namespace":"/record-lists","tags":["Record Lists API"],"description":"Returns a paginated list of record lists for the account.\nUse this endpoint to retrieve all record lists with optional filtering by name, status, team, and campaign.\n","x-internal":false,"security":[{"GA":["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":{"operationId":"record-lists-post","summary":"Create a Record List","x-namespace":"/record-lists","tags":["Record Lists API"],"description":"Creates a new record list and returns a signed URL to upload a CSV file.\nUse this endpoint to create a list and upload contact records for outbound campaigns.\n","x-internal":false,"security":[{"GA":["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":{"operationId":"record-lists-id-get","summary":"Get Record List Details","x-namespace":"/record-lists","tags":["Record Lists API"],"description":"Returns the details of a specific record list.\nUse this endpoint to retrieve the full configuration and metadata of a list.\n","x-internal":false,"security":[{"GA":["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":{"operationId":"record-lists-id-patch","summary":"Update Record List Status","x-namespace":"/record-lists","tags":["Record Lists API"],"description":"Updates the status of a record list and starts file validation.\nUse this endpoint after uploading a CSV file to trigger processing.\n","x-internal":false,"security":[{"GA":["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":{"operationId":"record-lists-id-records-id-record-get","summary":"Get Record Details","x-namespace":"/record-lists/{id}/records/{id-record}","tags":["Record Lists API"],"description":"Returns the details of a specific record within a record list.\nUse this endpoint to retrieve a single record by its ID.\n","x-internal":false,"security":[{"GA":["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":{"operationId":"record-lists-id-records-id-record-delete","summary":"Delete a Record","x-namespace":"/record-lists/{id}/records/{id-record}","tags":["Record Lists API"],"description":"Deletes a specific record from a record list.\nUse this endpoint to permanently remove a single contact record.\n","x-internal":false,"security":[{"GA":["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":{"operationId":"record-lists-id-records-id-record-patch","summary":"Update a Record","x-namespace":"/record-lists","tags":["Record Lists API"],"description":"Updates a specific record within a record list.\nUse this endpoint to modify record properties such as phone number, name, or priority.\n","x-internal":false,"security":[{"GA":["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":{"operationId":"record-lists-id-records-get","summary":"Get a List of Records","x-namespace":"/record-lists","tags":["Record Lists API"],"description":"Returns a paginated list of records from a record list.\nUse this endpoint to retrieve all contact records with optional filtering, searching, and sorting.\n","x-internal":false,"security":[{"GA":["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":{"operationId":"record-lists-id-records-post","summary":"Create a Record","x-namespace":"/record-lists","tags":["Record Lists API"],"description":"Creates a new record in a record list.\nUse this endpoint to add a single contact record with phone number and optional metadata.\n","x-internal":false,"security":[{"GA":["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":{"operationId":"record-lists-id-records-delete","summary":"Delete Records by Phone Number","x-namespace":"/record-lists","tags":["Record Lists API"],"description":"Deletes all records matching a phone number from a record list.\nUse this endpoint to remove all contact records associated with a specific phone number.\n","x-internal":false,"security":[{"GA":["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":{"operationId":"record-lists-id-records-timezones-get","summary":"List Record Timezones","x-namespace":"/record-lists","tags":["Record Lists API"],"description":"Returns a paginated list of timezones present in a record list.\nUse this endpoint to view the timezone distribution of records in a list.\n","x-internal":false,"security":[{"GA":["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":{"operationId":"record-lists-id-external-records-delete","x-namespace":"/record-lists","summary":"Delete External Records","tags":["Record Lists API"],"description":"Deletes records from a record list by external provider and external ID.\nUse this endpoint to remove records that were imported from an external source.\n","x-internal":false,"security":[{"GA":["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}/records/bulks":{"post":{"operationId":"record-lists-id-records-bulks-post","x-namespace":"/record-lists","summary":"Create Multiple Records","tags":["Record Lists API"],"description":"Creates multiple records in a record list in a single request.\nUse this endpoint to bulk insert contact records.\n","x-internal":false,"security":[{"GA":["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":"Updates multiple records in a record list in a single request.\nUse this endpoint to bulk update contact record properties.\n","tags":["Record Lists API"],"x-internal":false,"security":[{"GA":["record-lists:manage"]}],"summary":"Update Multiple Records","operationId":"record-lists-id-records-bulks-patch","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

    "},"path":{"type":"string","description":"A JSON-Pointer"},"value":{"type":"object","description":"The value to be used within the operations.

    "}},"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":{"operationId":"record-lists-id-records-bulks-delete","x-namespace":"/record-lists","summary":"Bulk Delete Records","tags":["Record Lists API"],"description":"Deletes multiple records from a record list in a single request.\nUse this endpoint to bulk remove records by record IDs, phone numbers, or external provider references.\n","x-internal":false,"security":[{"GA":["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":{"operationId":"record-lists-id-upload-requests-post","summary":"Create Upload Request","x-namespace":"/record-lists","tags":["Record Lists API"],"description":"Creates a signed URL to upload a CSV file into an existing record list.\nUse this endpoint to add more records to an existing list via file upload.\n","x-internal":false,"security":[{"GA":["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":{"operationId":"record-lists-id-upload-requests-id-upload-request-patch","summary":"Update Upload Request","x-namespace":"/record-lists","tags":["Record Lists API"],"description":"Updates an upload request status and starts file validation.\nUse this endpoint after uploading a CSV file to trigger record processing. Optionally notifies via WebHook or Workspace notification when finished.\n","x-internal":false,"security":[{"GA":["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":{"operationId":"do-not-call-lists-post","summary":"Create a Do Not Call List","tags":["Campaign Management API"],"description":"Creates a new Do Not Call List and returns a signed URL to upload a CSV file.\nUse this endpoint to create a list and upload phone numbers that should not be contacted.\n","x-internal":false,"security":[{"GA":["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":{"operationId":"do-not-call-lists-get","summary":"List Do Not Call Lists","tags":["Campaign Management API"],"description":"Returns a paginated list of Do Not Call Lists for the account.\nUse this endpoint to retrieve all lists with optional filtering by name, status, team, and campaign.\n","x-internal":false,"security":[{"GA":["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.

    ","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":{"operationId":"do-not-call-lists-id-get","summary":"Get Do Not Call List Details","tags":["Campaign Management API"],"description":"Returns the details of a specific Do Not Call List.\nUse this endpoint to retrieve the full configuration and metadata of a list.\n","x-internal":false,"security":[{"GA":["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

    ","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."}}}}}}},"/interactions/{interaction_id}/recordings/{recording_id}":{"delete":{"operationId":"interactions-interaction-id-recordings-recording-id-delete","x-namespace":"/interactions","summary":"Delete a recording","description":"Permanently deletes the recording associated with the given recording ID and interaction ID.\n\nUse this endpoint to delete a specific recording from an interaction. The deletion is processed\nasynchronously — the request is accepted immediately and the recording file is removed in the background.\n\nImportant behavior:\n- Requires the `recordings:delete` OAuth scope.\n- Returns `204 No Content` on success (no response body).\n- Returns `404` if the recording does not exist or does not belong to the specified interaction.\n","security":[{"GA":["recordings:delete"]}],"parameters":[{"name":"interaction_id","in":"path","description":"The ID of the interaction that contains the recording","required":true,"schema":{"type":"string"}},{"name":"recording_id","in":"path","description":"The ID of the recording to delete","required":true,"schema":{"type":"string"}}],"tags":["Recordings API"],"responses":{"204":{"description":"Recording deleted successfully"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"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","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"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"}}}},"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":"0000000","message":"Internal Server Error"}}}}}}},"/recordings/{id}":{"get":{"operationId":"recordings-id-get","summary":"Get recording details","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 API"],"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":{"operationId":"recordings-id-media-get","summary":"Redirect to the recording file","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 API"],"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":{"operationId":"getReportJobs","deprecated":true,"x-internal":true,"summary":"Gets all jobs from a single type","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":["Explore API"],"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":{"operationId":"createReportJob","deprecated":true,"x-internal":true,"summary":"Creates a new report job","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":["Explore API"],"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":{"operationId":"getReportJobDetail","deprecated":true,"x-internal":true,"summary":"Get job report execution details","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":["Explore API"],"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":{"operationId":"deleteReportJob","deprecated":true,"x-internal":true,"summary":"Delete report job","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":["Explore API"],"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":{"operationId":"getReportJobResult","deprecated":true,"x-internal":true,"summary":"Get job report execution result","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":["Explore API"],"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":{"operationId":"deleteReportFile","deprecated":true,"x-internal":true,"summary":"Delete report file","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":["Explore API"],"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":{"operationId":"live-subscriptions-post-2","summary":"Subscribe to a New Stream","description":"Get real-time data via HTTP SSE notifications for Talkdesk Live. Subscribe for a new stream to receive live data updates.","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":{"operationId":"live-subscriptions-subscription-id-get-2","summary":"Get subscription","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":{"operationId":"live-subscriptions-subscription-id-stream-get","summary":"Connect to the subscription stream","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":{"operationId":"live-subscriptions-subscription-id-entries-id-put-2","summary":"Update query from subscription","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":{"operationId":"live-queries-get-2","summary":"List available queries","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":{"operationId":"users-get","summary":"Get list of users","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 API"],"x-talkdesk":{"mcp":{"profiles":["PUBLIC","INTERNAL"],"icon":"https://stg-cdn-talkdesk.talkdeskdev.com/cdn-assets/latest/talkdesk/product/app-icons/settings.svg","annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},"token-levels":["TENANT","USER"],"policies":[{"realm":"MAIN","level":"USER","policy":"agents.list.scoped"}],"realms":["MAIN","SUPPORT"]},"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":{"operationId":"get-user","summary":"Get user details","description":"Get User Details","security":[{"GA":["users:read"]}],"parameters":[{"name":"id","in":"path","description":"The user id","required":true,"schema":{"type":"string"}}],"tags":["Users API"],"x-talkdesk":{"mcp":{"profiles":["PUBLIC","INTERNAL"],"icon":"https://stg-cdn-talkdesk.talkdeskdev.com/cdn-assets/latest/talkdesk/product/app-icons/settings.svg","annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},"token-levels":["TENANT","USER"],"policies":[{"realm":"MAIN","level":"USER","policy":"agents.list.scoped"}],"realms":["MAIN","SUPPORT"]},"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":"Returns a paginated list of attributes assigned to a specific user.\nUse this endpoint to retrieve the full set of skills or capabilities for a given agent, for example when displaying a user profile or checking eligibility for specific queues.\nFor team-scoped users, both the user and the attributes must be within their team scope.","security":[{"GA":["attributes:read"]}],"summary":"User Attributes List","tags":["Attributes API"],"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 or user not within team scope.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Insufficient permissions":{"value":{"code":"0360003","message":"Forbidden."}},"Forbidden user":{"value":{"code":"0360006","message":"You're not authorized to access this user's attribute."}}}}}},"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":{"operationId":"users-id-presence-get","summary":"Get user presence","description":"Get user presence.","deprecated":true,"x-internal":true,"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":{"operationId":"users-id-presence-post","summary":"Subscribe to user presence","description":"Subscribe to user presence","deprecated":true,"x-internal":true,"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":{"operationId":"users-id-presence-status-put","summary":"Update user presence status","description":"Update user presence status","deprecated":true,"x-internal":true,"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":{"operationId":"users-id-presence-occupancy-patch","summary":"Change user occupancy","description":"Change user occupancy","deprecated":true,"x-internal":true,"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":{"operationId":"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 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"}}}}}},"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":{"operationId":"users-me","summary":"Get user info (OpenID Connect)","description":"User info endpoint as per the OpenId Connect spec","security":[{"GA":["openid"]}],"tags":["Users API"],"x-talkdesk":{"mcp":{"profiles":["PUBLIC","INTERNAL"],"icon":"https://stg-cdn-talkdesk.talkdeskdev.com/cdn-assets/latest/talkdesk/product/app-icons/settings.svg","annotations":{"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},"token-levels":["USER"],"realms":["MAIN","ENGINEERING","SUPPORT"]},"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":{"operationId":"users-email-recordings-pause-post","summary":"Pause a recording given a contact","description":"Pause a recording given a contact person's email from an ongoing interaction.","deprecated":true,"security":[{"Deprecated":["interactions:control-recordings"]}],"parameters":[{"name":"email","in":"path","description":"The email of the contact person","required":true,"schema":{"type":"string"}}],"tags":["Users API"],"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":{"operationId":"users-email-recordings-start-post","summary":"Start a recording given a contact","description":"Start a recording given a contact person's email from an ongoing interaction.","deprecated":true,"security":[{"Deprecated":["interactions:control-recordings"]}],"parameters":[{"name":"email","in":"path","description":"The email of the contact person","required":true,"schema":{"type":"string"}}],"tags":["Users API"],"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":{"operationId":"users-id-disposition-settings-patch","summary":"Update user disposition settings","description":"Update user dispositions settings for the user","x-namespace":"/users","x-internal":true,"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 API"],"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 API"]},"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"]}}}},"x-talkdesk":{"mcp":{"profiles":["PUBLIC","INTERNAL"],"icon":"https://stg-cdn-talkdesk.talkdeskdev.com/cdn-assets/latest/talkdesk/product/app-icons/people.svg","annotations":{"readOnlyHint":false,"destructiveHint":false,"idempotentHint":false,"openWorldHint":false}},"token-levels":["TENANT","USER"],"policies":[{"realm":"MAIN","level":"USER","policy":"agents.create"}],"realms":["MAIN"]},"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 API"]}},"/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"}],"x-talkdesk":{"mcp":{"profiles":["PUBLIC","INTERNAL"],"icon":"https://stg-cdn-talkdesk.talkdeskdev.com/cdn-assets/latest/talkdesk/product/app-icons/people.svg","annotations":{"readOnlyHint":false,"destructiveHint":true,"idempotentHint":true,"openWorldHint":false}},"token-levels":["TENANT","USER"],"policies":[{"realm":"MAIN","level":"USER","policy":"agents.delete"}],"realms":["MAIN"]},"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 API"]},"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":"User Details","tags":["SCIM API"]},"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 API"]},"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"]}}}},"x-talkdesk":{"mcp":{"profiles":["PUBLIC","INTERNAL"],"icon":"https://stg-cdn-talkdesk.talkdeskdev.com/cdn-assets/latest/talkdesk/product/app-icons/people.svg","annotations":{"readOnlyHint":false,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},"token-levels":["TENANT","USER"],"policies":[{"realm":"MAIN","level":"USER","policy":"agents.update"}],"realms":["MAIN"]},"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 API"]}},"/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 API"]}},"/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 API"]}},"/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 API"]}},"/scim/v2/Schemas":{"get":{"description":"Retrieve all schema definitions supported by the service provider","operationId":"getSchemas","security":[{"GA":["scim"]}],"parameters":[{"in":"query","name":"filter","schema":{"type":"string","minLength":1,"example":"id eq \"urn:ietf:params:scim:schemas:core:2.0:User\""},"description":"Filter schemas using SCIM filter syntax. Check http://www.simplecloud.info/ for full capability."}],"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 schema definitions","type":"array","items":{"description":"A SCIM schema definition describing the attributes of a resource type","type":"object","properties":{"id":{"description":"The schema's unique URI, e.g. \"urn:ietf:params:scim:schemas:core:2.0:User\"","type":"string"},"name":{"description":"The schema's human-readable name, e.g. \"User\"","type":"string"},"description":{"description":"The schema's human-readable description","type":"string"},"attributes":{"description":"The list of attribute definitions for the schema","type":"array","items":{"description":"A SCIM schema attribute definition","type":"object","required":["name","type"],"properties":{"name":{"description":"The attribute's name","type":"string"},"type":{"description":"The attribute's data type, e.g. \"string\", \"boolean\", \"complex\"","type":"string"},"multiValued":{"description":"Whether the attribute is multi-valued","type":"boolean"},"description":{"description":"The attribute's human-readable description","type":"string"},"required":{"description":"Whether the attribute is required","type":"boolean"},"mutability":{"description":"The attribute's mutability, e.g. \"readOnly\", \"readWrite\", \"immutable\"","type":"string"},"returned":{"description":"When the attribute is returned, e.g. \"always\", \"never\", \"default\", \"request\"","type":"string"},"uniqueness":{"description":"The attribute's uniqueness, e.g. \"none\", \"server\", \"global\"","type":"string"},"caseExact":{"description":"Whether string values are case-sensitive","type":"boolean"},"subAttributes":{"description":"Sub-attributes for complex attributes","type":"array","items":{"description":"A SCIM schema sub-attribute definition","type":"object","required":["name","type"],"properties":{"name":{"description":"The attribute's name","type":"string"},"type":{"description":"The attribute's data type, e.g. \"string\", \"boolean\", \"complex\"","type":"string"},"multiValued":{"description":"Whether the attribute is multi-valued","type":"boolean"},"description":{"description":"The attribute's human-readable description","type":"string"},"required":{"description":"Whether the attribute is required","type":"boolean"},"mutability":{"description":"The attribute's mutability, e.g. \"readOnly\", \"readWrite\", \"immutable\"","type":"string"},"returned":{"description":"When the attribute is returned, e.g. \"always\", \"never\", \"default\", \"request\"","type":"string"},"uniqueness":{"description":"The attribute's uniqueness, e.g. \"none\", \"server\", \"global\"","type":"string"},"caseExact":{"description":"Whether string values are case-sensitive","type":"boolean"}}}}}}},"meta":{"type":"object","description":"Schema metadata","properties":{"resourceType":{"description":"Resource's type","type":"string"},"location":{"description":"URL of the schema resource, e.g. https://api.talkdeskapp.com/scim/v2/Schemas/urn:ietf:params:scim:schemas:core:2.0:User","type":"string"}},"required":["resourceType","location"]}},"required":["id","name","attributes"]}},"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":[{"id":"urn:ietf:params:scim:schemas:core:2.0:User","name":"User","description":"User Account","attributes":[{"name":"userName","type":"string","multiValued":false,"description":"Unique identifier for the User","required":true,"mutability":"readWrite","returned":"default","uniqueness":"server","caseExact":false}],"meta":{"resourceType":"Schema","location":"https://api.talkdeskapp.com/scim/v2/Schemas/urn:ietf:params:scim:schemas:core:2.0:User"}}],"totalResults":1,"startIndex":1,"itemsPerPage":1}},"application/scim+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 schema definitions","type":"array","items":{"description":"A SCIM schema definition describing the attributes of a resource type","type":"object","properties":{"id":{"description":"The schema's unique URI, e.g. \"urn:ietf:params:scim:schemas:core:2.0:User\"","type":"string"},"name":{"description":"The schema's human-readable name, e.g. \"User\"","type":"string"},"description":{"description":"The schema's human-readable description","type":"string"},"attributes":{"description":"The list of attribute definitions for the schema","type":"array","items":{"description":"A SCIM schema attribute definition","type":"object","required":["name","type"],"properties":{"name":{"description":"The attribute's name","type":"string"},"type":{"description":"The attribute's data type, e.g. \"string\", \"boolean\", \"complex\"","type":"string"},"multiValued":{"description":"Whether the attribute is multi-valued","type":"boolean"},"description":{"description":"The attribute's human-readable description","type":"string"},"required":{"description":"Whether the attribute is required","type":"boolean"},"mutability":{"description":"The attribute's mutability, e.g. \"readOnly\", \"readWrite\", \"immutable\"","type":"string"},"returned":{"description":"When the attribute is returned, e.g. \"always\", \"never\", \"default\", \"request\"","type":"string"},"uniqueness":{"description":"The attribute's uniqueness, e.g. \"none\", \"server\", \"global\"","type":"string"},"caseExact":{"description":"Whether string values are case-sensitive","type":"boolean"},"subAttributes":{"description":"Sub-attributes for complex attributes","type":"array","items":{"description":"A SCIM schema sub-attribute definition","type":"object","required":["name","type"],"properties":{"name":{"description":"The attribute's name","type":"string"},"type":{"description":"The attribute's data type, e.g. \"string\", \"boolean\", \"complex\"","type":"string"},"multiValued":{"description":"Whether the attribute is multi-valued","type":"boolean"},"description":{"description":"The attribute's human-readable description","type":"string"},"required":{"description":"Whether the attribute is required","type":"boolean"},"mutability":{"description":"The attribute's mutability, e.g. \"readOnly\", \"readWrite\", \"immutable\"","type":"string"},"returned":{"description":"When the attribute is returned, e.g. \"always\", \"never\", \"default\", \"request\"","type":"string"},"uniqueness":{"description":"The attribute's uniqueness, e.g. \"none\", \"server\", \"global\"","type":"string"},"caseExact":{"description":"Whether string values are case-sensitive","type":"boolean"}}}}}}},"meta":{"type":"object","description":"Schema metadata","properties":{"resourceType":{"description":"Resource's type","type":"string"},"location":{"description":"URL of the schema resource, e.g. https://api.talkdeskapp.com/scim/v2/Schemas/urn:ietf:params:scim:schemas:core:2.0:User","type":"string"}},"required":["resourceType","location"]}},"required":["id","name","attributes"]}},"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":[{"id":"urn:ietf:params:scim:schemas:core:2.0:User","name":"User","description":"User Account","attributes":[{"name":"userName","type":"string","multiValued":false,"description":"Unique identifier for the User","required":true,"mutability":"readWrite","returned":"default","uniqueness":"server","caseExact":false}],"meta":{"resourceType":"Schema","location":"https://api.talkdeskapp.com/scim/v2/Schemas/urn:ietf:params:scim:schemas:core:2.0:User"}}],"totalResults":1,"startIndex":1,"itemsPerPage":1}}}},"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 Schemas","tags":["SCIM API"]}},"/scim/v2/Schemas/{id}":{"get":{"description":"Retrieve a specific schema definition by its unique URI identifier","operationId":"getSchema","security":[{"GA":["scim"]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string","minLength":1},"required":true,"description":"The schema URI identifier, e.g. urn:ietf:params:scim:schemas:core:2.0:User"}],"responses":{"200":{"description":"The request has succeeded.","content":{"application/json":{"schema":{"description":"A SCIM schema definition describing the attributes of a resource type","type":"object","properties":{"id":{"description":"The schema's unique URI, e.g. \"urn:ietf:params:scim:schemas:core:2.0:User\"","type":"string"},"name":{"description":"The schema's human-readable name, e.g. \"User\"","type":"string"},"description":{"description":"The schema's human-readable description","type":"string"},"attributes":{"description":"The list of attribute definitions for the schema","type":"array","items":{"description":"A SCIM schema attribute definition","type":"object","required":["name","type"],"properties":{"name":{"description":"The attribute's name","type":"string"},"type":{"description":"The attribute's data type, e.g. \"string\", \"boolean\", \"complex\"","type":"string"},"multiValued":{"description":"Whether the attribute is multi-valued","type":"boolean"},"description":{"description":"The attribute's human-readable description","type":"string"},"required":{"description":"Whether the attribute is required","type":"boolean"},"mutability":{"description":"The attribute's mutability, e.g. \"readOnly\", \"readWrite\", \"immutable\"","type":"string"},"returned":{"description":"When the attribute is returned, e.g. \"always\", \"never\", \"default\", \"request\"","type":"string"},"uniqueness":{"description":"The attribute's uniqueness, e.g. \"none\", \"server\", \"global\"","type":"string"},"caseExact":{"description":"Whether string values are case-sensitive","type":"boolean"},"subAttributes":{"description":"Sub-attributes for complex attributes","type":"array","items":{"description":"A SCIM schema sub-attribute definition","type":"object","required":["name","type"],"properties":{"name":{"description":"The attribute's name","type":"string"},"type":{"description":"The attribute's data type, e.g. \"string\", \"boolean\", \"complex\"","type":"string"},"multiValued":{"description":"Whether the attribute is multi-valued","type":"boolean"},"description":{"description":"The attribute's human-readable description","type":"string"},"required":{"description":"Whether the attribute is required","type":"boolean"},"mutability":{"description":"The attribute's mutability, e.g. \"readOnly\", \"readWrite\", \"immutable\"","type":"string"},"returned":{"description":"When the attribute is returned, e.g. \"always\", \"never\", \"default\", \"request\"","type":"string"},"uniqueness":{"description":"The attribute's uniqueness, e.g. \"none\", \"server\", \"global\"","type":"string"},"caseExact":{"description":"Whether string values are case-sensitive","type":"boolean"}}}}}}},"meta":{"type":"object","description":"Schema metadata","properties":{"resourceType":{"description":"Resource's type","type":"string"},"location":{"description":"URL of the schema resource, e.g. https://api.talkdeskapp.com/scim/v2/Schemas/urn:ietf:params:scim:schemas:core:2.0:User","type":"string"}},"required":["resourceType","location"]}},"required":["id","name","attributes"]},"example":{"id":"urn:ietf:params:scim:schemas:core:2.0:User","name":"User","description":"User Account","attributes":[{"name":"userName","type":"string","multiValued":false,"description":"Unique identifier for the User","required":true,"mutability":"readWrite","returned":"default","uniqueness":"server","caseExact":false}],"meta":{"resourceType":"Schema","location":"https://api.talkdeskapp.com/scim/v2/Schemas/urn:ietf:params:scim:schemas:core:2.0:User"}}},"application/scim+json":{"schema":{"description":"A SCIM schema definition describing the attributes of a resource type","type":"object","properties":{"id":{"description":"The schema's unique URI, e.g. \"urn:ietf:params:scim:schemas:core:2.0:User\"","type":"string"},"name":{"description":"The schema's human-readable name, e.g. \"User\"","type":"string"},"description":{"description":"The schema's human-readable description","type":"string"},"attributes":{"description":"The list of attribute definitions for the schema","type":"array","items":{"description":"A SCIM schema attribute definition","type":"object","required":["name","type"],"properties":{"name":{"description":"The attribute's name","type":"string"},"type":{"description":"The attribute's data type, e.g. \"string\", \"boolean\", \"complex\"","type":"string"},"multiValued":{"description":"Whether the attribute is multi-valued","type":"boolean"},"description":{"description":"The attribute's human-readable description","type":"string"},"required":{"description":"Whether the attribute is required","type":"boolean"},"mutability":{"description":"The attribute's mutability, e.g. \"readOnly\", \"readWrite\", \"immutable\"","type":"string"},"returned":{"description":"When the attribute is returned, e.g. \"always\", \"never\", \"default\", \"request\"","type":"string"},"uniqueness":{"description":"The attribute's uniqueness, e.g. \"none\", \"server\", \"global\"","type":"string"},"caseExact":{"description":"Whether string values are case-sensitive","type":"boolean"},"subAttributes":{"description":"Sub-attributes for complex attributes","type":"array","items":{"description":"A SCIM schema sub-attribute definition","type":"object","required":["name","type"],"properties":{"name":{"description":"The attribute's name","type":"string"},"type":{"description":"The attribute's data type, e.g. \"string\", \"boolean\", \"complex\"","type":"string"},"multiValued":{"description":"Whether the attribute is multi-valued","type":"boolean"},"description":{"description":"The attribute's human-readable description","type":"string"},"required":{"description":"Whether the attribute is required","type":"boolean"},"mutability":{"description":"The attribute's mutability, e.g. \"readOnly\", \"readWrite\", \"immutable\"","type":"string"},"returned":{"description":"When the attribute is returned, e.g. \"always\", \"never\", \"default\", \"request\"","type":"string"},"uniqueness":{"description":"The attribute's uniqueness, e.g. \"none\", \"server\", \"global\"","type":"string"},"caseExact":{"description":"Whether string values are case-sensitive","type":"boolean"}}}}}}},"meta":{"type":"object","description":"Schema metadata","properties":{"resourceType":{"description":"Resource's type","type":"string"},"location":{"description":"URL of the schema resource, e.g. https://api.talkdeskapp.com/scim/v2/Schemas/urn:ietf:params:scim:schemas:core:2.0:User","type":"string"}},"required":["resourceType","location"]}},"required":["id","name","attributes"]},"example":{"id":"urn:ietf:params:scim:schemas:core:2.0:User","name":"User","description":"User Account","attributes":[{"name":"userName","type":"string","multiValued":false,"description":"Unique identifier for the User","required":true,"mutability":"readWrite","returned":"default","uniqueness":"server","caseExact":false}],"meta":{"resourceType":"Schema","location":"https://api.talkdeskapp.com/scim/v2/Schemas/urn:ietf:params:scim:schemas:core:2.0: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"}}}}}},"404":{"description":"Schema 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":"Resource 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 Schema by ID","tags":["SCIM API"]}},"/data/reports/{type}/jobs":{"get":{"operationId":"data-reports-type-jobs-get","summary":"Get report jobs by type","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_schedule_change_history","wfm_contact_history_report_v2","wfm_dce_history_v3","advanced_dialer_calls_report","va_conversation_markers","case_sla_events","patient_interaction_report","digital_dnc","wfm_default_forecast_accuracy_report","wfm_shrinkage_report","wfm_over_under_report","wfm_adherence_percentage_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 API"],"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":{"operationId":"data-reports-type-jobs-post","summary":"Creates a new report job","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_schedule_change_history","wfm_contact_history_report_v2","wfm_dce_history_v3","advanced_dialer_calls_report","va_conversation_markers","case_sla_events","patient_interaction_report","digital_dnc","wfm_default_forecast_accuracy_report","wfm_shrinkage_report","wfm_over_under_report","wfm_adherence_percentage_report"]}}],"tags":["Explore API"],"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":{"operationId":"data-reports-type-jobs-id-get","summary":"Get job report execution details","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_schedule_change_history","wfm_contact_history_report_v2","wfm_dce_history_v3","advanced_dialer_calls_report","va_conversation_markers","case_sla_events","patient_interaction_report","digital_dnc","wfm_default_forecast_accuracy_report","wfm_shrinkage_report","wfm_over_under_report","wfm_adherence_percentage_report"]}},{"name":"id","in":"path","description":"The job id","required":true,"schema":{"type":"string"}}],"tags":["Explore API"],"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":{"operationId":"data-reports-type-files-id-get","summary":"Get job report execution result","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_schedule_change_history","wfm_contact_history_report_v2","wfm_dce_history_v3","advanced_dialer_calls_report","va_conversation_markers","case_sla_events","patient_interaction_report","digital_dnc","wfm_default_forecast_accuracy_report","wfm_shrinkage_report","wfm_over_under_report","wfm_adherence_percentage_report"]}},{"name":"id","in":"path","description":"The job id","required":true,"schema":{"type":"string"}}],"tags":["Explore API"],"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":{"operationId":"data-reports-type-files-id-delete","summary":"Delete a report","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","digital_dnc"]}},{"name":"id","in":"path","description":"The job id","required":true,"schema":{"type":"string"}}],"tags":["Explore API"],"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."}}}}}}},"/fsi/contacts/{contact_id}/accounts":{"get":{"operationId":"fsi-contacts-contact-id-accounts-get","tags":["FSI Integrations API"],"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","RECREATIONAL_VEHICLE_LOAN","BOAT_LOAN","MOTORCYCLE_LOAN","LINE_OF_CREDIT","LEASE","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":{"operationId":"fsi-contacts-contact-id-accounts-account-id-payoff-post","tags":["FSI Integrations API"],"summary":"Return Payoff Calculation","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":{"operationId":"fsi-contacts-get","tags":["FSI Integrations API"],"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":{"operationId":"fsi-contacts-contact-id-get","tags":["FSI Integrations API"],"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":{"operationId":"fsi-contacts-contact-id-cards-card-id-get","tags":["FSI Integrations API"],"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":{"operationId":"fsi-contacts-contact-id-cards-card-id-deactivation-post","tags":["FSI Integrations API"],"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":{"operationId":"fsi-contacts-contact-id-cards-card-id-activation-post","tags":["FSI Integrations API"],"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":{"operationId":"fsi-contacts-contact-id-cards-get","tags":["FSI Integrations API"],"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":{"operationId":"fsi-contacts-contact-id-payments-get","tags":["FSI Integrations API"],"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":{"operationId":"fsi-transfers-internal-post","tags":["FSI Integrations API"],"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":{"operationId":"fsi-transfers-external-post","tags":["FSI Integrations API"],"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":{"operationId":"fsi-transfers-international-post","tags":["FSI Integrations API"],"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":{"operationId":"fsi-stop-contact-id-payments-post","tags":["FSI Integrations API"],"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":{"operationId":"fsi-travel-notifications-post","tags":["FSI Integrations API"],"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":{"operationId":"fsi-checks-contact-id-search-post","tags":["FSI Integrations API"],"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":{"operationId":"fsi-contacts-contact-id-cards-card-id-replacecard-post","tags":["FSI Integrations API"],"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":{"operationId":"fsi-contacts-contact-id-payments-ach-post","tags":["FSI Integrations API"],"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":{"operationId":"fsi-unlock-contact-id-pin-generate-post","tags":["FSI Integrations API"],"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":{"operationId":"fsi-unlock-contact-id-pin-reset-post","tags":["FSI Integrations API"],"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":{"operationId":"fsi-decrypt-encrypt-key-encrypted-content-get","tags":["FSI Integrations API"],"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":{"operationId":"fsi-contacts-events-writeback-post","tags":["FSI Integrations API"],"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","event_date"],"properties":{"event_name":{"description":"event name","type":"string","maxLength":30},"event_date":{"description":"Event date in ISO 8601 date-time format (e.g. '2024-10-30T12:00:00Z' or '2024-10-30T12:00:00+08:00')","type":"string","format":"date-time","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-30T12:00:00Z","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":{"operationId":"fsi-contacts-contact-id-cards-card-id-spendlimits-get","tags":["FSI Integrations API"],"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":{"operationId":"fsi-contacts-contact-id-cards-card-id-spendlimits-put","tags":["FSI Integrations API"],"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"],"description":"Create a new event type.","summary":"Create 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 an event type","description":"Updates an existing automated notification event type by its ID. Use this endpoint to modify the event type configuration, such as its name or associated properties. The full event type object must be provided; partial updates are not supported.","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","description":"Deletes an automated notification event type by its ID. Use this endpoint to remove event types that are no longer needed. This operation cannot be reversed, and any rules referencing the deleted event type may be affected.","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","description":"Retrieves the details of a specific automated notification rule by its unique identifier. Use this endpoint to inspect a rule's configuration, conditions, and associated actions before making updates. Only rules belonging to the authenticated account are accessible.","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"],"description":"Subscribe or unsubscribe a topic or create a new subscription(subscribe)","summary":"Upsert Subscription","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"],"description":"Retrieve a subscription by id","summary":"Get a subscription 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":{"operationId":"fsi-contacts-contact-id-accounts-account-id-transactions-get","tags":["FSI Integrations API"],"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":["Financial Services Experience Cloud for Banking"],"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}/billing":{"get":{"tags":["HLS Providers"],"summary":"Get a patient's billing summary","description":"Retrieve billing summary for a given patient, including guarantor accounts, billing sections, transaction summaries, and charges.","operationId":"getPatientBillingSummary","security":[{"GA":["hls-patient-billing:read"]}],"parameters":[{"name":"patient_id","in":"path","required":true,"schema":{"type":"string","example":"enh2Q1c0oNRtWzXZrnG4tKw3"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","description":"Patient billing summary response containing the patient identifier and associated guarantor accounts.","properties":{"id":{"type":"string","description":"The unique identifier of the patient.","example":"enh2Q1c0oNRtWzXZrnG4tKw3"},"account_guarantors":{"type":"array","description":"List of guarantor accounts associated with the patient.","items":{"type":"object","description":"Billing summary for a guarantor account associated with a patient.","properties":{"id":{"type":"string","description":"The unique identifier of the guarantor account.","example":"2552"},"account_ids":{"type":"array","description":"List of EHR identifiers for the guarantor account.","items":{"type":"object","description":"An identifier with a type label used to reference EHR entities.","required":["id","type"],"properties":{"id":{"type":"string","description":"Identifier value.","example":"E100001"},"type":{"type":"string","description":"Identifier type (e.g., EPI, MRN, CSN, FHIR, INTERNAL).","example":"INTERNAL"}}}},"account_type":{"description":"The type of the guarantor account.","type":"object","properties":{"abbreviation":{"type":"string","description":"Short abbreviation for the category.","example":"P"},"number":{"type":"string","description":"Numeric code for the category.","example":"1"},"title":{"type":"string","description":"Full title of the category.","example":"Patient"}}},"billing_system":{"type":"string","description":"The billing system used for this account.","example":"SBO"},"credit_score":{"type":"string","description":"Credit score associated with the guarantor account.","example":"750"},"is_confidential_guarantor":{"type":"boolean","description":"Whether the guarantor is marked as confidential."},"is_paperless":{"type":"boolean","description":"Whether the guarantor is enrolled in paperless billing."},"owning_deployment_descriptor":{"type":"string","description":"Epic deployment descriptor that owns this account.","example":"MAIN"},"patient_is_guarantor":{"type":"boolean","description":"Whether the patient is also the guarantor."},"patients":{"type":"array","description":"List of patients associated with this guarantor account.","items":{"type":"object","description":"A patient associated with a guarantor billing account.","properties":{"date_of_birth":{"type":"string","format":"date","description":"Date of birth of the patient (yyyy-MM-dd).","example":"1980-04-15"},"legal_name":{"type":"string","description":"Legal name of the patient (Last, First format).","example":"Doe, John"},"preferred_name":{"type":"string","description":"Preferred name of the patient.","example":"John"},"legal_sex":{"description":"Legal sex of the patient.","type":"object","properties":{"abbreviation":{"type":"string","description":"Short abbreviation for the category.","example":"P"},"number":{"type":"string","description":"Numeric code for the category.","example":"1"},"title":{"type":"string","description":"Full title of the category.","example":"Patient"}}},"gender_identity":{"type":"string","description":"Gender identity of the patient.","example":"Male"},"ids":{"type":"array","description":"List of EHR identifiers for the patient.","items":{"type":"object","description":"An identifier with a type label used to reference EHR entities.","required":["id","type"],"properties":{"id":{"type":"string","description":"Identifier value.","example":"E100001"},"type":{"type":"string","description":"Identifier type (e.g., EPI, MRN, CSN, FHIR, INTERNAL).","example":"INTERNAL"}}}}}}},"professional_billing":{"description":"Professional (physician) billing section.","type":"object","properties":{"aging_summaries":{"type":"array","description":"List of aging bucket entries showing balance distribution over time.","items":{"type":"object","description":"A single aging bucket entry showing balance distribution over time.","properties":{"amount":{"type":"number","format":"double","description":"Balance amount for this aging bucket."},"display":{"type":"string","description":"Human-readable label for the aging bucket.","example":"Current"}}}},"balance_summary":{"description":"Summary of balances for this billing section.","type":"object","properties":{"amount_due":{"type":"number","format":"double","description":"Total amount currently due."},"balance_not_on_payment_plan":{"type":"number","format":"double","description":"Balance not included in a payment plan."},"balance_on_payment_plan":{"type":"number","format":"double","description":"Balance covered by an active payment plan."},"charge_total":{"type":"number","format":"double","description":"Total charges for this billing section."},"insurance_balance":{"type":"number","format":"double","description":"Balance owed by insurance."},"insurance_payment_adjustment_total":{"type":"number","format":"double","description":"Total insurance payment adjustments."},"patient_balance":{"type":"number","format":"double","description":"Balance owed by the patient."},"patient_payment_adjustment_total":{"type":"number","format":"double","description":"Total patient payment adjustments."},"total_balance":{"type":"number","format":"double","description":"Combined patient and insurance balance."}}},"last_payment":{"description":"Details of the most recent payment.","type":"object","properties":{"amount":{"type":"number","format":"double","description":"Payment amount."},"date":{"type":"string","format":"date","description":"Date the payment was made (yyyy-MM-dd).","example":"2026-03-01"},"description":{"type":"array","description":"Description lines of the payment.","example":["Patient payment"],"items":{"type":"string"}},"source":{"type":"string","description":"Source of the payment (e.g., Patient, Insurance)."},"code":{"type":"string","description":"Payment code."},"reference_number":{"type":"string","description":"Reference number for the payment."}}},"last_statement":{"description":"Details of the most recent billing statement.","type":"object","properties":{"balance":{"type":"number","format":"double","description":"Balance on the last statement."},"date":{"type":"string","format":"date","description":"Date the statement was issued (yyyy-MM-dd).","example":"2026-02-15"},"type":{"description":"Type of the statement.","type":"object","properties":{"abbreviation":{"type":"string","description":"Short abbreviation for the category.","example":"P"},"number":{"type":"string","description":"Numeric code for the category.","example":"1"},"title":{"type":"string","description":"Full title of the category.","example":"Patient"}}},"view_status":{"type":"boolean","description":"Indicates whether the statement has been viewed."}}},"message":{"type":"string","description":"Optional message associated with this billing section."},"outstanding_account":{"description":"Outstanding account balance details. Populated for hospital billing and single billing office sections.","type":"object","properties":{"bad_debt_balance":{"type":"number","format":"double","description":"Balance in bad debt."},"insurance_balance":{"type":"number","format":"double","description":"Balance owed by insurance."},"last_self_pay_payment_date":{"type":"string","format":"date","description":"Date of the last self-pay payment (yyyy-MM-dd).","example":"2026-03-15"},"last_statement_date":{"type":"string","format":"date","description":"Date of the last statement (yyyy-MM-dd).","example":"2026-02-28"},"patient_balance":{"type":"number","format":"double","description":"Balance owed by the patient."},"self_pay_followup_level":{"description":"Follow-up level for self-pay collections.","type":"object","properties":{"abbreviation":{"type":"string","description":"Short abbreviation for the category.","example":"P"},"number":{"type":"string","description":"Numeric code for the category.","example":"1"},"title":{"type":"string","description":"Full title of the category.","example":"Patient"}}},"total_balance":{"type":"number","format":"double","description":"Total outstanding balance."}}},"payment_plan":{"description":"Active payment plan details, if any.","type":"object","properties":{"amount_due":{"type":"number","format":"double","description":"Current amount due under the payment plan."},"monthly_amount_due":{"type":"number","format":"double","description":"Monthly payment amount."},"next_due_date":{"type":"string","format":"date","description":"Date the next payment is due (yyyy-MM-dd).","example":"2026-05-01"},"number_of_payments_left":{"type":"number","format":"double","description":"Number of remaining payments.","example":6},"original_amount":{"type":"number","format":"double","description":"Original total amount of the payment plan."},"remaining_amount":{"type":"number","format":"double","description":"Remaining balance of the payment plan."},"start_date":{"type":"string","format":"date","description":"Date the payment plan started (yyyy-MM-dd).","example":"2025-11-01"},"is_late":{"type":"boolean","description":"Whether the payment plan is past due."},"overdue_amount":{"type":"number","format":"double","description":"Amount overdue on the payment plan."}}},"statements":{"type":"array","description":"List of billing statements associated with this section.","items":{"type":"object","description":"A billing statement issued to the patient.","properties":{"balance":{"type":"number","format":"double","description":"Balance shown on this statement."},"date":{"type":"string","format":"date","description":"Date the statement was issued (yyyy-MM-dd).","example":"2026-02-15"},"type":{"description":"Type of the statement.","type":"object","properties":{"abbreviation":{"type":"string","description":"Short abbreviation for the category.","example":"P"},"number":{"type":"string","description":"Numeric code for the category.","example":"1"},"title":{"type":"string","description":"Full title of the category.","example":"Patient"}}},"view_status":{"type":"boolean","description":"Indicates whether the statement has been viewed."}}}},"transaction_summary":{"description":"Itemized transaction summary for this billing section.","type":"object","properties":{"insurance_balance":{"type":"number","format":"double","description":"Total balance owed by insurance across all patients and visits."},"patient_balance":{"type":"number","format":"double","description":"Total balance owed by the patient across all patients and visits."},"patients":{"type":"array","description":"List of patients with itemized transaction detail.","items":{"type":"object","description":"A patient with itemized transaction detail within a billing section.","properties":{"ids":{"type":"array","description":"List of EHR identifiers for the patient.","items":{"type":"object","description":"An identifier with a type label used to reference EHR entities.","required":["id","type"],"properties":{"id":{"type":"string","description":"Identifier value.","example":"E100001"},"type":{"type":"string","description":"Identifier type (e.g., EPI, MRN, CSN, FHIR, INTERNAL).","example":"INTERNAL"}}}},"insurance_balance":{"type":"number","format":"double","description":"Balance owed by insurance for this patient."},"patient_balance":{"type":"number","format":"double","description":"Balance owed by this patient."},"visits":{"type":"array","description":"List of visits with itemized transaction detail for this patient.","items":{"type":"object","description":"A clinical visit with itemized charge and balance information.","properties":{"insurance_balance":{"type":"number","format":"double","description":"Balance owed by insurance for this visit."},"patient_balance":{"type":"number","format":"double","description":"Balance owed by the patient for this visit."},"charges":{"type":"array","description":"List of charges associated with this visit.","items":{"type":"object","description":"An individual charge line within a visit.","properties":{"code":{"type":"string","description":"Procedure or charge code (e.g., CPT code).","example":"99213"},"date":{"type":"string","format":"date","description":"Date the charge was incurred (yyyy-MM-dd).","example":"2026-01-15"},"department_name":{"type":"string","description":"Name of the department where the charge originated.","example":"Cardiology"},"description":{"type":"string","description":"Human-readable description of the charge.","example":"Office Visit"},"original_amount":{"type":"number","format":"double","description":"Original billed amount for this charge."},"outstanding_amount":{"type":"number","format":"double","description":"Outstanding balance remaining for this charge."},"patient_amount":{"type":"number","format":"double","description":"Portion of the charge owed by the patient."},"insurance_amount":{"type":"number","format":"double","description":"Portion of the charge owed by insurance."},"payor_name":{"type":"string","description":"Name of the insurance payor responsible for the insurance portion.","example":"Aetna"},"provider_name":{"type":"string","description":"Name of the provider who rendered the service.","example":"Dr. Smith"}}}},"self_payment_adjustments":{"type":"array","description":"List of self-pay payment and adjustment entries for this visit.","items":{"type":"object","description":"A self-pay payment or adjustment entry associated with a visit charge.","properties":{"code":{"type":"string","description":"Payment or adjustment code."},"date":{"type":"string","format":"date","description":"Date of the payment or adjustment (yyyy-MM-dd).","example":"2026-03-10"},"description":{"type":"string","description":"Human-readable description of the payment or adjustment.","example":"Patient Payment"},"match_amount":{"type":"number","format":"double","description":"Matched payment or adjustment amount."},"reference_number":{"type":"string","description":"Reference number for the payment or adjustment."},"source":{"type":"string","description":"Source of the payment or adjustment."}}}}}}}}}},"debit_adjustments":{"description":"Debit adjustment summary for this billing section.","type":"object","properties":{"patient_balance":{"type":"number","format":"double","description":"Patient balance for debit adjustments."},"adjustments":{"type":"array","description":"List of debit adjustment entries.","items":{"type":"object","description":"A general adjustment entry associated with a transaction.","properties":{"date":{"type":"string","format":"date","description":"Date of the adjustment (yyyy-MM-dd).","example":"2026-03-05"},"amount":{"type":"number","format":"double","description":"Amount of the adjustment."},"description":{"type":"string","description":"Human-readable description of the adjustment.","example":"Insurance Adjustment"}}}}}},"undistributed_payment_adjustment":{"description":"Undistributed payment summary for this billing section.","type":"object","properties":{"patient_balance":{"type":"number","format":"double","description":"Patient balance for undistributed payments."},"payments_adjustments":{"type":"array","description":"List of undistributed payment adjustment entries.","items":{"type":"object","description":"A payment adjustment entry reducing or increasing the billed amount.","properties":{"date":{"type":"string","format":"date","description":"Date of the payment adjustment (yyyy-MM-dd).","example":"2026-03-08"},"amount":{"type":"number","format":"double","description":"Amount of the payment adjustment."},"description":{"type":"string","description":"Human-readable description of the payment adjustment.","example":"Contractual Adjustment"}}}}}}}}}},"hospital_billing":{"description":"Hospital billing section.","type":"object","properties":{"aging_summaries":{"type":"array","description":"List of aging bucket entries showing balance distribution over time.","items":{"type":"object","description":"A single aging bucket entry showing balance distribution over time.","properties":{"amount":{"type":"number","format":"double","description":"Balance amount for this aging bucket."},"display":{"type":"string","description":"Human-readable label for the aging bucket.","example":"Current"}}}},"balance_summary":{"description":"Summary of balances for this billing section.","type":"object","properties":{"amount_due":{"type":"number","format":"double","description":"Total amount currently due."},"balance_not_on_payment_plan":{"type":"number","format":"double","description":"Balance not included in a payment plan."},"balance_on_payment_plan":{"type":"number","format":"double","description":"Balance covered by an active payment plan."},"charge_total":{"type":"number","format":"double","description":"Total charges for this billing section."},"insurance_balance":{"type":"number","format":"double","description":"Balance owed by insurance."},"insurance_payment_adjustment_total":{"type":"number","format":"double","description":"Total insurance payment adjustments."},"patient_balance":{"type":"number","format":"double","description":"Balance owed by the patient."},"patient_payment_adjustment_total":{"type":"number","format":"double","description":"Total patient payment adjustments."},"total_balance":{"type":"number","format":"double","description":"Combined patient and insurance balance."}}},"last_payment":{"description":"Details of the most recent payment.","type":"object","properties":{"amount":{"type":"number","format":"double","description":"Payment amount."},"date":{"type":"string","format":"date","description":"Date the payment was made (yyyy-MM-dd).","example":"2026-03-01"},"description":{"type":"array","description":"Description lines of the payment.","example":["Patient payment"],"items":{"type":"string"}},"source":{"type":"string","description":"Source of the payment (e.g., Patient, Insurance)."},"code":{"type":"string","description":"Payment code."},"reference_number":{"type":"string","description":"Reference number for the payment."}}},"last_statement":{"description":"Details of the most recent billing statement.","type":"object","properties":{"balance":{"type":"number","format":"double","description":"Balance on the last statement."},"date":{"type":"string","format":"date","description":"Date the statement was issued (yyyy-MM-dd).","example":"2026-02-15"},"type":{"description":"Type of the statement.","type":"object","properties":{"abbreviation":{"type":"string","description":"Short abbreviation for the category.","example":"P"},"number":{"type":"string","description":"Numeric code for the category.","example":"1"},"title":{"type":"string","description":"Full title of the category.","example":"Patient"}}},"view_status":{"type":"boolean","description":"Indicates whether the statement has been viewed."}}},"message":{"type":"string","description":"Optional message associated with this billing section."},"outstanding_account":{"description":"Outstanding account balance details. Populated for hospital billing and single billing office sections.","type":"object","properties":{"bad_debt_balance":{"type":"number","format":"double","description":"Balance in bad debt."},"insurance_balance":{"type":"number","format":"double","description":"Balance owed by insurance."},"last_self_pay_payment_date":{"type":"string","format":"date","description":"Date of the last self-pay payment (yyyy-MM-dd).","example":"2026-03-15"},"last_statement_date":{"type":"string","format":"date","description":"Date of the last statement (yyyy-MM-dd).","example":"2026-02-28"},"patient_balance":{"type":"number","format":"double","description":"Balance owed by the patient."},"self_pay_followup_level":{"description":"Follow-up level for self-pay collections.","type":"object","properties":{"abbreviation":{"type":"string","description":"Short abbreviation for the category.","example":"P"},"number":{"type":"string","description":"Numeric code for the category.","example":"1"},"title":{"type":"string","description":"Full title of the category.","example":"Patient"}}},"total_balance":{"type":"number","format":"double","description":"Total outstanding balance."}}},"payment_plan":{"description":"Active payment plan details, if any.","type":"object","properties":{"amount_due":{"type":"number","format":"double","description":"Current amount due under the payment plan."},"monthly_amount_due":{"type":"number","format":"double","description":"Monthly payment amount."},"next_due_date":{"type":"string","format":"date","description":"Date the next payment is due (yyyy-MM-dd).","example":"2026-05-01"},"number_of_payments_left":{"type":"number","format":"double","description":"Number of remaining payments.","example":6},"original_amount":{"type":"number","format":"double","description":"Original total amount of the payment plan."},"remaining_amount":{"type":"number","format":"double","description":"Remaining balance of the payment plan."},"start_date":{"type":"string","format":"date","description":"Date the payment plan started (yyyy-MM-dd).","example":"2025-11-01"},"is_late":{"type":"boolean","description":"Whether the payment plan is past due."},"overdue_amount":{"type":"number","format":"double","description":"Amount overdue on the payment plan."}}},"statements":{"type":"array","description":"List of billing statements associated with this section.","items":{"type":"object","description":"A billing statement issued to the patient.","properties":{"balance":{"type":"number","format":"double","description":"Balance shown on this statement."},"date":{"type":"string","format":"date","description":"Date the statement was issued (yyyy-MM-dd).","example":"2026-02-15"},"type":{"description":"Type of the statement.","type":"object","properties":{"abbreviation":{"type":"string","description":"Short abbreviation for the category.","example":"P"},"number":{"type":"string","description":"Numeric code for the category.","example":"1"},"title":{"type":"string","description":"Full title of the category.","example":"Patient"}}},"view_status":{"type":"boolean","description":"Indicates whether the statement has been viewed."}}}},"transaction_summary":{"description":"Itemized transaction summary for this billing section.","type":"object","properties":{"insurance_balance":{"type":"number","format":"double","description":"Total balance owed by insurance across all patients and visits."},"patient_balance":{"type":"number","format":"double","description":"Total balance owed by the patient across all patients and visits."},"patients":{"type":"array","description":"List of patients with itemized transaction detail.","items":{"type":"object","description":"A patient with itemized transaction detail within a billing section.","properties":{"ids":{"type":"array","description":"List of EHR identifiers for the patient.","items":{"type":"object","description":"An identifier with a type label used to reference EHR entities.","required":["id","type"],"properties":{"id":{"type":"string","description":"Identifier value.","example":"E100001"},"type":{"type":"string","description":"Identifier type (e.g., EPI, MRN, CSN, FHIR, INTERNAL).","example":"INTERNAL"}}}},"insurance_balance":{"type":"number","format":"double","description":"Balance owed by insurance for this patient."},"patient_balance":{"type":"number","format":"double","description":"Balance owed by this patient."},"visits":{"type":"array","description":"List of visits with itemized transaction detail for this patient.","items":{"type":"object","description":"A clinical visit with itemized charge and balance information.","properties":{"insurance_balance":{"type":"number","format":"double","description":"Balance owed by insurance for this visit."},"patient_balance":{"type":"number","format":"double","description":"Balance owed by the patient for this visit."},"charges":{"type":"array","description":"List of charges associated with this visit.","items":{"type":"object","description":"An individual charge line within a visit.","properties":{"code":{"type":"string","description":"Procedure or charge code (e.g., CPT code).","example":"99213"},"date":{"type":"string","format":"date","description":"Date the charge was incurred (yyyy-MM-dd).","example":"2026-01-15"},"department_name":{"type":"string","description":"Name of the department where the charge originated.","example":"Cardiology"},"description":{"type":"string","description":"Human-readable description of the charge.","example":"Office Visit"},"original_amount":{"type":"number","format":"double","description":"Original billed amount for this charge."},"outstanding_amount":{"type":"number","format":"double","description":"Outstanding balance remaining for this charge."},"patient_amount":{"type":"number","format":"double","description":"Portion of the charge owed by the patient."},"insurance_amount":{"type":"number","format":"double","description":"Portion of the charge owed by insurance."},"payor_name":{"type":"string","description":"Name of the insurance payor responsible for the insurance portion.","example":"Aetna"},"provider_name":{"type":"string","description":"Name of the provider who rendered the service.","example":"Dr. Smith"}}}},"self_payment_adjustments":{"type":"array","description":"List of self-pay payment and adjustment entries for this visit.","items":{"type":"object","description":"A self-pay payment or adjustment entry associated with a visit charge.","properties":{"code":{"type":"string","description":"Payment or adjustment code."},"date":{"type":"string","format":"date","description":"Date of the payment or adjustment (yyyy-MM-dd).","example":"2026-03-10"},"description":{"type":"string","description":"Human-readable description of the payment or adjustment.","example":"Patient Payment"},"match_amount":{"type":"number","format":"double","description":"Matched payment or adjustment amount."},"reference_number":{"type":"string","description":"Reference number for the payment or adjustment."},"source":{"type":"string","description":"Source of the payment or adjustment."}}}}}}}}}},"debit_adjustments":{"description":"Debit adjustment summary for this billing section.","type":"object","properties":{"patient_balance":{"type":"number","format":"double","description":"Patient balance for debit adjustments."},"adjustments":{"type":"array","description":"List of debit adjustment entries.","items":{"type":"object","description":"A general adjustment entry associated with a transaction.","properties":{"date":{"type":"string","format":"date","description":"Date of the adjustment (yyyy-MM-dd).","example":"2026-03-05"},"amount":{"type":"number","format":"double","description":"Amount of the adjustment."},"description":{"type":"string","description":"Human-readable description of the adjustment.","example":"Insurance Adjustment"}}}}}},"undistributed_payment_adjustment":{"description":"Undistributed payment summary for this billing section.","type":"object","properties":{"patient_balance":{"type":"number","format":"double","description":"Patient balance for undistributed payments."},"payments_adjustments":{"type":"array","description":"List of undistributed payment adjustment entries.","items":{"type":"object","description":"A payment adjustment entry reducing or increasing the billed amount.","properties":{"date":{"type":"string","format":"date","description":"Date of the payment adjustment (yyyy-MM-dd).","example":"2026-03-08"},"amount":{"type":"number","format":"double","description":"Amount of the payment adjustment."},"description":{"type":"string","description":"Human-readable description of the payment adjustment.","example":"Contractual Adjustment"}}}}}}}}}},"single_billing_office":{"description":"Single billing office section, when combined billing applies.","type":"object","properties":{"aging_summaries":{"type":"array","description":"List of aging bucket entries showing balance distribution over time.","items":{"type":"object","description":"A single aging bucket entry showing balance distribution over time.","properties":{"amount":{"type":"number","format":"double","description":"Balance amount for this aging bucket."},"display":{"type":"string","description":"Human-readable label for the aging bucket.","example":"Current"}}}},"balance_summary":{"description":"Summary of balances for this billing section.","type":"object","properties":{"amount_due":{"type":"number","format":"double","description":"Total amount currently due."},"balance_not_on_payment_plan":{"type":"number","format":"double","description":"Balance not included in a payment plan."},"balance_on_payment_plan":{"type":"number","format":"double","description":"Balance covered by an active payment plan."},"charge_total":{"type":"number","format":"double","description":"Total charges for this billing section."},"insurance_balance":{"type":"number","format":"double","description":"Balance owed by insurance."},"insurance_payment_adjustment_total":{"type":"number","format":"double","description":"Total insurance payment adjustments."},"patient_balance":{"type":"number","format":"double","description":"Balance owed by the patient."},"patient_payment_adjustment_total":{"type":"number","format":"double","description":"Total patient payment adjustments."},"total_balance":{"type":"number","format":"double","description":"Combined patient and insurance balance."}}},"last_payment":{"description":"Details of the most recent payment.","type":"object","properties":{"amount":{"type":"number","format":"double","description":"Payment amount."},"date":{"type":"string","format":"date","description":"Date the payment was made (yyyy-MM-dd).","example":"2026-03-01"},"description":{"type":"array","description":"Description lines of the payment.","example":["Patient payment"],"items":{"type":"string"}},"source":{"type":"string","description":"Source of the payment (e.g., Patient, Insurance)."},"code":{"type":"string","description":"Payment code."},"reference_number":{"type":"string","description":"Reference number for the payment."}}},"last_statement":{"description":"Details of the most recent billing statement.","type":"object","properties":{"balance":{"type":"number","format":"double","description":"Balance on the last statement."},"date":{"type":"string","format":"date","description":"Date the statement was issued (yyyy-MM-dd).","example":"2026-02-15"},"type":{"description":"Type of the statement.","type":"object","properties":{"abbreviation":{"type":"string","description":"Short abbreviation for the category.","example":"P"},"number":{"type":"string","description":"Numeric code for the category.","example":"1"},"title":{"type":"string","description":"Full title of the category.","example":"Patient"}}},"view_status":{"type":"boolean","description":"Indicates whether the statement has been viewed."}}},"message":{"type":"string","description":"Optional message associated with this billing section."},"outstanding_account":{"description":"Outstanding account balance details. Populated for hospital billing and single billing office sections.","type":"object","properties":{"bad_debt_balance":{"type":"number","format":"double","description":"Balance in bad debt."},"insurance_balance":{"type":"number","format":"double","description":"Balance owed by insurance."},"last_self_pay_payment_date":{"type":"string","format":"date","description":"Date of the last self-pay payment (yyyy-MM-dd).","example":"2026-03-15"},"last_statement_date":{"type":"string","format":"date","description":"Date of the last statement (yyyy-MM-dd).","example":"2026-02-28"},"patient_balance":{"type":"number","format":"double","description":"Balance owed by the patient."},"self_pay_followup_level":{"description":"Follow-up level for self-pay collections.","type":"object","properties":{"abbreviation":{"type":"string","description":"Short abbreviation for the category.","example":"P"},"number":{"type":"string","description":"Numeric code for the category.","example":"1"},"title":{"type":"string","description":"Full title of the category.","example":"Patient"}}},"total_balance":{"type":"number","format":"double","description":"Total outstanding balance."}}},"payment_plan":{"description":"Active payment plan details, if any.","type":"object","properties":{"amount_due":{"type":"number","format":"double","description":"Current amount due under the payment plan."},"monthly_amount_due":{"type":"number","format":"double","description":"Monthly payment amount."},"next_due_date":{"type":"string","format":"date","description":"Date the next payment is due (yyyy-MM-dd).","example":"2026-05-01"},"number_of_payments_left":{"type":"number","format":"double","description":"Number of remaining payments.","example":6},"original_amount":{"type":"number","format":"double","description":"Original total amount of the payment plan."},"remaining_amount":{"type":"number","format":"double","description":"Remaining balance of the payment plan."},"start_date":{"type":"string","format":"date","description":"Date the payment plan started (yyyy-MM-dd).","example":"2025-11-01"},"is_late":{"type":"boolean","description":"Whether the payment plan is past due."},"overdue_amount":{"type":"number","format":"double","description":"Amount overdue on the payment plan."}}},"statements":{"type":"array","description":"List of billing statements associated with this section.","items":{"type":"object","description":"A billing statement issued to the patient.","properties":{"balance":{"type":"number","format":"double","description":"Balance shown on this statement."},"date":{"type":"string","format":"date","description":"Date the statement was issued (yyyy-MM-dd).","example":"2026-02-15"},"type":{"description":"Type of the statement.","type":"object","properties":{"abbreviation":{"type":"string","description":"Short abbreviation for the category.","example":"P"},"number":{"type":"string","description":"Numeric code for the category.","example":"1"},"title":{"type":"string","description":"Full title of the category.","example":"Patient"}}},"view_status":{"type":"boolean","description":"Indicates whether the statement has been viewed."}}}},"transaction_summary":{"description":"Itemized transaction summary for this billing section.","type":"object","properties":{"insurance_balance":{"type":"number","format":"double","description":"Total balance owed by insurance across all patients and visits."},"patient_balance":{"type":"number","format":"double","description":"Total balance owed by the patient across all patients and visits."},"patients":{"type":"array","description":"List of patients with itemized transaction detail.","items":{"type":"object","description":"A patient with itemized transaction detail within a billing section.","properties":{"ids":{"type":"array","description":"List of EHR identifiers for the patient.","items":{"type":"object","description":"An identifier with a type label used to reference EHR entities.","required":["id","type"],"properties":{"id":{"type":"string","description":"Identifier value.","example":"E100001"},"type":{"type":"string","description":"Identifier type (e.g., EPI, MRN, CSN, FHIR, INTERNAL).","example":"INTERNAL"}}}},"insurance_balance":{"type":"number","format":"double","description":"Balance owed by insurance for this patient."},"patient_balance":{"type":"number","format":"double","description":"Balance owed by this patient."},"visits":{"type":"array","description":"List of visits with itemized transaction detail for this patient.","items":{"type":"object","description":"A clinical visit with itemized charge and balance information.","properties":{"insurance_balance":{"type":"number","format":"double","description":"Balance owed by insurance for this visit."},"patient_balance":{"type":"number","format":"double","description":"Balance owed by the patient for this visit."},"charges":{"type":"array","description":"List of charges associated with this visit.","items":{"type":"object","description":"An individual charge line within a visit.","properties":{"code":{"type":"string","description":"Procedure or charge code (e.g., CPT code).","example":"99213"},"date":{"type":"string","format":"date","description":"Date the charge was incurred (yyyy-MM-dd).","example":"2026-01-15"},"department_name":{"type":"string","description":"Name of the department where the charge originated.","example":"Cardiology"},"description":{"type":"string","description":"Human-readable description of the charge.","example":"Office Visit"},"original_amount":{"type":"number","format":"double","description":"Original billed amount for this charge."},"outstanding_amount":{"type":"number","format":"double","description":"Outstanding balance remaining for this charge."},"patient_amount":{"type":"number","format":"double","description":"Portion of the charge owed by the patient."},"insurance_amount":{"type":"number","format":"double","description":"Portion of the charge owed by insurance."},"payor_name":{"type":"string","description":"Name of the insurance payor responsible for the insurance portion.","example":"Aetna"},"provider_name":{"type":"string","description":"Name of the provider who rendered the service.","example":"Dr. Smith"}}}},"self_payment_adjustments":{"type":"array","description":"List of self-pay payment and adjustment entries for this visit.","items":{"type":"object","description":"A self-pay payment or adjustment entry associated with a visit charge.","properties":{"code":{"type":"string","description":"Payment or adjustment code."},"date":{"type":"string","format":"date","description":"Date of the payment or adjustment (yyyy-MM-dd).","example":"2026-03-10"},"description":{"type":"string","description":"Human-readable description of the payment or adjustment.","example":"Patient Payment"},"match_amount":{"type":"number","format":"double","description":"Matched payment or adjustment amount."},"reference_number":{"type":"string","description":"Reference number for the payment or adjustment."},"source":{"type":"string","description":"Source of the payment or adjustment."}}}}}}}}}},"debit_adjustments":{"description":"Debit adjustment summary for this billing section.","type":"object","properties":{"patient_balance":{"type":"number","format":"double","description":"Patient balance for debit adjustments."},"adjustments":{"type":"array","description":"List of debit adjustment entries.","items":{"type":"object","description":"A general adjustment entry associated with a transaction.","properties":{"date":{"type":"string","format":"date","description":"Date of the adjustment (yyyy-MM-dd).","example":"2026-03-05"},"amount":{"type":"number","format":"double","description":"Amount of the adjustment."},"description":{"type":"string","description":"Human-readable description of the adjustment.","example":"Insurance Adjustment"}}}}}},"undistributed_payment_adjustment":{"description":"Undistributed payment summary for this billing section.","type":"object","properties":{"patient_balance":{"type":"number","format":"double","description":"Patient balance for undistributed payments."},"payments_adjustments":{"type":"array","description":"List of undistributed payment adjustment entries.","items":{"type":"object","description":"A payment adjustment entry reducing or increasing the billed amount.","properties":{"date":{"type":"string","format":"date","description":"Date of the payment adjustment (yyyy-MM-dd).","example":"2026-03-08"},"amount":{"type":"number","format":"double","description":"Amount of the payment adjustment."},"description":{"type":"string","description":"Human-readable description of the payment adjustment.","example":"Contractual Adjustment"}}}}}}}}}},"propensity_to_pay":{"description":"Propensity-to-pay category value for the guarantor.","type":"object","properties":{"abbreviation":{"type":"string","description":"Short abbreviation for the category.","example":"P"},"number":{"type":"string","description":"Numeric code for the category.","example":"1"},"title":{"type":"string","description":"Full title of the category.","example":"Patient"}}},"service_area":{"description":"The service area associated with the guarantor.","type":"object","properties":{"name":{"type":"string","description":"Name of the service area.","example":"EHS Service Area"},"ids":{"type":"array","description":"List of identifiers for the service area.","items":{"type":"object","description":"An identifier with a type label used to reference EHR entities.","required":["id","type"],"properties":{"id":{"type":"string","description":"Identifier value.","example":"E100001"},"type":{"type":"string","description":"Identifier type (e.g., EPI, MRN, CSN, FHIR, INTERNAL).","example":"INTERNAL"}}}}}}}}}}},"example":{"id":"enh2Q1c0oNRtWzXZrnG4tKw3","account_guarantors":[{"id":"46320","account_ids":[{"id":"46320","type":"INTERNAL"},{"id":"TYCAwhLwrD569B633CEa13RgyC74sSjVaYmllw8pt6HMB","type":"FHIR"}],"is_paperless":true,"billing_system":"SBO","patient_is_guarantor":false,"service_area":{"name":"EHS Service Area","ids":[{"id":"99","type":"INTERNAL"}]},"single_billing_office":{"aging_summaries":[{"display":"Current","amount":150}],"transaction_summary":{"insurance_balance":0,"patient_balance":150,"patients":[{"ids":[{"id":"P-001","type":"FHIR"}],"insurance_balance":0,"patient_balance":150,"visits":[{"insurance_balance":0,"patient_balance":150,"charges":[{"code":"99213","date":"2026-01-15","department_name":"Cardiology","description":"Office Visit","original_amount":300,"outstanding_amount":150,"patient_amount":150,"insurance_amount":0,"payor_name":"Aetna","provider_name":"Dr. Smith"}]}]}]}}}]}}}},"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":{"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}},{"name":"include_accumulators","in":"query","required":false,"description":"When `true`, the response includes insurance benefit accumulator data (deductibles, max-out-of-pocket limits, visit limits, etc.) in the `accumulators` field. Currently only supported for Epic-backed accounts; requesting accumulators for other providers returns a 400 Bad Request. Defaults to `false`.","schema":{"type":"boolean","default":false}}],"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). When `include_accumulators=true`, this may be enriched with the line-of-business name from the EHR accumulator data if available.","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). When `include_accumulators=true`, this may be enriched with the product type from the EHR accumulator data if available.","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"]}},"accumulators":{"description":"Insurance benefit accumulator data (deductibles, max-out-of-pocket limits, visit limits, etc.). Only present when the request includes `include_accumulators=true` and the provider supports it (currently Epic only).","type":"object","properties":{"combined_pharmacy_medical":{"type":"boolean","description":"Whether pharmacy (Rx) accumulators are co-accumulated with medical.","example":true},"coverage_model":{"type":"string","description":"The coverage model type (e.g., Open Access).","example":"Open Access"},"employer_group_number":{"type":"string","description":"The employer group number for the insurance plan.","example":"GRP-001"},"employer_group_ids":{"type":"array","description":"Identifiers for the employer group.","items":{"type":"object","description":"An identifier with an optional type qualifier.","properties":{"id":{"type":"string","description":"The identifier value.","example":"12345"},"type":{"type":"string","description":"The type or system that issued this identifier.","example":"INTERNAL"}},"required":["id"]}},"employer_group_name":{"type":"string","description":"The name of the employer group.","example":"ACME Corp Plan"},"has_individual_sublimits":{"type":"boolean","description":"Whether the plan uses embedded individual sublimits for deductible/MOOP.","example":false},"payor_ids":{"type":"array","description":"Identifiers for the payor.","items":{"type":"object","description":"An identifier with an optional type qualifier.","properties":{"id":{"type":"string","description":"The identifier value.","example":"12345"},"type":{"type":"string","description":"The type or system that issued this identifier.","example":"INTERNAL"}},"required":["id"]}},"subscriber_first_name":{"type":"string","description":"The subscriber's first name.","example":"John"},"subscriber_number":{"type":"string","description":"The subscriber's identification number.","example":"SUB-123456"},"subscriber_last_name":{"type":"string","description":"The subscriber's last name.","example":"Doe"},"benefits":{"type":"array","description":"The list of benefit accumulators (deductibles, MOOP, visit limits, etc.).","items":{"type":"object","description":"Individual benefit accumulator (bucket) within an insurance coverage. Represents a single deductible, max-out-of-pocket, or visit-limit accumulator associated with a patient's coverage plan.","properties":{"accumulation_level":{"type":"string","description":"The level at which the accumulator accumulates (e.g., Individual, Family).","example":"Individual"},"amount_used":{"type":"number","format":"double","description":"The amount already used/accumulated.","example":350},"amount_type":{"type":"string","description":"The type of accumulation amount (e.g., Dollar, Visit).","example":"Dollar"},"adjudication_table_ids":{"type":"array","description":"Identifiers for the adjudication table associated with this accumulator.","items":{"type":"object","description":"An identifier with an optional type qualifier.","properties":{"id":{"type":"string","description":"The identifier value.","example":"12345"},"type":{"type":"string","description":"The type or system that issued this identifier.","example":"INTERNAL"}},"required":["id"]}},"adjudication_table_name":{"type":"string","description":"The name of the adjudication table.","example":"Standard Adjudication"},"accumulator_ids":{"type":"array","description":"Identifiers for this accumulator (bucket).","items":{"type":"object","description":"An identifier with an optional type qualifier.","properties":{"id":{"type":"string","description":"The identifier value.","example":"12345"},"type":{"type":"string","description":"The type or system that issued this identifier.","example":"INTERNAL"}},"required":["id"]}},"amount_limit":{"type":"number","format":"double","description":"The limit amount for this accumulator.","example":1500},"accumulator_name":{"type":"string","description":"The name of this accumulator.","example":"Individual In-Network Deductible"},"conversion_factor":{"type":"number","format":"double","description":"The conversion factor applied to this accumulator.","example":1},"is_cob_savings":{"type":"boolean","description":"Whether this accumulator tracks Coordination of Benefits savings.","example":false},"is_deductible":{"type":"boolean","description":"Whether this accumulator is a deductible.","example":true},"is_max_out_of_pocket":{"type":"boolean","description":"Whether this accumulator is a maximum out-of-pocket limit.","example":false},"in_out_network":{"type":"array","description":"The network levels this accumulator applies to (e.g., In-Network, Out-of-Network).","items":{"type":"string"},"example":["In-Network"]},"roll_period_type":{"type":"string","description":"The roll period type for this accumulator (e.g., Calendar Year, Plan Year).","example":"Calendar Year"},"tier_ids":{"type":"array","description":"Identifiers for the tier associated with this accumulator.","items":{"type":"object","description":"An identifier with an optional type qualifier.","properties":{"id":{"type":"string","description":"The identifier value.","example":"12345"},"type":{"type":"string","description":"The type or system that issued this identifier.","example":"INTERNAL"}},"required":["id"]}},"tier_name":{"type":"string","description":"The name of the tier.","example":"Tier 1"}}}}}}}}]},"examples":{"Without accumulators":{"value":{"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}}]}},"With accumulators (include_accumulators=true)":{"value":{"id":"coverage-id-123","plan_id":"plan-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"}}],"accumulators":{"combined_pharmacy_medical":true,"coverage_model":"Open Access","employer_group_number":"GRP-001","employer_group_name":"ACME Corp Plan","has_individual_sublimits":false,"payor_ids":[{"id":"PAYOR-001","type":"INTERNAL"}],"subscriber_first_name":"John","subscriber_number":"SUB-123456","subscriber_last_name":"Doe","benefits":[{"accumulation_level":"Individual","amount_used":350,"amount_type":"Dollar","amount_limit":1500,"accumulator_name":"Individual In-Network Deductible","is_deductible":true,"is_max_out_of_pocket":false,"in_out_network":["In-Network"],"roll_period_type":"Calendar Year"},{"accumulation_level":"Individual","amount_used":1200,"amount_type":"Dollar","amount_limit":8700,"accumulator_name":"Individual In-Network MOOP","is_deductible":false,"is_max_out_of_pocket":true,"in_out_network":["In-Network"],"roll_period_type":"Calendar Year"}]}}}}}}},"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},"duration":{"description":"Duration of the appointment in minutes.","type":"integer","minimum":1,"maximum":1440},"order_id":{"description":"Epic only. When provided, triggers the ScheduleMultipleAppointments Epic flow instead of the standard scheduling flow. Required when cancel_comments is set.","type":"string","minLength":1,"maxLength":2147483647},"cancel_comments":{"description":"Epic only. Comments explaining why an existing appointment is being cancelled as part of booking this new one. Requires order_id to be set; returns 400 if provided without it.","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","order_id":"ORD-98765","cancel_comments":"Rescheduling due to patient request"}}}},"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"},"amount_due":{"type":"number","description":"The minimum amount currently due on this account."},"billing_system":{"type":"string","description":"The billing system"},"service_area":{"type":"object","properties":{"name":{"type":"string","description":"The name of the service area."},"ids":{"type":"array","items":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The identifier value."},"type":{"type":"string","description":"The identifier type (e.g. INTERNAL, EXTERNAL, CID)."}}}}}},"account_type":{"type":"string","description":"The type of guarantor account (e.g. Personal/Family, Worker's Comp)."},"payment_plan":{"type":"object","properties":{"amount_due":{"type":"string","description":"The amount currently due on the payment plan."}}}}}}}},"example":{"id":"fae7bb59-e312-4752-8ea8-dbeea32a714a","total_balance":2706.5,"accounts":[{"account_id":"1058","account_balance":2706.5,"amount_due":2706.5,"billing_system":"PB/HB","service_area":{"name":"EHS Service Area","ids":[{"id":"99","type":"INTERNAL"},{"id":"99","type":"EXTERNAL"},{"id":"1403593","type":"CID"}]},"account_type":"Personal/Family","payment_plan":{"amount_due":"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"}}}}}},"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 (Deprecated)","deprecated":true,"x-internal":true,"description":"**Deprecated**: Use `POST /healthcare/patients/{patient_id}/password-reset` instead.\n\nSend a password reset request to Epic MyChart for a patient.\nThis Epic-specific endpoint is deprecated in favor of the provider-agnostic password reset endpoint.\n","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/patients/{patient_id}/password-reset":{"post":{"tags":["HLS Providers"],"summary":"Reset patient password","description":"Send a password reset request to the patient's healthcare portal (e.g., MyChart).\nThis is a provider-agnostic endpoint that works across different EHR systems.\n\n**Prerequisites:**\n- A patient lookup must be performed first within the same interaction\n- The patient must have a healthcare portal account (e.g., MyChart) configured\n","operationId":"resetPatientPassword","security":[{"GA":["hls-patient-password-reset: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":["delivery_method"],"properties":{"delivery_method":{"type":"string","description":"The delivery method for the password reset link.","enum":["EMAIL","SMS"]}}},"example":{"delivery_method":"EMAIL"}}}},"responses":{"204":{"description":"No Content - Password reset request has been successfully submitted"},"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":{"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."}},"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."}}}}}},"424":{"description":"Failed Dependency - The upstream EHR provider returned an 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":{"Upstream Error":{"value":{"code":"1485020","message":"Upstream Error."}}}}}},"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"}}}}}},"examples":{"Too Many Requests":{"value":{"code":"1484290","message":"Too many requests."}}}}}},"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/interactions-overrides":{"put":{"tags":["HLS Providers"],"summary":"Store interaction-specific configuration overrides.","description":"Store configuration overrides scoped to a specific interaction. The overrides are applied to all requests within the given interaction context, allowing per-interaction customisation of provider settings (e.g. temporarily switching the active EHR provider for a single interaction).","operationId":"storeInteractionOverrides","security":[{"GA":["hls-interaction-overrides:write"]}],"requestBody":{"description":"The interaction override configuration to store.","required":true,"content":{"application/json":{"schema":{"required":["service","interaction_id","overrides"],"type":"object","description":"The request body for storing interaction-specific configuration overrides.","properties":{"service":{"type":"string","description":"The name of the industries-settings service whose configuration should be overridden for this interaction (e.g. hls-providers-integrations-generic).","minLength":1,"maxLength":256,"example":"hls-providers-integrations-generic"},"interaction_id":{"type":"string","description":"The unique identifier of the interaction to scope the overrides to.","minLength":1,"maxLength":256,"example":"2d3dd6394ffdbffad79c"},"overrides":{"type":"object","description":"A free-form map of configuration keys and values to override for the duration of the interaction. Keys and value types are specific to the target service.","additionalProperties":true,"example":{"global_provider":"CERNER"}}}},"example":{"service":"hls-providers-integrations-generic","interaction_id":"2d3dd6394ffdbffad79c","overrides":{"global_provider":"CERNER"}}}}},"responses":{"202":{"description":"Accepted"},"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."}}}}}},"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"}}}}}}},"/healthcare/patients/{patient_id}/verifications":{"post":{"tags":["HLS Providers"],"summary":"Verify patient data","description":"Verifies caller-provided patient data (e.g. street address, city, state, and postal code) against the patient record in the configured EHR, returning a similarity score and a match boolean.","operationId":"verifyPatient","security":[{"GA":["hls-patient:read"]}],"parameters":[{"name":"patient_id","in":"path","description":"The patient id","required":true,"schema":{"type":"string","minLength":1,"maxLength":255,"example":"enh2Q1c0oNRtWzXZrnG4tKw3"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"Request to verify patient data against the EHR record.","required":["fields","confidence_level"],"properties":{"fields":{"type":"object","description":"Key-value map of fields to verify against the patient record. Keys are field names, values are the caller-provided data to compare.","additionalProperties":{"type":"string","minLength":1,"maxLength":500},"minProperties":1,"example":{"ADDRESS":"123 Main Street Madison Wisconsin 53706"}},"confidence_level":{"type":"integer","description":"The minimum similarity score (0-100) required for a match.","minimum":0,"maximum":100,"example":80}}},"example":{"fields":{"ADDRESS":"123 Main Street Madison Wisconsin 53706"},"confidence_level":80}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","description":"The result of verifying patient data against the EHR record.","required":["match","score"],"properties":{"match":{"type":"boolean","description":"Whether the score meets or exceeds the required confidence level.","example":true},"score":{"type":"integer","description":"The similarity score (0-100) between the provided value and the patient record.","minimum":0,"maximum":100,"example":95}}},"example":{"match":true,"score":95}}}},"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. To use Industries External Entity Mapper API, you need to add an execute action component to your Studio flows to call this endpoint.\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":"Sync a contact by integration and external ID","description":"Upserts (creates or updates) a Talkdesk contact by matching on the combination of `integration_id` and `external_id`. If a contact with the given integration mapping already exists, it is updated; otherwise a new contact is created.\n\n**Brand Sentinel Mechanism**\n\nThe `custom_fields` array is the mechanism for identifying which store/brand a contact belongs to. The brand sentinel is a custom field entry with `key` = `external_id` and `value` = the brand/store identifier. When the brand sentinel is present in the request body:\n1. When multiple contacts match the same `integration_id` + `external_id`, the brand\n sentinel is used to disambiguate — the service selects the contact whose\n `custom_fields` contain the matching brand sentinel for update.\n\n2. If a single match exists but its brand sentinel differs from the one in the\n request body, the contact is treated as a non-match and the system falls through\n to the no-match logic (see `existing_contact_id` below).\n\n3. An empty brand sentinel value is treated as \"no brand\" (same as omitting it).\n\n**Contact Resolution Logic**\n\nThe service resolves which contact to create or update based on the following decision tree:\n- **Multiple matches** (matched > 1):\n - If brand sentinel present in request body → select the contact matching the brand; update it.\n - If no brand match found → fall through to no-match logic.\n - If brand sentinel not present → return matches as-is (no update performed).\n\n- **Single match** (matched == 1):\n - If brand sentinel not present → update the matched contact.\n - If brand sentinel present and contact has no brand sentinel → adopt the brand and update.\n - If brand sentinel present and sentinel matches → update.\n - If brand sentinel present and sentinel differs → treat as no-match (fall through).\n\n- **No match** (matched == 0, or delegated from above):\n - If `existing_contact_id` provided → attempt to reuse that contact (merge), unless\n it already has a conflicting integration for the same `integration_id` (in which\n case a new contact is created instead).\n - If `existing_contact_id` not provided → create a new contact.\n\n\n**Merge Strategy (when updating)**\n\n- `custom_fields`: key-based merge — matching keys are overwritten, new keys are appended,\n absent keys are preserved.\n\n- `integrations`: matched by `integration_id` + `external_id` pair; existing entries are\n updated, new entries are appended.\n\n- Scalar fields (`name`, `address`): overwritten if provided, preserved if omitted (null).\n- Array fields (`tags`, `emails`, `phones`): replaced entirely if provided.\n\n**Request Body Validation**\n\n- `contact.id` must be empty (omit it or set to null).\n- `contact.integrations` must contain at least one entry with `integration_id` and\n `external_id` matching the path parameters — otherwise 400 is returned.\n","operationId":"searchAndUpsertContact","security":[{"GA":["entitymapper-contacts:write"]}],"parameters":[{"name":"integration_id","in":"path","required":true,"description":"The integration platform identifier. Determines which external system the contact originates from (e.g., \"shopify\", \"bigcommerce\", \"salesforce\").\n","schema":{"type":"string","minLength":1},"example":"shopify"},{"name":"external_id","in":"path","required":true,"description":"The unique identifier of the contact in the external system. Used together with `integration_id` to locate or create the Talkdesk contact mapping.\n","schema":{"type":"string","minLength":1},"example":"7349573890127"},{"name":"existing_contact_id","in":"query","required":false,"description":"(optional) when no contact matches the `integration_id` + `external_id` lookup (or when a brand mismatch causes delegation to no-match logic).\n\nWhen this parameter is provided and the no-match path is triggered, the service will attempt to reuse (merge into) this existing contact rather than creating a new one. However, if the existing contact already has an integration entry for the same `integration_id`, it cannot be reused and a new contact is created instead.\n\nTypical use case: the caller already knows the Talkdesk contact from a prior interaction (e.g., the contact was identified during a phone call) and wants to link the external entity to that same contact.\n","schema":{"type":"string","minLength":24,"maxLength":24},"example":"66051314713d63001ef18eb6"}],"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":"Full name of the contact.","minLength":1,"nullable":true},"address":{"type":"string","description":"Mailing or physical address of the contact.","minLength":1,"nullable":true},"emails":{"type":"array","items":{"type":"object","required":["email"],"properties":{"label":{"type":"string","description":"A label for this email address (e.g., \"work\", \"personal\").","minLength":1,"nullable":true},"email":{"type":"string","format":"email","description":"The email address.","minLength":1}}},"description":"Email addresses associated with the contact."},"phones":{"type":"array","items":{"type":"object","required":["number"],"properties":{"label":{"type":"string","description":"A label for this phone number (e.g., \"mobile\", \"home\").","minLength":1,"nullable":true},"number":{"type":"string","description":"The phone number in E.164 format (e.g., \"+14155552671\").\n","minLength":1}}},"description":"Phone numbers associated with the contact."},"custom_fields":{"type":"array","items":{"type":"object","required":["key","value"],"properties":{"key":{"type":"string","description":"The key identifying this custom field. For brand identification, this should be the contact's external_id.\n","minLength":1},"value":{"type":"string","description":"The value of the custom field. For brand identification, this should be the brand/store identifier (e.g., Shopify store ID or BigCommerce store hash).\n","minLength":1}}},"description":"Custom fields associated with the contact. The brand sentinel custom field (key = external_id, value = brand) is the primary mechanism for associating a contact with a specific store/brand. Callers must include the brand sentinel explicitly in this array for multi-brand disambiguation to work. Merge strategy is key-based: matching keys are overwritten, new keys appended, absent keys preserved.\n"},"integrations":{"type":"array","items":{"type":"object","required":["integration_id","external_id"],"properties":{"integration_id":{"type":"string","description":"The integration platform identifier (e.g., \"shopify\", \"bigcommerce\", \"salesforce\").\n","minLength":1},"external_id":{"type":"string","description":"The unique identifier of the contact in the external system.","minLength":1},"external_url":{"type":"string","description":"A deep link URL to the contact record in the external system.\n","minLength":1,"nullable":true},"external_sync_state":{"type":"string","description":"The synchronization state between systems (e.g., \"synced\", \"pending\").\n","minLength":1,"nullable":true},"contact_type":{"type":"string","description":"The type or classification of the contact in the external system (e.g., \"Lead\", \"Customer\").\n","minLength":1,"nullable":true}}},"description":"Integration mappings for this contact. Each entry links the contact to a record in an external system. At least one integration entry matching the path parameters (integration_id + external_id) is required.\n"}}},"examples":{"Shopify contact with brand and metrics":{"summary":"Shopify contact with brand sentinel and order metrics","value":{"name":"Jane Smith","phones":[{"label":"mobile","number":"+14155552671"}],"emails":[{"label":"personal","email":"jane.smith@example.com"}],"custom_fields":[{"key":"7349573890127","value":"gid://shopify/Shop/56060731234"},{"key":"Total spent","value":"$1,234.56"},{"key":"Total of orders","value":"12"}],"integrations":[{"integration_id":"shopify","external_id":"7349573890127","external_url":"https://admin.shopify.com/store/my-store/customers/7349573890127","contact_type":"Customer"}]}},"BigCommerce contact with brand":{"summary":"BigCommerce contact with brand sentinel","value":{"name":"John Doe","phones":[{"label":"mobile","number":"+14155551234"}],"emails":[{"label":"work","email":"john.doe@company.com"}],"custom_fields":[{"key":"15082","value":"j4haierfig"}],"integrations":[{"integration_id":"bigcommerce","external_id":"15082"}]}}}}},"required":true},"responses":{"200":{"description":"The contact was successfully created or updated. Returns the matched count and the full contact object including resolved custom fields and integrations.\n","content":{"application/json":{"schema":{"type":"object","required":["matched"],"properties":{"matched":{"type":"integer","description":"The number of existing contacts matched. 0 indicates a new contact was created; 1 indicates an existing contact was updated.\n","minimum":0,"maximum":1},"_embedded":{"type":"object","required":["contacts"],"properties":{"contacts":{"type":"array","items":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The Talkdesk contact ID (24-character hex string).","minLength":24,"maxLength":24},"name":{"type":"string","description":"Full name of the contact."},"address":{"type":"string","description":"Address of the contact."},"tags":{"type":"array","items":{"type":"string"},"description":"Tags associated with the contact."},"emails":{"type":"array","items":{"type":"object","required":["email"],"properties":{"label":{"type":"string","description":"Label for the email."},"email":{"type":"string","format":"email","description":"The email address."}}},"description":"Email addresses of the contact."},"phones":{"type":"array","items":{"type":"object","required":["number"],"properties":{"label":{"type":"string","description":"Label for the phone number."},"number":{"type":"string","description":"The phone number."}}},"description":"Phone numbers of the contact."},"custom_fields":{"type":"array","items":{"type":"object","required":["key"],"properties":{"key":{"type":"string","description":"The custom field key."},"value":{"type":"string","description":"The custom field value."}}},"description":"Custom fields associated with the contact after merge."},"integrations":{"type":"array","items":{"type":"object","required":["integration_id","external_id"],"properties":{"integration_id":{"type":"string","description":"The integration platform identifier."},"external_id":{"type":"string","description":"The external system contact ID."},"external_url":{"type":"string","description":"Deep link to the external system record."},"external_sync_state":{"type":"string","description":"Synchronization state."},"contact_type":{"type":"string","description":"Contact type in the external system."}}},"description":"Integration mappings after merge."},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string","description":"Self-reference URL for this contact resource."}}}}}}}}}}}},"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":[{"label":"mobile","number":"+14155552671"}],"custom_fields":[{"key":"7349573890127","value":"gid://shopify/Shop/56060731234"},{"key":"Total spent","value":"$1,234.56"},{"key":"Total of orders","value":"12"}],"integrations":[{"integration_id":"shopify","external_id":"7349573890127","external_url":"https://admin.shopify.com/store/my-store/customers/7349573890127","contact_type":"Customer"}],"_links":{"self":{"href":"https://api.talkdeskapp.com/callbar/contacts/66051314713d63001ef18eb6"}}}]}}}}},"400":{"description":"Bad Request. Common causes: `contact.id` is not empty, or `contact.integrations` does not contain an entry matching the path parameters.\n","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"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":["Identity API"],"summary":"Deletes the contact's enrollment information","description":"Deletes the voice biometrics enrollment information for a contact so the contact is no longer recognized by voice authentication, and resets the contact's consent status accordingly.\nUse this endpoint to opt-out an enrolled user, for example when the contact requests removal of their voice profile as part of a right-to-be-forgotten request or before re-enrolling from scratch.
    \nThe contact must already exist in voice biometrics, otherwise the request returns 404; if the contact is already in a non-enrolled state, the call is treated as a no-op except for resetting consent.\nDownstream bookkeeping and provider-side voice profile deletion depend on whether the account has an Identity license, and subsequent authentication attempts for this contact will fail until a new enrollment is created.","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":["Identity API"],"summary":"Creates a new contact enrollment","description":"Creates or replaces the active voice biometrics enrollment for a contact, associating it with a chosen enrollment phrase.\nUse this endpoint to register a contact for active (phrase-based) voice biometrics authentication, after the contact has selected a phrase from the available catalog.
    \nOnly the enrollment intent is registered here — the actual voice sample is captured separately during a call via the call-level enrollment flow.\nIf the contact does not yet exist, it is created automatically and its consent is marked as granted.\nThe phrase_id must reference an existing phrase, otherwise the request returns 404. Re-issuing this request replaces the phrase association but preserves the existing consent state.","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":["Identity API"],"summary":"Provides a contact's consent for voice biometrics authentication","operationId":"getConsent","description":"Returns the current consent state recorded for a contact in voice biometrics authentication.\nUse this endpoint to check whether the contact has agreed to be enrolled and authenticated by voice, for example before offering voice authentication in a self-service flow.
    \nA response is only returned if the contact is known to voice biometrics; if no consent record exists yet for the contact, the request returns 404.","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":["Identity API"],"summary":"Changes a contact's consent for voice biometrics authentication","description":"Sets the consent state for a contact in voice biometrics authentication, either creating a new consent record or updating an existing one.\nUse this endpoint to capture the contact's decision after they have been informed about voice biometrics, for example to mark consent as granted before enrolling them or as revoked when the contact opts out.
    \nReturns 200 when an existing consent record is updated and 201 when a new one is created. Revoking consent does not by itself delete an existing enrollment; use the enrollment delete endpoint to remove the contact's voiceprint.","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"}},"x-internal":true,"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"}},"x-internal":true,"security":[{"EarlyAccess":["wfm-public:read"]}],"summary":"Get History Import","tags":["WFM"]}},"/wfm/timeseries/v1/forecast_imports":{"post":{"description":"Upload a forecast CSV file for the account. Returns the import ID and status in the response body and the URL for tracking import status in the Content-Location header.","operationId":"uploadForecastImport","requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","required":["csv_file","file_name","time_zone"],"properties":{"csv_file":{"type":"string","format":"binary","description":"The CSV file to upload. Required headers (in order): Queue, Datetime, Interaction volume offered, Average handle time, Shrinkage. Maximum file size is 5 MB."},"file_name":{"type":"string","description":"The original file name including the .csv extension.","example":"forecast_import.csv","minLength":1,"maxLength":255},"time_zone":{"type":"string","description":"The IANA time zone of the datetime values in the CSV.","example":"America/New_York","minLength":1,"maxLength":64},"date_format":{"type":"string","description":"The date format used in the Datetime column. Defaults to DD/MM/YYYY.","example":"MM/DD/YYYY","minLength":1,"maxLength":32},"trigger_scheduler_job":{"type":"boolean","description":"Whether to trigger the scheduler job after the import completes. Defaults to false.","example":false},"interval_editing":{"type":"string","description":"The interval granularity for forecast editing. Defaults to MIN_15.","enum":["MIN_15","MIN_30","HOUR"],"example":"MIN_15"}}}}},"description":"The CSV file and metadata to upload as a Forecast Import","required":true},"responses":{"202":{"content":{"application/json":{"schema":{"type":"object","required":["id","status"],"properties":{"id":{"type":"string","description":"The unique identifier for the forecast import.","example":"8ae6a6b17c6fcc00017c6fddd2c00001","minLength":1,"maxLength":64},"status":{"type":"string","description":"The current status of the import.","example":"UPLOADED","minLength":1,"maxLength":32}},"example":{"id":"8ae6a6b17c6fcc00017c6fddd2c00001","status":"UPLOADED"}}}},"description":"Forecast Import accepted and queued for processing","headers":{"Content-Location":{"description":"URL to check the import status","schema":{"type":"string"},"example":"https://api.talkdeskapp.com/wfm/timeseries/v1/forecast_imports/8ae6a6b17c6fcc00017c6fddd2c00001"}}},"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":"BAD_REQUEST","message":"Invalid CSV header. Expected headers: Queue, Datetime, Interaction volume offered, Average handle time, Shrinkage."}}},"description":"Bad Request — invalid CSV header or date format"},"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":"UNAUTHORIZED","message":"Authentication credentials are missing or invalid."}}},"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":"FORBIDDEN","message":"Insufficient permissions to perform this operation."}}},"description":"Forbidden"},"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":"CONFLICT","message":"A forecast import is already in progress for this account."}}},"description":"Conflict — a forecast import is already in progress"},"413":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0560627","message":"The uploaded file exceeds the maximum allowed size."}}},"description":"CSV file exceeds 5 MB limit"},"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":"UNSUPPORTED_MEDIA_TYPE","message":"Only .csv files are accepted."}}},"description":"Unsupported Media Type — only .csv files are accepted"},"429":{"content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"TOO_MANY_REQUESTS","message":"Rate limit exceeded. Please retry later."}}},"description":"Too Many Requests"},"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":"INTERNAL_SERVER_ERROR","message":"An unexpected error occurred."}}},"description":"Internal Server Error"}},"x-internal":false,"security":[{"EarlyAccess":["wfm-public:write"]}],"summary":"Upload Forecast Import from CSV file","tags":["WFM"]}},"/wfm/timeseries/v1/forecast_imports/{import_id}":{"get":{"description":"Retrieve the current status of a Forecast Import by its ID.","operationId":"getForecastImportStatus","parameters":[{"in":"path","name":"import_id","required":true,"schema":{"type":"string","minLength":1,"maxLength":64},"description":"The unique identifier of the forecast import to retrieve.","example":"8ae6a6b17c6fcc00017c6fddd2c00001"}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","status","created_at","updated_at"],"properties":{"id":{"type":"string","description":"The unique identifier of the import.","example":"8ae6a6b17c6fcc00017c6fddd2c00001","minLength":1,"maxLength":64},"status":{"type":"string","description":"The current processing status.","enum":["UPLOADED","PROCESSING","IMPORTED","IMPORTED_WITH_ERRORS","ERROR","DISMISS"],"example":"IMPORTED"},"created_at":{"type":"string","format":"date-time","description":"When the import was created.","example":"2026-05-20T10:30:00Z"},"updated_at":{"type":"string","format":"date-time","description":"When the import was last updated.","example":"2026-05-20T10:35:00Z"},"error_file_url":{"type":"string","nullable":true,"description":"Pre-signed URL to download the error report CSV. Present only when status is IMPORTED_WITH_ERRORS or ERROR. Valid for 10 minutes.","example":"https://s3.amazonaws.com/bucket/errors.csv?X-Amz-Expires=600","maxLength":2048}}},"example":{"id":"8ae6a6b17c6fcc00017c6fddd2c00001","status":"IMPORTED","created_at":"2026-05-20T10:30:00Z","updated_at":"2026-05-20T10:35:00Z","error_file_url":null}}},"description":"Forecast Import status"},"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":"UNAUTHORIZED","message":"Authentication credentials are missing or invalid."}}},"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":"FORBIDDEN","message":"Insufficient permissions to perform this operation."}}},"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":"NOT_FOUND","message":"No forecast import found with the specified ID."}}},"description":"Not Found — no import with this ID exists for the account"},"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":"INTERNAL_SERVER_ERROR","message":"An unexpected error occurred."}}},"description":"Internal Server Error"}},"x-internal":false,"security":[{"EarlyAccess":["wfm-public:read"]}],"summary":"Get Forecast Import Status","tags":["WFM"]}},"/wfm/aion/externals/schedules/time-offs/{id}":{"delete":{"x-namespace":"/wfm/aion","description":"Time off deleted by an external service","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":["Scheduled Time Off API"]},"patch":{"description":"Time off updated by an external service.","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":["Scheduled Time Off API"]}},"/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":["Scheduled Time Off API"]}},"/wfm/aion/agents/calendar/{token}/schedule.ics":{"get":{"x-namespace":"/wfm/aion","description":"Returns the agent's schedule in iCalendar format (RFC 5545). This endpoint is publicly accessible via a unique token and does not require JWT authentication or OAuth scopes.","operationId":"GetAgentCalendarSchedule","parameters":[{"description":"Unique token identifying the agent's calendar subscription","example":"550e8400e29b41d4a716446655440000","in":"path","name":"token","required":true,"schema":{"description":"UUId","maxLength":255,"minLength":1,"type":"string"}}],"responses":{"200":{"content":{"text/calendar":{"schema":{"type":"string"},"example":"BEGIN:VCALENDAR\nVERSION:2.0\nPRODID:-//Talkdesk//WFM Aion//EN\nBEGIN:VEVENT\nDTSTART:20260312T090000Z\nDTEND:20260312T170000Z\nSUMMARY:Shift\nEND:VEVENT\nEND:VCALENDAR\n"}},"description":"Agent schedule in iCalendar format"},"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":"Calendar not found for the given token"}},"security":[],"summary":"Retrieve agent schedule as iCalendar","tags":["Scheduled Time Off API"]}},"/wfm/aion/v1/schedules/event-imports":{"post":{"x-namespace":"/wfm/aion","description":"Bulk imports agent schedule events (shifts, time off, breaks, meetings) from a CSV file. Use this endpoint to synchronize agent schedules from external HRIS, scheduling systems, or workforce applications.\n\nSubmits a CSV file for asynchronous processing and returns a 202 Accepted response. The response includes a Location header with the URI to poll for import status. When processing completes, check the status endpoint to retrieve any error details in downloadable CSV format.\n\nThis endpoint enables adherence tracking integration from external systems without requiring manual re-entry of schedules in the WFM UI.","operationId":"PostScheduleEventImport","requestBody":{"content":{"multipart/form-data":{"schema":{"description":"Multipart form data for importing schedule events from a CSV file.","properties":{"csv_file":{"description":"CSV file containing schedule events to import.","format":"binary","type":"string","minLength":1,"maxLength":5242880},"file_name":{"description":"Name of the CSV file.","type":"string","minLength":1,"maxLength":255},"time_zone":{"description":"Timezone for interpreting event times (e.g. UTC, America/New_York).","type":"string","minLength":1,"maxLength":64},"date_format":{"default":"HH:mm yyyy-MM-dd","description":"Date/time format pattern used in the CSV (e.g. HH:mm yyyy-MM-dd).","type":"string","minLength":1,"maxLength":64}},"required":["csv_file","file_name","time_zone"],"type":"object"},"example":{"file":"[binary CSV data]","event_type":"SHIFT"}}},"description":"CSV file containing agent schedule events. File must contain valid headers matching the schema (e.g., agent_id, event_type, start_time, end_time). Maximum file size is 5 MB.","required":true},"responses":{"202":{"description":"The import request was accepted for processing. Use the Location URI to poll for import status.","headers":{"Location":{"description":"Relative URI to the status endpoint. Poll this endpoint to retrieve import status and any error reports.","schema":{"type":"string","example":"/wfm/aion/v1/schedules/event-imports/92AF91D0759B11E989D9833F6973C849"}}}},"400":{"content":{"application/json":{"examples":{"Invalid CSV headers":{"value":{"code":"1580001","message":"Invalid fields: missing required column \"agent_id\""}},"Unsupported date format":{"value":{"code":"1580001","message":"Invalid fields: unsupported date format in column \"start_time\""}},"Missing file":{"value":{"code":"1580001","message":"Invalid fields: CSV file is required"}}},"schema":{"type":"object","required":["code","message"],"properties":{"code":{"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":"CSV structure or content validation failed (missing required headers, invalid date formats, invalid event types, etc.)"},"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":"Authentication token missing, expired, or invalid"},"403":{"content":{"application/json":{"example":{"code":"1580006","message":"Invalid permissions. Required scope: wfm-public:write"},"schema":{"type":"object","required":["code","message"],"properties":{"code":{"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":"Insufficient permissions. User must have wfm-public:write scope"},"409":{"content":{"application/json":{"example":{"code":"1580009","message":"A schedule event import is already in progress for this account. Please wait for the current import to complete before submitting another."},"schema":{"type":"object","required":["code","message"],"properties":{"code":{"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":"An import is already in progress for this account. Only one concurrent import is allowed per account"},"413":{"content":{"application/json":{"example":{"code":"1580047","message":"The uploaded file exceeds the maximum allowed size of 5 MB. Current file size: 12 MB"},"schema":{"type":"object","required":["code","message"],"properties":{"code":{"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":"CSV file exceeds 5 MB limit"},"415":{"content":{"application/json":{"example":{"code":"1580015","message":"Unsupported media type. File must be in CSV format (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"}}}}}}}},"description":"File must be in CSV format (Content-Type: text/csv or multipart/form-data)"},"500":{"content":{"application/json":{"example":{"code":"1230000","message":"An unknown error has occurred. Please contact support with request ID: 550e8400-e29b-41d4-a716-446655440000"},"schema":{"type":"object","required":["code","message"],"properties":{"code":{"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 during import request processing"}},"security":[{"EarlyAccess":["wfm-public:write"]}],"summary":"Bulk import agent schedule events from CSV","tags":["Schedule Event Import API"]}},"/wfm/aion/v1/schedules/event-imports/{import_id}":{"get":{"x-namespace":"/wfm/aion","description":"Retrieves the current status of a schedule event import. Use this endpoint to poll for import completion after submitting a bulk import request.\n\nWhen status is IMPORTED_WITH_ERRORS, a presigned S3 URL (valid for 10 minutes) is included in the response to download the error report CSV. The error report lists invalid rows and corresponding validation error messages for corrective re-import.\n\nPoll this endpoint every 10-30 seconds after import submission until status is no longer IMPORTING.","operationId":"GetScheduleEventImport","parameters":[{"description":"The import UUID returned in the Location header from the POST endpoint","example":"92AF91D0759B11E989D9833F6973C849","in":"path","name":"import_id","required":true,"schema":{"description":"UUID of the import request (format: alphanumeric identifier)","maxLength":255,"minLength":1,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"description":"Status and errors for a schedule event import.","properties":{"id":{"description":"Unique identifier of the import.","example":"92AF91D0759B11E989D9833F6973C849","type":"string"},"status":{"description":"Current status of the import.","enum":["PROCESSING","IMPORTED","IMPORTED_WITH_ERRORS","ERROR"],"type":"string"},"error_report_url":{"description":"Presigned URL to download the error CSV report. Present only when status is IMPORTED_WITH_ERRORS.","example":"https://s3.amazonaws.com/bucket/errors.csv?X-Amz-Expires=600","type":"string"},"error_report_expires_at":{"description":"Expiry timestamp of the presigned URL (ISO 8601). Present only when error_report_url is set.","example":"2024-01-01T12:10:00Z","type":"string","format":"date-time"}},"required":["id","status"],"type":"object"},"example":{"id":"92AF91D0759B11E989D9833F6973C849","status":"IMPORTED_WITH_ERRORS","total_events":150,"successful_events":147,"failed_events":3,"error_report_url":"https://s3.amazonaws.com/bucket/import-errors-abc123.csv?expires=1234567890"}}},"description":"Import status retrieved successfully"},"401":{"content":{"application/json":{"example":{"code":"1580005","message":"Invalid authentication. Token missing or expired."},"schema":{"type":"object","required":["code","message"],"properties":{"code":{"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":"Authentication token missing, expired, or invalid"},"403":{"content":{"application/json":{"example":{"code":"1580006","message":"Invalid permissions. You do not have access to this import."},"schema":{"type":"object","required":["code","message"],"properties":{"code":{"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":"Insufficient permissions or import belongs to a different account"},"404":{"content":{"application/json":{"example":{"code":"1580007","message":"Resource not found. Import ID 92AF91D0759B11E989D9833F6973C849 does not exist or has expired."},"schema":{"type":"object","required":["code","message"],"properties":{"code":{"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":"Import not found or has expired. Imports are retained for 30 days"},"500":{"content":{"application/json":{"example":{"code":"1230000","message":"An unknown error has occurred. Contact support with request ID."},"schema":{"type":"object","required":["code","message"],"properties":{"code":{"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 retrieving import status"}},"security":[{"EarlyAccess":["wfm-public:read"]}],"summary":"Get schedule import status and error report URL","tags":["Schedule Event Import API"]}},"/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 API"]}},"/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 API"]}},"/industries-activities/activities/{activity_id}":{"patch":{"operationId":"industries-activities-activities-activity-id-patch","tags":["Industries Activity API"],"description":"Patch the activity","summary":"Patch the activity","x-internal":true,"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":{"operationId":"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.","x-internal":true,"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":{"operationId":"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.","x-internal":true,"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":{"operationId":"builder-functions-executions-post","x-internal":true,"summary":"Execute Inline Function","description":"Execute custom code with provided arguments and return the computed result. Use this endpoint to run inline function code without first saving it. Provide the function body and arguments in the request. The response contains the execution output.","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":{"operationId":"builder-functions-function-id-executions-post","x-internal":true,"summary":"Execute Function by ID","description":"Execute a previously saved function by its ID with the provided arguments. Use this endpoint to run an existing function. The function must have been created beforehand. Provide function arguments in the request body when needed.","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":{"operationId":"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"],"x-internal":true,"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":{"operationId":"phone-labels-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"],"x-internal":true,"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":["Case API"],"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":["Case API"],"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":["Case API"],"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":["Case API"],"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":["Case API"],"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":["Case API"],"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":["Case API"],"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":["Case API"],"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":["Case API"],"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 API"],"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 API"],"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 API"],"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":{"operationId":"phone-details-outbound-numbers-get","summary":"List phone numbers available for outbounds","description":"List phone numbers that can be used for outbound by the agent, including dedicated line and numbers belonging to an agent ring group.","x-internal":true,"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":{"operationId":"phone-details-numbers-get","summary":"Get numbers belonging to the account","description":"Get numbers belonging to the account","x-internal":true,"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":{"operationId":"phone-details-numbers-id-get","summary":"Retrieve number details","description":"Retrieve a number details","x-internal":true,"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":{"operationId":"create-fsi-insurance-connections-automated-notification","tags":["Financial Services Experience Cloud for Insurance"],"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":{"operationId":"fsi-desktop-app-session-get","tags":["Financial Services Experience Cloud for Banking"],"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","x-internal":true,"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":{"operationId":"fsi-desktop-app-session-post","tags":["Financial Services Experience Cloud for Banking"],"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","x-internal":true,"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"}}}}}},"/cfm/flows/external/results":{"post":{"tags":["Feedback API"],"summary":"Collect feedback data","description":"Use this endpoint to submit feedback survey data for a conversation; it currently supports Digital Connect and is intended for survey-completion flows.","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":{"operationId":"campaigns-post","summary":"Create or Duplicate Campaign","description":"Creates a new campaign or duplicates an existing one.\nUse this endpoint to set up a new outbound campaign with dialing mode, strategy, and contact lists.\nTo duplicate, provide the source_id query parameter with the ID of the campaign to copy.\n","x-namespace":"/campaigns","tags":["Campaign Management API"],"x-internal":false,"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":{"operationId":"campaigns-get","summary":"List Campaigns","description":"Returns a paginated list of campaigns for the account.\nUse this endpoint to retrieve all campaigns with optional filtering by name, status, dialing mode, and other criteria.\nSupports sorting and searching with partial matches.\n","x-namespace":"/campaigns","tags":["Campaign Management API"],"x-internal":false,"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":{"operationId":"campaigns-id-get","summary":"Get Campaign Details","description":"Returns the details of a specific campaign.\nUse this endpoint to retrieve full campaign configuration including dialing mode and strategy.\nSpecify the campaign ID in the path.\n","x-namespace":"/campaigns","tags":["Campaign Management API"],"x-internal":false,"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":{"operationId":"campaigns-id-delete","summary":"Delete Campaign","description":"Deletes a specific campaign.\nUse this endpoint to permanently remove a campaign from the account.\nA campaign that is currently running cannot be deleted and will return a conflict error.\n","x-namespace":"/campaigns","tags":["Campaign Management API"],"x-internal":false,"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":{"operationId":"campaigns-id-patch","summary":"Update Campaign","description":"Updates a specific campaign configuration.\nUse this endpoint to modify campaign settings such as name, dialing mode, strategy, or schedule.\nAccepts a JSON Patch request body with the fields to update.\n","x-namespace":"/campaigns","tags":["Campaign Management API"],"x-internal":false,"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":{"operationId":"campaigns-id-do-not-call-lists-get","summary":"List Campaign Do Not Call Lists","description":"Returns the Do Not Call Lists assigned to a specific campaign.\nUse this endpoint to view which Do Not Call Lists are currently associated with a campaign.\nSupports pagination and filtering by ID.\n","x-namespace":"/campaigns","tags":["Campaign Management API"],"x-internal":false,"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":{"operationId":"campaigns-id-do-not-call-lists-post","summary":"Assign Do Not Call Lists","description":"Assigns one or more Do Not Call Lists to a specific campaign.\nUse this endpoint to associate Do Not Call Lists with a campaign to prevent dialing numbers on those lists.\n","x-namespace":"/campaigns","tags":["Campaign Management API"],"x-internal":false,"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":{"operationId":"campaigns-id-do-not-call-lists-delete","summary":"Dissociate Do Not Call Lists","description":"Removes the association of one or more Do Not Call Lists from a specific campaign.\nUse this endpoint to dissociate Do Not Call Lists that are no longer needed for a campaign.\n","x-namespace":"/campaigns","tags":["Campaign Management API"],"x-internal":false,"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":{"operationId":"campaigns-id-record-lists-get","summary":"List Campaign Record Lists","description":"Returns the record lists assigned to a specific campaign.\nUse this endpoint to view which record lists are currently associated with a campaign.\nSupports pagination and filtering by ID.\n","x-namespace":"/campaigns","tags":["Campaign Management API"],"x-internal":false,"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":{"operationId":"campaigns-id-record-lists-post","summary":"Assign Record Lists","description":"Assigns one or more record lists to a specific campaign.\nUse this endpoint to associate record lists containing contact data with a campaign.\n","x-namespace":"/campaigns","tags":["Campaign Management API"],"x-internal":false,"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":{"operationId":"campaigns-id-record-lists-delete","summary":"Dissociate Record Lists","description":"Removes the association of one or more record lists from a specific campaign.\nUse this endpoint to dissociate record lists that are no longer needed for a campaign.\n","x-namespace":"/campaigns","tags":["Campaign Management API"],"x-internal":false,"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":{"operationId":"campaigns-id-users-get","summary":"List Campaign Users","description":"Returns the users (agents) assigned to a specific campaign.\nUse this endpoint to view which users are currently associated with a campaign.\nSupports pagination and filtering by user ID.\n","x-namespace":"/campaigns","tags":["Campaign Management API"],"x-internal":false,"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":{"operationId":"campaigns-id-users-post","summary":"Assign Users to Campaign","description":"Assigns one or more users to a specific campaign.\nUse this endpoint to associate agents with a campaign. The maximum number of user IDs per request is 50.\n","x-namespace":"/campaigns","tags":["Campaign Management API"],"x-internal":false,"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":{"operationId":"campaigns-id-users-delete","summary":"Dissociate Users","description":"Removes the association of one or more users from a specific campaign.\nUse this endpoint to dissociate agents that are no longer needed for a campaign.\n","x-namespace":"/campaigns","tags":["Campaign Management API"],"x-internal":false,"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":{"operationId":"campaigns-id-numbers-get","summary":"List Campaign Numbers","description":"Returns the phone numbers assigned to a specific campaign.\nUse this endpoint to view which numbers are currently associated with a campaign.\nSupports pagination and filtering by number ID.\n","x-namespace":"/campaigns","tags":["Campaign Management API"],"x-internal":false,"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":{"operationId":"campaigns-id-numbers-post","summary":"Assign Numbers to Campaign","description":"Assigns one or more phone numbers to a specific campaign.\nUse this endpoint to associate caller ID numbers with a campaign for outbound dialing.\n","x-namespace":"/campaigns","tags":["Campaign Management API"],"x-internal":false,"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":{"operationId":"campaigns-id-numbers-delete","summary":"Dissociate Numbers","description":"Removes the association of one or more phone numbers from a specific campaign.\nUse this endpoint to dissociate numbers that are no longer needed for a campaign.\n","x-namespace":"/campaigns","tags":["Campaign Management API"],"x-internal":false,"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":{"operationId":"listScheduledCallbacks","description":"Returns a paginated list of scheduled callbacks with total count.\nUse this endpoint to retrieve callbacks with optional filtering by status, phone number, agent, campaign, and time range.\n","summary":"List Scheduled Callbacks","x-namespace":"/schedule-callbacks","tags":["Schedule Callbacks"],"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":"queue","in":"query","description":"The queue name. To filter by multiple queues, use comma-separated values (for example, queue=queue1,queue2).","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":"A paginated list of scheduled callbacks with the total count.","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_v2":{"type":"string","description":"Describes what assign type is this related to","enum":["MYSELF_ONLY","SPECIFIC_AGENT","SPECIFIC_QUEUE","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"]},"queues":{"type":"array","items":{"type":"object","required":["queue"],"properties":{"queue":{"type":"string"}}},"description":"Describes which queues the callback is assigned to, when assign_type_v2 = specific queue."},"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_v2":"MYSELF_ONLY","from_call_type":"PROACTIVE_OUTBOUND","dialing_model":"PREDICTIVE","queues":[{"queue":"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"}}}}}},"post":{"operationId":"createScheduledCallback","summary":"Create a Callback","tags":["Schedule Callbacks"],"description":"Creates a new scheduled callback and returns the created resource.\nUse this endpoint to schedule a callback for a specific phone number with optional agent assignment and time scheduling.\n","x-namespace":"/schedule-callbacks","security":[{"GA":["schedule-callbacks:write"]}],"requestBody":{"description":"Callback configuration parameters","required":true,"content":{"application/json":{"schema":{"type":"object","required":["interaction_id","phone_number","caller_id","time_to_call","timezone","assign_type","from_call_type","dialing_model"],"properties":{"interaction_id":{"type":"string","minLength":1,"maxLength":36,"description":"Id of the interaction"},"caller_id":{"type":"string","minLength":1,"maxLength":35,"description":"The number that will be shown as the caller"},"time_to_call":{"type":"string","format":"date-time","minLength":1,"maxLength":35,"description":"The time the callback is scheduled"},"timezone":{"type":"string","minLength":1,"maxLength":100,"description":"The timezone in which the callback is scheduled"},"assign_type":{"type":"string","minLength":1,"maxLength":50,"description":"Describes what assign type is this related to","enum":["MYSELF_ONLY","SPECIFIC_AGENT","SPECIFIC_QUEUE","MYSELF_IF_AVAILABLE","ANY_ELIGIBLE_AGENT"]},"from_call_type":{"type":"string","minLength":1,"maxLength":50,"description":"Describes what call type is this related to","enum":["INBOUND","MANUAL_OUTBOUND","PROACTIVE_OUTBOUND","API"]},"dialing_model":{"type":"string","minLength":1,"maxLength":20,"description":"Describes what dialing model is this related to","enum":["PREDICTIVE","PREVIEW"]},"queues":{"type":"array","items":{"type":"object","required":["queue"],"properties":{"queue":{"type":"string","minLength":1,"maxLength":100}}},"description":"Describes what queue is this related to"},"agents":{"type":"array","items":{"type":"object","required":["agent_id"],"properties":{"agent_id":{"type":"string","minLength":1,"maxLength":100},"ring_group":{"type":"string","minLength":1,"maxLength":100,"description":"The ring group of the agent"}}}},"campaign_id":{"type":"string","minLength":1,"maxLength":36,"description":"The id of the campaign that originated this callback"},"record_id":{"type":"string","minLength":1,"maxLength":36,"description":"The id of the record that is scheduled to be called"},"record_list_id":{"type":"string","minLength":1,"maxLength":36,"description":"The id of the record list that is scheduled to be called"},"phone_number":{"type":"string","minLength":1,"maxLength":35,"description":"The phone number that is scheduled to be called"},"record_first_name":{"type":"string","minLength":1,"maxLength":200,"description":"First name of the record that is scheduled to be called"},"record_last_name":{"type":"string","minLength":1,"maxLength":200,"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"},"description":{"type":"string","minLength":1,"maxLength":2000,"description":"The callback note"}}},"example":{"interaction_id":"03e5c6f0-53c5-4b76-86ef-8d89ac67cdc6","caller_id":"+155598754214","time_to_call":"2021-03-24T11:48:40.500Z","timezone":"Europe/Lisbon","assign_type":"MYSELF_ONLY","from_call_type":"PROACTIVE_OUTBOUND","dialing_model":"PREDICTIVE","queues":[{"queue":"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","record_extra_data":{"job":"statistical analysis and data reconfiguration.","address":"Apartment #19 in Greenwich Village, Manhattan"}}}}},"responses":{"201":{"description":"Created a Callback","content":{"application/hal+json":{"schema":{"type":"object","required":["callback_id"],"properties":{"callback_id":{"type":"string","description":"Id of the callback"},"interaction_id":{"type":"string","description":"Id of the interaction"},"caller_id":{"type":"string","description":"The number that will be shown as the caller"},"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"},"assign_type_v2":{"type":"string","description":"Describes what assign type is this related to","enum":["MYSELF_ONLY","SPECIFIC_AGENT","SPECIFIC_QUEUE","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","API"]},"dialing_model":{"type":"string","description":"Describes what dialing model is this related to","enum":["PREDICTIVE","PREVIEW"]},"queues":{"type":"array","items":{"type":"object","required":["queue"],"properties":{"queue":{"type":"string"}}},"description":"Describes what queue is this related to"},"agents":{"type":"array","items":{"type":"object","required":["agent_id"],"properties":{"agent_id":{"type":"string"}}}},"campaign_id":{"type":"string","description":"The id of the campaign that originated this callback"},"record_id":{"type":"string","description":"The id of the record that is scheduled to be called"},"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"},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string"}}}}}}},"example":{"callback_id":"2da8a248-4b77-463e-9a36-d724f5792971","interaction_id":"03e5c6f0-53c5-4b76-86ef-8d89ac67cdc6","caller_id":"+155598754214","time_to_call":"2021-03-24T11:48:40.500Z","timezone":"Europe/Lisbon","assign_type_v2":"MYSELF_ONLY","from_call_type":"PROACTIVE_OUTBOUND","dialing_model":"PREDICTIVE","queues":[{"queue":"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","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":{"operationId":"schedule-callbacks-id-delete","summary":"Cancel a Callback","description":"Cancels a specific scheduled callback.\nUse this endpoint to cancel a callback that is no longer needed.\n","x-namespace":"/schedule-callbacks","tags":["Schedule Callbacks"],"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":{"operationId":"schedule-callbacks-id-patch","summary":"Update a Callback","description":"Updates a specific scheduled callback.\nUse this endpoint to modify callback properties such as scheduled time, phone number, or agent assignment.\n","x-namespace":"/schedule-callbacks","tags":["Schedule Callbacks"],"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_QUEUE"},{"op":"replace","path":"/queues","value":["queue1","queue2"]}]},"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_v2":{"type":"string","description":"Describes what assign type is this related to","enum":["MYSELF_ONLY","SPECIFIC_AGENT","SPECIFIC_QUEUE","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"]},"queues":{"type":"array","items":{"type":"object","required":["queue"],"properties":{"queue":{"type":"string"}}},"description":"Describes which queues the callback is assigned to, when assign_type_v2 = specific queue."},"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_v2":"MYSELF_ONLY","from_call_type":"PROACTIVE_OUTBOUND","dialing_model":"PREDICTIVE","queues":[{"queue":"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":{"operationId":"schedule-callbacks-id-get","description":"Returns the full details of a specific scheduled callback including status, timestamps, and metadata.\nUse this endpoint to retrieve a single callback by its ID.\n","summary":"Get Callback Details","x-namespace":"/schedule-callbacks","tags":["Schedule Callbacks"],"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":"Full details of the scheduled callback identified by id.","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_v2":{"type":"string","description":"Describes what assign type is this related to","enum":["MYSELF_ONLY","SPECIFIC_AGENT","SPECIFIC_QUEUE","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"]},"queues":{"type":"array","items":{"type":"object","required":["queue"],"properties":{"queue":{"type":"string"}}},"description":"Describes which queues the callback is assigned to, when assign_type_v2 = specific queue."},"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_v2":"MYSELF_ONLY","from_call_type":"PROACTIVE_OUTBOUND","dialing_model":"PREDICTIVE","queues":[{"queue":"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"}}}}}}},"/studio-callbacks":{"get":{"operationId":"studio-callbacks-get","description":"Returns a paginated list of studio callbacks with total count.\nUse this endpoint to retrieve callbacks with optional filtering by status, phone number, agent, ring group, team, and other supported fields.\n","summary":"List Studio Callbacks","x-namespace":"/studio-callbacks","tags":["Studio Callback"],"x-internal":true,"security":[{"EarlyAccess":["studio-callbacks:read"]}],"parameters":[{"name":"page","in":"query","description":"page","required":false,"schema":{"type":"integer","default":1,"minimum":1}},{"name":"per_page","in":"query","description":"per page","required":false,"schema":{"type":"integer","default":50,"minimum":1,"maximum":500}},{"name":"phone_number","in":"query","description":"The phone number that is scheduled to be called.","required":false,"schema":{"type":"string","maxLength":35}},{"name":"status","in":"query","description":"The status of callback","required":false,"schema":{"type":"string","maxLength":35,"x-filterable":true}},{"name":"agent_id","in":"query","description":"The assigned agent id of studio 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":"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}},{"name":"attribute_id","in":"query","description":"The id of the attribute to filter callbacks by","required":false,"schema":{"type":"string","maxLength":36}},{"name":"attribute_operator","in":"query","description":"The operator to apply when filtering by attribute","required":false,"schema":{"type":"string","maxLength":35}}],"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 1 when not provided."},"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"]},"next":{"description":"The link to the next 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 studio 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."},"contact_state":{"type":"string","description":"The state of the contact when the callback was created"},"agent_assigned":{"type":"boolean","description":"Whether an agent is assigned to the callback"},"flow_id":{"type":"string","description":"The flow id of where the callback originates from."},"flow_name":{"type":"string","description":"The name of the flow where the callback originates from"},"phone_number":{"type":"string","description":"The phone number that is scheduled to be called"},"talkdesk_number":{"type":"string","description":"The Talkdesk number used for the callback"},"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 scheduled time for the callback"},"status":{"type":"string","description":"The status of callback","enum":["QUEUED","UNATTEMPTED","TO_BE_RETRIED","EXHAUSTED","SUCCESS","CANCELED","INVALID_NUMBER"]},"created_at":{"type":"string","format":"date-time","description":"The time the callback was created"},"updated_at":{"type":"string","format":"date-time","description":"The time the callback was last updated"},"contact_id":{"type":"string","description":"The contact id"},"assign_type":{"type":"string","description":"The type of assignment for the callback"},"assignee":{"type":"object","description":"The assignee details for the callback","properties":{"type":{"type":"string","description":"The type of assignee"},"value":{"type":"array","items":{"type":"string"},"description":"The list of assignee identifiers"}}},"from_call_type":{"type":"string","description":"Describes what call type is this related to","enum":["INBOUND","MANUAL_OUTBOUND","PROACTIVE_OUTBOUND"]},"function_version":{"type":"integer","description":"The function version of the callback"},"is_api_component":{"type":"boolean","description":"Whether the callback is from an API component"},"version":{"type":"integer","description":"The version of the callback record"},"agents":{"type":"array","items":{"type":"string"},"description":"The list of agent ids assigned to the callback"},"teams":{"type":"array","items":{"type":"string"},"description":"The list of team ids assigned to the callback"}}},"type":"array"}},"required":["callbacks"],"type":"object"}},"required":["total","count","page","per_page","total_pages","_embedded","_links"]},"example":{"total":1,"page":1,"per_page":10,"total_pages":1,"count":1,"_links":{"self":{"href":"https://api.talkdeskapp.com/studio-callbacks/?per_page=10&page=1&status=QUEUED"},"first":{"href":"https://api.talkdeskapp.com/studio-callbacks/?per_page=10&page=1&status=QUEUED"},"last":{"href":"https://api.talkdeskapp.com/studio-callbacks/?per_page=10&page=1&status=QUEUED"},"prev":{"href":"https://api.talkdeskapp.com/studio-callbacks/?per_page=10&page=1&status=QUEUED"}},"_embedded":{"callbacks":[{"callback_id":"a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6","account_id":"60a1b2c3d4e5f6a7b8c9d0e1","interaction_id":"b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7","contact_state":"hung_up","agent_assigned":false,"flow_id":"c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8","flow_name":"My Callback Flow","phone_number":"+15551234567","talkdesk_number":"+15559876543","caller_id":"+15559876543","scheduled_time_to_call":"2026-03-24T10:00:00.000Z","status":"QUEUED","created_at":"2026-03-24T10:00:00.000Z","updated_at":"2026-03-24T10:00:02.000Z","contact_id":"d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9","assign_type":"AGENTS","assignee":{"type":"agents","value":["e5f6a7b8c9d0e1f2a3b4c5d6"]},"from_call_type":"INBOUND","function_version":2,"is_api_component":false,"version":3,"agents":["e5f6a7b8c9d0e1f2a3b4c5d6"],"teams":["f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1"]}]}}}}},"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"}}}}}}},"/do-not-call-lists/{id}/entries/queries":{"post":{"operationId":"do-not-call-lists-id-entries-queries-post","summary":"Search Entries","tags":["Campaign Management API"],"description":"Searches entries in a Do Not Call List by phone numbers and timezone.\nUse this endpoint to check whether specific phone numbers exist in the list and their expiration status.\n","x-namespace":"/do-not-call-lists","x-internal":false,"security":[{"GA":["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":{"operationId":"v1-record-list-record-list-id-record-record-id-call-attempt-disposition-disposition-post","summary":"Triggers attempt disposition event","description":"Triggers the automation for on attempt disposition event","security":[{"GA":["po-record-list-automations:write"]}],"tags":["Proactive Outbound 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":{"operationId":"v1-record-list-record-list-id-record-record-id-schedule-callback-created-post","summary":"Triggers schedule callback created event","description":"Triggers the automation for on schedule callback created event","security":[{"GA":["po-record-list-automations:write"]}],"tags":["Proactive Outbound 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":{"operationId":"v1-record-list-record-list-id-record-record-id-callback-attempt-disposition-disposition-post","summary":"Triggers callback disposition event","description":"Triggers the automation for on callback call attempt disposition event","security":[{"GA":["po-record-list-automations:write"]}],"tags":["Proactive Outbound 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 a Webhook Trigger","description":"Register a new webhook trigger for a specified event. Use this endpoint to subscribe to events by providing a callback URL that will receive notifications when the event occurs. Required fields: callbackurl. The trigger_name path parameter specifies the event type (e.g., contactCreated).","operationId":"postTrigger","security":[{"GA":["webhooks-trigger:write"]}],"parameters":[{"name":"trigger_name","in":"path","required":true,"description":"The name of the event that triggers the webhook (e.g., contactCreated)","schema":{"type":"string","example":"contactCreated","minLength":0,"maxLength":2147483647}},{"name":"x-ms-workflow-name","in":"header","required":true,"description":"A unique identifier for the workflow associated with this trigger","schema":{"type":"string","example":"b6661868-cfc9-4bbd-8776-03f9efeaaaaa","minLength":0,"maxLength":2147483647}}],"tags":["Webhook Trigger API"],"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 a Webhook Trigger","description":"Remove an existing webhook trigger by its ID. Use this endpoint to unsubscribe from a previously registered webhook event. Both the trigger name and trigger ID are required to identify the subscription.","operationId":"deleteTrigger","security":[{"GA":["webhooks-trigger:write"]}],"parameters":[{"name":"trigger_name","in":"path","required":true,"description":"The name of the event that triggers the webhook (e.g., contactCreated)","schema":{"type":"string","example":"contactCreated","minLength":0,"maxLength":2147483647}},{"name":"trigger_id","in":"path","required":true,"description":"The unique identifier of the webhook trigger to delete","schema":{"type":"string","example":"1234","minLength":0,"maxLength":2147483647}}],"tags":["Webhook Trigger API"],"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":["Billing Insights 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":{"summary":"Get contract actions","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":["Billing Insights 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},"contract_line_start_date":{"type":"string","description":"The start date of the contract line.","example":"2023-08-31T00:00:00.000Z"},"contract_line_end_date":{"type":"string","description":"The end date of the contract line.","example":"2024-08-31T00:00:00.000Z"}}}}}},"_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,"contract_line_start_date":"2023-08-31","contract_line_end_date":"2024-08-31"}]},"_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":["Billing Insights 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":["Billing Insights 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":["Billing Insights 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-z][a-z\\d\\-]{1,18}[a-z\\d]$","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":"Instantiate a Trial","tags":["EXPRESS API"]}},"/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 API"]}},"/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":["Simulated Email API"],"operationId":"emails-simulation-message","summary":"Send a simulated message to agent","description":"Contact send a simulated message to agent by email channel","x-internal":true,"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 API"],"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 API"],"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 a Prompt Detail by its ID","operationId":"getPromptById","description":"Gets prompt by its id","x-namespace":"/prompts","security":[{"GA":["prompts:read"]}],"tags":["Prompts API"],"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 API"],"summary":"Delete a Prompt","description":"Delete a 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 API"],"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 API"],"summary":"Update a Prompt","description":"Updating a Prompt using the Prompt 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":{"operationId":"prompts-id-download-link-get","summary":"Generate Download Link","description":"Generates a new temporary download link for the prompt.","x-namespace":"/prompts","tags":["Prompts API"],"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 API"],"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 Link to Upload Audio File","operationId":"requestUploadLink","description":"Request Link to Upload Audio File","x-namespace":"/prompts-requests","security":[{"GA":["prompts:write"]}],"tags":["Prompts API"],"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 API"],"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 API"],"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 API"],"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":["Financial Services Experience Cloud for Insurance"],"summary":"Get accounts from a search criteria","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":{"type":"object","description":"Custom fields associated with the entity.","additionalProperties":{"type":"string"}},"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":{"account_custom_fields":"000000","account_custom_fields_2":"111111"}}]},"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":["Financial Services Experience Cloud for Insurance"],"summary":"Get account with account number","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":{"type":"object","description":"Custom fields associated with the entity.","additionalProperties":{"type":"string"}},"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":{"account_custom_fields":"000000","account_custom_fields_2":"111111"}}}}},"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":["Financial Services Experience Cloud for Insurance"],"summary":"Get policies from an account holder","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":{"type":"object","description":"Custom fields associated with the entity.","additionalProperties":{"type":"string"}}}}}}},"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":{"policies_custom_fields":"000000","policies_custom_fields2":"111111"}}]},"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":["Financial Services Experience Cloud for Insurance"],"summary":"Get policy period from a policy","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":{"type":"object","description":"Custom fields associated with the entity.","additionalProperties":{"type":"string"}}}},"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":{"policies_period_custom_fields":"000000","policies_period_custom_fields_2":"111111"}}}}},"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":{"operationId":"fsi-insurance-integrations-policies-get","tags":["Financial Services Experience Cloud for Insurance"],"summary":"Search policies","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":{"type":"object","description":"Custom fields associated with the entity.","additionalProperties":{"type":"string"}}}}}}},"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":{"policies_search_custom_fields":"000000","policies_search_custom_fields_2":"111111"}}]},"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":{"operationId":"fsi-insurance-integrations-policies-id-metadata-get","tags":["Financial Services Experience Cloud for Insurance"],"summary":"Get policy metadata from a policy","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":{"type":"object","description":"Custom fields associated with the entity.","additionalProperties":{"type":"string"}}}},"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":{"policy_metadata_custom_fields":"000000","policy_metadata_custom_fields_2":"111111"}}}}},"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":{"operationId":"fsi-insurance-integrations-claims-post","tags":["Financial Services Experience Cloud for Insurance"],"summary":"Create a new claim through FNOL","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":{"type":"object","description":"Custom fields associated with the entity.","additionalProperties":{"type":"string"}}}},"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":{"fnol_custom_fields":"000000","fnol_custom_fields_2":"111111"}}}}},"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":{"operationId":"fsi-insurance-integrations-account-holders-id-billing-get","tags":["Financial Services Experience Cloud for Insurance"],"summary":"Get billing by account holder member","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":{"type":"object","description":"Custom fields associated with the entity.","additionalProperties":{"type":"string"}}}},"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":{"billing_custom_fields":"000000","billing_custom_fields_2":"111111"}}}}},"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":{"operationId":"fsi-insurance-integrations-account-holders-id-billing-details-get","tags":["Financial Services Experience Cloud for Insurance"],"summary":"Get billing details by account holder","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":{"type":"object","description":"Custom fields associated with the entity.","additionalProperties":{"type":"string"}}}},"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":{"billing_custom_fields":"000000","billing_custom_fields_2":"111111"}}}}},"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":{"operationId":"fsi-insurance-integrations-accounts-account-number-claims-get","tags":["Financial Services Experience Cloud for Insurance"],"summary":"Search claims related to account holders","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":{"type":"object","description":"Custom fields associated with the entity.","additionalProperties":{"type":"string"}},"_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":{"claim_custom_fields":"000000","claim_custom_fields_2":"111111"}}]},"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":{"operationId":"fsi-insurance-integrations-claims-id-get","tags":["Financial Services Experience Cloud for Insurance"],"summary":"Get claim by id","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":{"type":"object","description":"Custom fields associated with the entity.","additionalProperties":{"type":"string"}},"_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":{"claim_custom_fields":"000000","claim_custom_fields_2":"111111"}}}}},"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":{"operationId":"fsi-insurance-integrations-contacts-id-patch","tags":["Financial Services Experience Cloud for Insurance"],"summary":"Update contact details for an account","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":{"operationId":"fsi-insurance-integrations-document-deliveries-post","tags":["Financial Services Experience Cloud for Insurance"],"summary":"Send document delivery by SMS and email","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":{"operationId":"fsi-insurance-connections-claims-id-get","tags":["Financial Services Experience Cloud for Insurance"],"summary":"Get claim by id","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":{"type":"object","description":"Custom fields associated with the entity.","additionalProperties":{"type":"string"}},"_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":{"claim_custom_fields":"000000","claim_custom_fields_2":"111111"}}}}},"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":{"operationId":"fsi-insurance-connections-policies-policy-number-claims-get","tags":["Financial Services Experience Cloud for Insurance"],"summary":"Search claims related to a policy","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":{"type":"object","description":"Custom fields associated with the entity.","additionalProperties":{"type":"string"}},"_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":{"claim_custom_fields":"000000","claim_custom_fields_2":"111111"}}]},"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":{"operationId":"fsi-insurance-connections-accounts-account-number-claims-get","tags":["Financial Services Experience Cloud for Insurance"],"summary":"Search claims related to an account","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":{"type":"object","description":"Custom fields associated with the entity.","additionalProperties":{"type":"string"}},"_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":{"claim_custom_fields":"000000","claim_custom_fields_2":"111111"}}]},"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":{"operationId":"erc-ecommerce-connections-customers-customer-id-orders-order-id-cancel-post","x-internal":true,"tags":["Retail Experience Cloud Integrations"],"summary":"Cancel a customer's order","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","minLength":1,"maxLength":255,"example":"customer123"}},{"name":"order_id","in":"path","required":true,"description":"The order id","schema":{"type":"string","minLength":1,"maxLength":255,"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. The body itself is optional — call the endpoint without a body to cancel with provider defaults.\n","content":{"application/json":{"schema":{"type":"object","description":"Options applied when cancelling a customer's order. All fields are optional. Provider support varies per field; fields not supported by the resolved provider are accepted by the API and silently ignored on the provider side rather than rejected. The request body itself is optional — calling the endpoint without a body cancels the order with provider defaults (`cancel_reason=other`, `restock=false`, no customer notification, no automatic refund).\n","properties":{"cancel_reason":{"type":"string","maxLength":255,"description":"Hint describing why the order is being cancelled. The value is normalised by the underlying provider — for Shopify, it is matched case-insensitively against the `OrderCancelReason` GraphQL enum (`customer`, `declined`, `fraud`, `inventory`, `staff`, `other`); unrecognised values are accepted by the API but recorded as `other` on the provider side. If omitted or blank, `other` is used. The field is informational only — it does not by itself block or alter cancellation eligibility.\n","example":"other"},"restock":{"type":"boolean","default":false,"description":"If true, instruct the provider to return the order's items to inventory as part of the cancellation. Currently honoured by Shopify; ignored by providers that do not expose an inventory restock operation on cancel. Defaults to false.\n","example":false},"notify_customer":{"type":"boolean","description":"If true, send a cancellation notification to the customer through the provider's standard channel (for Shopify, the merchant's configured cancellation email is sent). If omitted, the provider's own default notification behaviour applies — typically no email is sent.\n","example":true},"staff_note":{"type":"string","minLength":1,"maxLength":5000,"description":"Internal note attached to the cancellation, visible only to merchant staff in the provider's admin interface — never shown to the customer. Useful for audit trail (acting agent, free-text reason details, ticket reference, etc.). Currently honoured by Shopify.\n","example":"Cancelled at customer request — verified ID match (ticket #4821)"},"refund_method":{"type":"object","description":"How any outstanding balance on the order is refunded as part of the cancellation. Currently supported by Shopify only. The two sub-options are mutually exclusive — set at most one. If `refund_method` is omitted or both sub-fields are unset, no refund is issued automatically and the merchant can refund later via the provider's admin UI or via the dedicated refund API.\n","not":{"required":["original_payment_method","store_credit"]},"properties":{"original_payment_method":{"type":"boolean","description":"If true, refund the order amount back to the original payment method (e.g. the customer's credit card or wallet). Mutually exclusive with `store_credit`.\n","example":true},"store_credit":{"type":"object","description":"Issue the refund as store credit instead of a payment-method refund. Mutually exclusive with `original_payment_method`.\n","properties":{"expires_at":{"type":"string","format":"date-time","description":"Optional expiration timestamp for the issued store credit (ISO 8601, UTC). If omitted, the store credit does not expire.\n","example":"2027-01-01T00:00:00Z"}}}}},"custom_fields_type":{"type":"string","minLength":1,"maxLength":255,"description":"The type discriminator for custom_fields. Supported values: SHOPIFY, BIGCOMMERCE","example":"SHOPIFY"},"custom_fields":{"type":"object","description":"Additional custom fields for the order cancellation, determined by custom_fields_type"}}},"example":{"cancel_reason":"customer","restock":true,"notify_customer":true,"staff_note":"Cancelled at customer request — verified ID match (ticket #4821)","refund_method":{"original_payment_method":true}}}}},"responses":{"200":{"description":"OK. The response body is empty."},"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":{"operationId":"erc-ecommerce-connections-customers-customer-id-orders-order-id-change-shipping-address-post","x-internal":true,"tags":["Retail Experience Cloud Integrations"],"summary":"Change order shipping address","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":{"required":true,"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","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":{"operationId":"erc-ecommerce-connections-customers-customer-id-shipments-get","x-internal":true,"tags":["Retail Experience Cloud Integrations"],"summary":"Get customer shipments","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,"default":"id:desc","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":"string","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_updated":{"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","required":["value","currency"],"properties":{"value":{"type":"number","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":"string","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_updated":"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,"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":{"operationId":"erc-ecommerce-connections-customers-customer-id-shipments-schedule-post","x-internal":true,"tags":["Retail Experience Cloud Integrations"],"summary":"Schedule customer shipment slots","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":{"required":true,"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":{"operationId":"erc-ecommerce-connections-customers-customer-id-get","x-internal":true,"tags":["Retail Experience Cloud Integrations"],"summary":"Get customer by id","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","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":{"operationId":"erc-ecommerce-connections-customers-customer-id-orders-get","x-internal":true,"tags":["Retail Experience Cloud Integrations"],"summary":"Get customer orders","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":false,"schema":{"type":"integer","example":2,"minimum":1,"maximum":50,"default":10}},{"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"}},{"name":"order_by","in":"query","description":"The parameter to sort by. Use order_by=key1:desc for descending, order_by=key1:asc for ascending.","required":false,"schema":{"type":"string","default":"purchase_datetime:desc","maxLength":255,"minLength":1},"example":"purchase_datetime:desc","allowEmptyValue":true}],"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":{"allOf":[{"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","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":"int32","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"},"cancellation_status":{"type":"string","description":"The cancellation status of the order","example":"CANCELLATION_REQUESTED"},"fulfillment_status":{"type":"string","description":"The fulfillment status of the order","example":"FULFILLED"},"payment_status":{"type":"string","description":"The payment status of the order","example":"PAID"},"delivery_status":{"type":"string","description":"The delivery status of the order","example":"DELIVERED"},"return_status":{"type":"string","description":"The return status of the order","example":"RETURN_IN_PROGRESS"},"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"},"is_refundable":{"type":"boolean","description":"Indicates whether the current order is refundable","example":true},"is_returnable":{"type":"boolean","description":"Indicates whether the current order is returnable","example":true}}},{"type":"object","properties":{"is_cancellable":{"type":"boolean","description":"Flag indicating if the order can be cancelled","example":true},"is_change_shipping_address_allowed":{"type":"boolean","description":"Flag indicating if the shipping address of the order can be changed","example":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/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","is_refundable":true,"is_returnable":true,"is_cancellable":true,"is_change_shipping_address_allowed":true},{"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","is_refundable":true,"is_returnable":true,"is_cancellable":false,"is_change_shipping_address_allowed":false}]},"_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":{"operationId":"erc-ecommerce-connections-customers-customer-id-most-recent-order-get","x-internal":true,"tags":["Retail Experience Cloud Integrations"],"summary":"Get customer most recent order","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","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":"int32","description":"The quantity of the item","example":10,"minimum":0,"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":"int32","example":10,"minimum":0,"maximum":100},"refundable_quantity":{"type":"integer","description":"The quantity of the item that is refundable","format":"int32","example":3,"minimum":0,"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":"int32","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/"}}}]},"returnable_quantity":{"type":"integer","description":"The quantity of the item delivery that is returnable","example":1},"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"},"is_refundable":{"type":"boolean","description":"Indicates whether the current order is refundable","example":true},"is_returnable":{"type":"boolean","description":"Indicates whether the current order is returnable","example":true},"is_cancellable":{"type":"boolean","description":"Flag indicating if the order can be cancelled","example":true},"is_change_shipping_address_allowed":{"type":"boolean","description":"Flag indicating if the shipping address of the order can be changed","example":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/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","is_refundable":true,"is_returnable":true,"is_cancellable":true,"is_change_shipping_address_allowed":true,"_links":{"self":{"href":"http://api-docs.talkdesk.org/erc/ecommerce/connections/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":{"operationId":"erc-ecommerce-connections-customers-shipments-available-slots-get","x-internal":true,"tags":["Retail Experience Cloud Integrations"],"summary":"Get customer shipment available slots","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"],"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","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":{"operationId":"erc-ecommerce-connections-products-get","x-internal":true,"tags":["Retail Experience Cloud Integrations"],"summary":"Get or search store products","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":false,"schema":{"type":"integer","example":5,"minimum":1,"maximum":50,"default":10}},{"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","x-internal":true,"tags":["Retail Experience Cloud Integrations"],"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":"Get order items","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":false,"schema":{"type":"integer","example":5,"minimum":1,"maximum":50,"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":"int32","description":"The quantity of the item","example":10,"minimum":0,"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":"int32","example":10,"minimum":0,"maximum":100},"refundable_quantity":{"type":"integer","description":"The quantity of the item that is refundable","format":"int32","example":3,"minimum":0,"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":"int32","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/"}}}]},"returnable_quantity":{"type":"integer","description":"The quantity of the item delivery that is returnable","example":1},"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"},"line_item":{"description":"Summary of the order item associated with this refund line item","allOf":[{"type":"object","description":"A summary of an order line item linked to a refund or return","required":["id","name"],"properties":{"id":{"type":"string","description":"The ID of the order item","example":"orderItem123"},"name":{"type":"string","description":"The name of the order item","example":"Blue T-Shirt"},"price":{"description":"The price of the order 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","format":"uri","example":"https://cdn.example.com/item.png"},"quantity":{"type":"integer","description":"The quantity of the item","example":2},"sku":{"type":"string","description":"The SKU of the item","example":"SKU-001"},"description":{"type":"string","description":"The description of the item","example":"Cotton round-neck t-shirt"}}}]}}}]}},"transactions":{"type":"array","description":"List of refund transactions","items":{"allOf":[{"type":"object","description":"Represents a transaction for the refund","required":["id","created_at","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"}}}]}},"issued_by":{"description":"Attribution information for who issued the refund","allOf":[{"type":"object","description":"Attribution information identifying who issued a refund","required":["display_name","source"],"properties":{"display_name":{"type":"string","description":"Human-readable label for the refund issuer. Examples: \"Avery (Talkdesk Workspace)\", \"Shopify\", \"System (AfterShip)\", \"External Source\".\n","example":"Avery (Talkdesk Workspace)"},"source":{"type":"string","description":"Attribution source enum identifying the actor type that issued the refund. TALKDESK_AGENT: refund created by a Talkdesk Workspace agent. SHOPIFY_ADMIN: refund created directly in Shopify Admin (staff member or POS). THIRD_PARTY_APP: refund created by a third-party Shopify app (e.g. AfterShip). EXTERNAL_SOURCE: refund source could not be determined.\n","enum":["TALKDESK_AGENT","SHOPIFY_ADMIN","THIRD_PARTY_APP","EXTERNAL_SOURCE"],"example":"TALKDESK_AGENT"},"happened_at":{"type":"string","format":"date-time","description":"The timestamp when the refund was issued","example":"2026-05-28T06:45:31Z"},"raw_app_title":{"type":"string","description":"The Shopify app title for THIRD_PARTY_APP source. Not present for other sources.","example":"AfterShip"}}}]}}}},"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"}}},"line_item":{"description":"Summary of the order item associated with this return line item","allOf":[{"type":"object","description":"A summary of an order line item linked to a refund or return","required":["id","name"],"properties":{"id":{"type":"string","description":"The ID of the order item","example":"orderItem123"},"name":{"type":"string","description":"The name of the order item","example":"Blue T-Shirt"},"price":{"description":"The price of the order 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","format":"uri","example":"https://cdn.example.com/item.png"},"quantity":{"type":"integer","description":"The quantity of the item","example":2},"sku":{"type":"string","description":"The SKU of the item","example":"SKU-001"},"description":{"type":"string","description":"The description of the item","example":"Cotton round-neck t-shirt"}}}]}}}},"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","refundable_quantity":10,"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","refundable_quantity":20,"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","refundable_quantity":30,"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"},"returnable_quantity":10,"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","line_item":{"id":"orderItem123","name":"Order Item 123","price":{"value":100,"currency":"GBP"},"image_url":"https://external-integration.url.com/order_item_icon.png","quantity":10,"sku":"Sku 123","description":"Description of order Item 123"}}],"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"}],"issued_by":{"display_name":"Avery (Talkdesk Workspace)","source":"TALKDESK_AGENT","happened_at":"2025-02-22T10:00:00Z"}}],"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"},"line_item":{"id":"orderItem456","name":"Order Item 456","price":{"value":23.75,"currency":"USD"},"image_url":"https://external-integration.url.com/order_item_icon.png","quantity":20,"sku":"Sku 456","description":"Description of order Item 456"}}],"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","x-internal":true,"tags":["Retail Experience Cloud Integrations"],"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 order items","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","required":["ids"],"properties":{"ids":{"type":"array","description":"The list of order item ids to be cancelled","minItems":1,"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":"int32","description":"The quantity of the item","example":10,"minimum":0,"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":"int32","example":10,"minimum":0,"maximum":100},"refundable_quantity":{"type":"integer","description":"The quantity of the item that is refundable","format":"int32","example":3,"minimum":0,"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":"int32","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/"}}}]},"returnable_quantity":{"type":"integer","description":"The quantity of the item delivery that is returnable","example":1},"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"},"line_item":{"description":"Summary of the order item associated with this refund line item","allOf":[{"type":"object","description":"A summary of an order line item linked to a refund or return","required":["id","name"],"properties":{"id":{"type":"string","description":"The ID of the order item","example":"orderItem123"},"name":{"type":"string","description":"The name of the order item","example":"Blue T-Shirt"},"price":{"description":"The price of the order 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","format":"uri","example":"https://cdn.example.com/item.png"},"quantity":{"type":"integer","description":"The quantity of the item","example":2},"sku":{"type":"string","description":"The SKU of the item","example":"SKU-001"},"description":{"type":"string","description":"The description of the item","example":"Cotton round-neck t-shirt"}}}]}}}]}},"transactions":{"type":"array","description":"List of refund transactions","items":{"allOf":[{"type":"object","description":"Represents a transaction for the refund","required":["id","created_at","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"}}}]}},"issued_by":{"description":"Attribution information for who issued the refund","allOf":[{"type":"object","description":"Attribution information identifying who issued a refund","required":["display_name","source"],"properties":{"display_name":{"type":"string","description":"Human-readable label for the refund issuer. Examples: \"Avery (Talkdesk Workspace)\", \"Shopify\", \"System (AfterShip)\", \"External Source\".\n","example":"Avery (Talkdesk Workspace)"},"source":{"type":"string","description":"Attribution source enum identifying the actor type that issued the refund. TALKDESK_AGENT: refund created by a Talkdesk Workspace agent. SHOPIFY_ADMIN: refund created directly in Shopify Admin (staff member or POS). THIRD_PARTY_APP: refund created by a third-party Shopify app (e.g. AfterShip). EXTERNAL_SOURCE: refund source could not be determined.\n","enum":["TALKDESK_AGENT","SHOPIFY_ADMIN","THIRD_PARTY_APP","EXTERNAL_SOURCE"],"example":"TALKDESK_AGENT"},"happened_at":{"type":"string","format":"date-time","description":"The timestamp when the refund was issued","example":"2026-05-28T06:45:31Z"},"raw_app_title":{"type":"string","description":"The Shopify app title for THIRD_PARTY_APP source. Not present for other sources.","example":"AfterShip"}}}]}}}},"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"}}},"line_item":{"description":"Summary of the order item associated with this return line item","allOf":[{"type":"object","description":"A summary of an order line item linked to a refund or return","required":["id","name"],"properties":{"id":{"type":"string","description":"The ID of the order item","example":"orderItem123"},"name":{"type":"string","description":"The name of the order item","example":"Blue T-Shirt"},"price":{"description":"The price of the order 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","format":"uri","example":"https://cdn.example.com/item.png"},"quantity":{"type":"integer","description":"The quantity of the item","example":2},"sku":{"type":"string","description":"The SKU of the item","example":"SKU-001"},"description":{"type":"string","description":"The description of the item","example":"Cotton round-neck t-shirt"}}}]}}}},"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","refundable_quantity":0,"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","refundable_quantity":0,"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","refundable_quantity":0,"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"},"returnable_quantity":0,"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":{"operationId":"erc-ecommerce-connections-customers-cart-get","x-internal":true,"tags":["Retail Experience Cloud Integrations"],"summary":"Get customer cart","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","cost"],"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","type","discount_code"],"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","quantity","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","type","discount_code"],"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},"checkout":{"description":"The checkout access details for the cart, if available.","nullable":true,"type":"object","required":["url","expires_at"],"properties":{"url":{"type":"string","format":"uri","description":"The checkout URL for the cart.","example":"https://api.talkdesk.com/erc/ecommerce/cart/Z2NwLXVzLWNlbnRyYWwxOjAxSk%7C123123fff/checkout?token=a3f1c2d4e5b6&brand=my-store"},"expires_at":{"type":"string","format":"date-time","description":"When the checkout token expires (ISO 8601 with timezone offset).","example":"2026-06-27T10:00:00+00:00"}}},"_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","checkout":{"url":"https://api.talkdesk.com/erc/ecommerce/cart/7c357571-84bc-4238-8d21-06f794a0c68c/checkout?token=a3f1c2d4e5b6&brand=Brand+123","expires_at":"2026-06-27T10:00:00+00:00"},"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"},"cart_lines_discounts":[{"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/customers/{customer_id}":{"get":{"operationId":"erc-ecommerce-customers-customer-id-get","tags":["Retail Experience Cloud Bridge"],"summary":"Get Customer Details","description":"Read the customer by id.\n\nRequired fields:\n- customer_id\n\nA successful request returns the customer for the provided ID.\n","security":[{"GA":["erc-ecommerce-customers:read"]}],"parameters":[{"name":"customer_id","in":"path","required":true,"description":"The customer id","schema":{"type":"string","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"}}],"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"},"brand":{"type":"string","description":"The brand associated with the customer","example":"brand"},"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"},"addresses":{"type":"array","description":"The list of addresses associated with the customer","items":{"description":"Represents an address associated with a customer","allOf":[{"type":"object","description":"Represents an address of a customer or order","properties":{"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 to the ISO 3166-1 alpha-2 codes","example":"PT"}}},{"type":"object","properties":{"id":{"type":"string","description":"The ID of the address","example":"address1234"},"default":{"type":"boolean","description":"Whether this is the default address","example":true}}}]}},"integration_info":{"description":"The internal integration information","allOf":[{"type":"object","description":"Represents the external integration information","required":["external_url"],"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"}]}}}]},"average_order_value":{"description":"The average value of the customer orders over time","allOf":[{"type":"object","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"}}}]},"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/customers/customer123"}}}}}}},"examples":{"Valid Customer":{"value":{"id":"customer123","first_name":"John","last_name":"Doe","brand":"brand","customer_since":"2021-09-04T12:16:50.078Z","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"},"average_order_value":{"value":100,"currency":"USD"},"custom_fields":{"key1":"value1"},"_links":{"self":{"href":"http://api-docs.talkdesk.org/erc/ecommerce/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":"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"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"1974010","message":"Invalid JWT."}},"Account not configured to use ERC E-Commerce APIs":{"value":{"code":"1974011","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":"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."}}}},"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}/orders":{"get":{"operationId":"erc-ecommerce-customers-customer-id-orders-get","tags":["Retail Experience Cloud Bridge"],"summary":"Get Customer Orders","description":"Read the customer orders provided by the customer id.\n\nRequired fields:\n- customer_id\n\nA successful request returns the list of orders for the provided customer.\n","security":[{"GA":["erc-ecommerce-orders:read"]}],"parameters":[{"name":"customer_id","in":"path","required":true,"description":"The customer id","schema":{"type":"string","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"}},{"name":"limit","in":"query","description":"The amount of orders we want to get","required":false,"schema":{"type":"integer","example":5,"minimum":1,"maximum":50,"default":10}},{"name":"cursor","in":"query","description":"The opaque string that represents the cursor after which the 'limit' amount of orders are retrieved","schema":{"type":"string","default":""},"example":"eyJsYXN0X2lkIjo0MDU5NTY2MzQyMTY2LCJsYXN0X3ZhbHVlIjoiMjAyMS0wNi0yMyAyMjowNTowOC41MjU5OTEifQ==","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":"order_by","in":"query","description":"The parameter to sort by. Use order_by=key1:desc for descending, order_by=key1:asc for ascending. Allowed fields: purchase_datetime, id, order_number, items_number. Multiple fields can be comma-separated (e.g. purchase_datetime:desc,order_number:asc).","required":false,"schema":{"type":"string","default":"purchase_datetime:desc","maxLength":255,"minLength":1},"example":"purchase_datetime:desc","allowEmptyValue":true}],"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","required":["orders"],"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"},"brand":{"type":"string","description":"The brand associated with the order","example":"brand"},"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_address":{"description":"The address to which the order will be/was shipped","allOf":[{"type":"object","description":"Represents an address of a customer or order","properties":{"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 to the ISO 3166-1 alpha-2 codes","example":"PT"}}}]},"billing_address":{"description":"The billing address associated with the order","allOf":[{"type":"object","description":"Represents an address of a customer or order","properties":{"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 to the ISO 3166-1 alpha-2 codes","example":"PT"}}}]},"items_number":{"type":"integer","description":"The number of order items","example":3},"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","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","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","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","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","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","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","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","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"}}}]}}}]},"payment_details":{"description":"The payment details of the order","allOf":[{"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"}}}]},"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"},"cancellation_status":{"type":"string","description":"The cancellation status of the order","example":"CANCELLATION_REQUESTED"},"fulfillment_status":{"type":"string","description":"The fulfillment status of the order","example":"FULFILLED"},"payment_status":{"type":"string","description":"The payment status of the order","example":"PAID"},"delivery_status":{"type":"string","description":"The delivery status of the order","example":"DELIVERED"},"return_status":{"type":"string","description":"The return status of the order","example":"RETURN_IN_PROGRESS"},"custom_fields":{"type":"object","description":"The custom fields associated with the provider","additionalProperties":true},"is_refundable":{"type":"boolean","description":"Indicates whether the current order is refundable","example":true},"is_returnable":{"type":"boolean","description":"Indicates whether the current order is returnable","example":true},"is_cancellable":{"type":"boolean","description":"Indicates whether the current order can be cancelled","example":true},"is_change_shipping_address_allowed":{"type":"boolean","description":"Indicates whether the shipping address of the order can be changed","example":false}}}}}},"_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/orders?limit=2"}}},"next":{"type":"object","properties":{"href":{"type":"string","format":"uri","example":"http://api-docs.talkdesk.org/erc/ecommerce/customers/customer123/orders?limit=2&cursor=eyJsYXN0X2lkIjoxMjQ4MzU4NTYzODYyLCJsYXN0X3ZhbHVlIjoiMjAxOS0wNi0xNyAwMjoyMzo0Mi4wMDAwMDAifQ=="}}}}}}},"examples":{"Valid Order List":{"value":{"_embedded":{"orders":[{"id":"order456","order_number":"#Y34DHR","brand":"brand","customer_id":"customer123","purchase_datetime":"2021-09-14T12:16:50.078Z","delivery_type":"SHIPPING","shipping_address":{"first_name":"John","last_name":"Doe","phone_number":"+351910000000","address":"Lisbon","zip_code":"20000000","city":"Lisbon","region_code":"PT-11","country_code":"PT"},"billing_address":{"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"}},"payment_details":{"card_brand":"Visa","card_brand_image_url":"https://external-integration.url.com/payment_card_brand_icon.svg","card_number":"**** **** **** *567"},"order_extra_info":{"highlighted_item_image_url":"https://external-integration.url.com/payment_card_brand_icon.jpg"},"status":"CONFIRMED","is_refundable":true,"is_returnable":true},{"id":"order789","order_number":"#Y35DHR","brand":"brand","customer_id":"customer123","purchase_datetime":"2021-09-14T12:16:50.078Z","delivery_type":"SHIPPING","shipping_address":{"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","is_refundable":true,"is_returnable":true}]},"_links":{"self":{"href":"http://api-docs.talkdesk.org/erc/ecommerce/customers/customer123/orders?limit=2"},"next":{"href":"http://api-docs.talkdesk.org/erc/ecommerce/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":"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"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"1974010","message":"Invalid JWT."}},"Account not configured to use ERC E-Commerce APIs":{"value":{"code":"1974011","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":"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."}}}},"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}/orders/{order_id}":{"get":{"operationId":"erc-ecommerce-customers-customer-id-orders-order-id-get","tags":["Retail Experience Cloud Bridge"],"summary":"Get Customer Order","description":"Get the customer order for the provided customer and order ID.\n\nRequired fields:\n- customer_id\n- order_id\n\nA successful request returns the customer order for the provided customer and order ID.\n","security":[{"GA":["erc-ecommerce-orders:read"]}],"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","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"}}],"responses":{"200":{"description":"The customer order found with the provided customer id and order id","content":{"application/json":{"schema":{"allOf":[{"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"},"brand":{"type":"string","description":"The brand associated with the order","example":"brand"},"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_address":{"description":"The address to which the order will be/was shipped","allOf":[{"type":"object","description":"Represents an address of a customer or order","properties":{"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 to the ISO 3166-1 alpha-2 codes","example":"PT"}}}]},"billing_address":{"description":"The billing address associated with the order","allOf":[{"type":"object","description":"Represents an address of a customer or order","properties":{"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 to the ISO 3166-1 alpha-2 codes","example":"PT"}}}]},"items_number":{"type":"integer","description":"The number of order items","example":3},"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","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","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","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","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","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","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","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","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"}}}]}}}]},"payment_details":{"description":"The payment details of the order","allOf":[{"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"}}}]},"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"},"cancellation_status":{"type":"string","description":"The cancellation status of the order","example":"CANCELLATION_REQUESTED"},"fulfillment_status":{"type":"string","description":"The fulfillment status of the order","example":"FULFILLED"},"payment_status":{"type":"string","description":"The payment status of the order","example":"PAID"},"delivery_status":{"type":"string","description":"The delivery status of the order","example":"DELIVERED"},"return_status":{"type":"string","description":"The return status of the order","example":"RETURN_IN_PROGRESS"},"custom_fields":{"type":"object","description":"The custom fields associated with the provider","additionalProperties":true},"is_refundable":{"type":"boolean","description":"Indicates whether the current order is refundable","example":true},"is_returnable":{"type":"boolean","description":"Indicates whether the current order is returnable","example":true},"is_cancellable":{"type":"boolean","description":"Indicates whether the current order can be cancelled","example":true},"is_change_shipping_address_allowed":{"type":"boolean","description":"Indicates whether the shipping address of the order can be changed","example":false}}},{"type":"object","properties":{"_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/orders/order123"}}}}}}}]},"examples":{"Valid Order":{"value":{"id":"order456","order_number":"#Y34DHR","customer_id":"customer123","brand":"brand","purchase_datetime":"2021-09-14T12:16:50.078Z","delivery_type":"SHIPPING","shipping_address":{"first_name":"John","last_name":"Doe","phone_number":"+351910000000","address":"Lisbon","zip_code":"20000000","city":"Lisbon","region_code":"PT-11","country_code":"PT"},"billing_address":{"first_name":"John","last_name":"Doe","phone_number":"+351910000000","address":"Lisbon","zip_code":"20000000","city":"Lisbon","region_code":"PT-11","country_code":"PT"},"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"}},"payment_details":{"card_brand":"Visa","card_brand_image_url":"https://external-integration.url.com/payment_card_brand_icon.svg","card_number":"**** **** **** *567","is_refunded":false},"order_extra_info":{"highlighted_item_image_url":"https://external-integration.url.com/payment_card_brand_icon.jpg"},"items_number":1,"status":"CONFIRMED","is_refundable":true,"is_returnable":true,"_links":{"self":{"href":"http://api-docs.talkdesk.org/erc/ecommerce/customers/customer123/orders/order321"}}}}}}}},"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"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"1974010","message":"Invalid JWT."}},"Account not configured to use ERC E-Commerce APIs":{"value":{"code":"1974011","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":"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."}}}},"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."}}}}}},"patch":{"operationId":"erc-ecommerce-customers-customer-id-orders-order-id-patch","tags":["Retail Experience Cloud Bridge"],"summary":"Update order attributes","description":"Partially update attributes of a customer's order.\n\nCurrently only the `tags` field is supported. Tags are prepended in front\nof the existing tags. Duplicates are removed case-insensitively, keeping\nthe first occurrence (new tags win). More fields will be added in future\niterations.\n\nRequired fields:\n- customer_id\n- order_id\n- tags (non-empty list)\n\nA successful request returns the order with the updated attributes.\n\nThis operation is only supported for Shopify integrations.\n","security":[{"GA":["erc-ecommerce-orders:write"]}],"parameters":[{"name":"customer_id","in":"path","required":true,"description":"The customer ID","schema":{"type":"string","minLength":1,"maxLength":255,"example":"customer123"}},{"name":"order_id","in":"path","required":true,"description":"The order ID","schema":{"type":"string","minLength":1,"maxLength":255,"example":"order123"}},{"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":50,"minLength":1,"example":"Brand A"}}],"requestBody":{"required":true,"description":"The order attributes to update","content":{"application/json":{"schema":{"type":"object","required":["tags"],"properties":{"tags":{"type":"array","description":"Tags to prepend (deduplicated, case-insensitive) to the order's existing tags. Must contain at least one non-blank tag.","minItems":1,"items":{"type":"string","minLength":1,"maxLength":255,"pattern":"\\S"},"example":["priority","vip"]}}},"example":{"tags":["priority","vip"]}}}},"responses":{"200":{"description":"The order information updated with the new attributes","content":{"application/json":{"schema":{"type":"object","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"},"brand":{"type":"string","description":"The brand associated with the order","example":"brand"},"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":{"type":"string","description":"Represents the type of delivery for a given order","enum":["UNKNOWN","LOCAL_DELIVERY","LOCAL_PICKUP","SHIPPING"],"example":"SHIPPING"},"shipping_address":{"type":"object","description":"Represents an address of a customer or order","properties":{"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 to the ISO 3166-1 alpha-2 codes","example":"PT"}}},"billing_address":{"type":"object","description":"Represents an address of a customer or order","properties":{"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 to the ISO 3166-1 alpha-2 codes","example":"PT"}}},"items_number":{"type":"integer","description":"The number of order items","example":3},"price_summary":{"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","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","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","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","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","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","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","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","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"}}}]}}},"payment_details":{"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"}}},"order_extra_info":{"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"},"cancellation_status":{"type":"string","description":"The cancellation status of the order","example":"CANCELLATION_REQUESTED"},"fulfillment_status":{"type":"string","description":"The fulfillment status of the order","example":"FULFILLED"},"payment_status":{"type":"string","description":"The payment status of the order","example":"PAID"},"delivery_status":{"type":"string","description":"The delivery status of the order","example":"DELIVERED"},"return_status":{"type":"string","description":"The return status of the order","example":"RETURN_IN_PROGRESS"},"custom_fields":{"type":"object","description":"The custom fields associated with the provider","additionalProperties":true},"is_refundable":{"type":"boolean","description":"Indicates whether the current order is refundable","example":true},"is_returnable":{"type":"boolean","description":"Indicates whether the current order is returnable","example":true},"is_cancellable":{"type":"boolean","description":"Indicates whether the current order can be cancelled","example":true},"is_change_shipping_address_allowed":{"type":"boolean","description":"Indicates whether the shipping address of the order can be changed","example":false},"tags":{"type":"array","description":"The list of tags associated with the order","items":{"type":"string","minLength":1,"maxLength":255,"pattern":"\\S"},"example":["priority","vip"]}}},"examples":{"Valid Order":{"value":{"id":"order456","order_number":"#1131","customer_id":"customer123","brand":"brand","purchase_datetime":"2022-12-12T16:59:18.000Z","delivery_type":"SHIPPING","shipping_address":{"first_name":"John","last_name":"Doe","phone_number":"+351910000000","address":"Rua da Alagoa, Lote 16","zip_code":"3620-360","city":"Moimenta da Beira","region_code":"PT-18","country_code":"PT"},"tags":["priority","vip","existing-tag"],"items_number":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":"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"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"1974010","message":"Invalid JWT."}},"Account not configured to use ERC E-Commerce APIs":{"value":{"code":"1974011","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":"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}/orders/{order_id}/items":{"get":{"operationId":"erc-ecommerce-customers-customer-id-orders-order-id-items-get","tags":["Retail Experience Cloud Bridge"],"summary":"Get Order Items","description":"Read the customer order items for the provided customer id and order id.\n\nRequired fields:\n- customer_id\n- order_id\n\nA successful request returns the list of order items for the provided customer and order.\n","security":[{"GA":["erc-ecommerce-orders:read"]}],"parameters":[{"name":"customer_id","in":"path","required":true,"description":"The customer id","schema":{"type":"string","minLength":1,"maxLength":255,"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"}},{"name":"order_id","in":"path","required":true,"description":"The order id","schema":{"type":"string","minLength":1,"maxLength":255,"example":"order789"}},{"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":false,"schema":{"type":"integer","example":5,"minimum":1,"maximum":100,"default":50}},{"name":"order_by","in":"query","required":false,"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","default":"","x-sorting_default_order":"asc","x-sorting_fields":["id","name","brand","price","quantity","sku","deliverable_quantity"]},"example":"price:desc","allowEmptyValue":true},{"name":"cursor","in":"query","description":"The opaque string that represents the cursor after which the 'limit' amount of order items are retrieved","schema":{"type":"string","default":""},"example":"eyJsYXN0X2lkIjo0MDU5NTY2MzQyMTY2LCJsYXN0X3ZhbHVlIjoiMjAyMS0wNi0yMyAyMjowNTowOC41MjU5OTEifQ==","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 paginated list of customer order items","required":["_embedded","_links"],"properties":{"_embedded":{"required":["items"],"type":"object","properties":{"items":{"type":"array","description":"The list of order items in the current page","items":{"type":"object","description":"Represents an item that was ordered","required":["id","name"],"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 brand of the item","example":"Brand 123"},"price":{"description":"The price of the item","allOf":[{"type":"object","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","description":"The quantity of the item","example":10},"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","example":10},"refundable_quantity":{"type":"integer","description":"The quantity of the item that is refundable","example":3},"deliveries":{"type":"array","description":"List of deliveries where the item is inserted","items":{"allOf":[{"type":"object","description":"Represents an order item delivery resource","properties":{"id":{"type":"string","description":"The ID of the order delivery","example":"orderDelivery123"},"delivery_quantity":{"type":"integer","description":"The quantity of items associated with the delivery","example":10},"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","properties":{"type":{"description":"The type of the state/step","allOf":[{"type":"string","description":"Represents the detailed type of a given order status info event","enum":["UNKNOWN","ATTEMPTED_DELIVERY","READY_FOR_PICKUP","PICKED_UP","CONFIRMED","IN_TRANSIT","OUT_FOR_DELIVERY","DELIVERED","FAILURE"],"example":"IN_TRANSIT"}]},"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","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/"}}}]},"returnable_quantity":{"type":"integer","description":"The quantity of the item delivery that is returnable","example":1},"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 order item","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"},"line_item":{"description":"Summary of the order item associated with this refund line item","allOf":[{"type":"object","description":"A summary of an order line item linked to a refund or return","required":["id","name"],"properties":{"id":{"type":"string","description":"The ID of the order item","example":"orderItem123"},"name":{"type":"string","description":"The name of the order item","example":"Blue T-Shirt"},"price":{"description":"The price of the order item","allOf":[{"type":"object","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","format":"uri","example":"https://cdn.example.com/item.png"},"quantity":{"type":"integer","description":"The quantity of the item","example":2},"sku":{"type":"string","description":"The SKU of the item","example":"SKU-001"},"description":{"type":"string","description":"The description of the item","example":"Cotton round-neck t-shirt"}}}]}}}]}},"transactions":{"type":"array","description":"List of refund transactions","items":{"allOf":[{"type":"object","description":"Represents a transaction for the refund","required":["id","created_at","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"}}}}}]}},"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"}}}]}},"issued_by":{"description":"Attribution information for who issued the refund","allOf":[{"type":"object","description":"Attribution information identifying who issued a refund","required":["display_name","source"],"properties":{"display_name":{"type":"string","description":"Human-readable label for the refund issuer. Examples: \"Avery (Talkdesk Workspace)\", \"Shopify\", \"System (AfterShip)\", \"External Source\".\n","example":"Avery (Talkdesk Workspace)"},"source":{"type":"string","description":"Attribution source enum identifying the actor type that issued the refund. TALKDESK_AGENT: refund created by a Talkdesk Workspace agent. SHOPIFY_ADMIN: refund created directly in Shopify Admin (staff member or POS). THIRD_PARTY_APP: refund created by a third-party Shopify app (e.g. AfterShip). EXTERNAL_SOURCE: refund source could not be determined.\n","enum":["TALKDESK_AGENT","SHOPIFY_ADMIN","THIRD_PARTY_APP","EXTERNAL_SOURCE"],"example":"TALKDESK_AGENT"},"happened_at":{"type":"string","format":"date-time","description":"The timestamp when the refund was issued","example":"2026-05-28T06:45:31Z"},"raw_app_title":{"type":"string","description":"The Shopify app title for THIRD_PARTY_APP source. Not present for other sources.","example":"AfterShip"}}}]}}}},"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"}}},"line_item":{"description":"Summary of the order item associated with this return line item","allOf":[{"type":"object","description":"A summary of an order line item linked to a refund or return","required":["id","name"],"properties":{"id":{"type":"string","description":"The ID of the order item","example":"orderItem123"},"name":{"type":"string","description":"The name of the order item","example":"Blue T-Shirt"},"price":{"description":"The price of the order item","allOf":[{"type":"object","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","format":"uri","example":"https://cdn.example.com/item.png"},"quantity":{"type":"integer","description":"The quantity of the item","example":2},"sku":{"type":"string","description":"The SKU of the item","example":"SKU-001"},"description":{"type":"string","description":"The description of the item","example":"Cotton round-neck t-shirt"}}}]}}}},"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","minLength":1},"sku":{"type":"string","description":"The SKU of the product variant","example":"productVariant123Sku","minLength":0},"price":{"type":"object","description":"The price of the product variant","allOf":[{"type":"object","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","minLength":1}},"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","minLength":1},"example":{"Color":"White","Size":"XS"}},"available_quantity":{"type":"integer","format":"int64","description":"The product's variant quantity available in stock","default":0,"example":1000}}}}}},"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","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/customers/customer123/orders/order789/items?limit=2&order_by=price:desc"}}},"next":{"type":"object","properties":{"href":{"type":"string","format":"uri","example":"http://api-docs.talkdesk.org/erc/ecommerce/customers/customer123/orders/order789/items?limit=2&order_by=price:desc&cursor=eyJsYXN0X2lkIjoxMjQ4MzU4NTYzODYyLCJsYXN0X3ZhbHVlIjoiMjAxOS0wNi0xNyAwMjoyMzo0Mi4wMDAwMDAifQ=="}}}}}}},"examples":{"Valid Order Items 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,"sku":"Sku 123","deliverable_quantity":10,"refundable_quantity":10},{"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,"sku":"Sku 456","deliverable_quantity":20,"refundable_quantity":20},{"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,"sku":"Sku 678","deliverable_quantity":10,"refundable_quantity":30,"deliveries":[{"id":"orderDelivery123","delivery_quantity":20,"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"},"returnable_quantity":20,"last_update":"2021-10-24T12:16:50.078Z"}]}],"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","line_item":{"id":"orderItem123","name":"Order Item 123","price":{"value":100,"currency":"GBP"},"image_url":"https://external-integration.url.com/order_item_icon.png","quantity":10,"sku":"Sku 123","description":"Description of order Item 123"}}],"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"}}],"shipping_lines":[{"id":"shipfee001","amount":0,"currency":"GBP"}],"issued_by":{"display_name":"Avery (Talkdesk Workspace)","source":"TALKDESK_AGENT","happened_at":"2025-02-22T10:00:00Z"}}],"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"},"line_item":{"id":"orderItem456","name":"Order Item 456","price":{"value":23.75,"currency":"USD"},"image_url":"https://external-integration.url.com/order_item_icon.png","quantity":20,"sku":"Sku 456","description":"Description of order Item 456"}}],"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/customers/customer123/orders/order789/items?limit=2&order_by=price:desc"},"next":{"href":"http://api-docs.talkdesk.org/erc/ecommerce/customers/customer123/orders/order789/items?limit=2&order_by=price: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"}}}}}},"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"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"1974010","message":"Invalid JWT."}},"Account not configured to use ERC E-Commerce APIs":{"value":{"code":"1974011","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":"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."}}}},"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}/orders/{order_id}/items/cancel":{"put":{"operationId":"erc-ecommerce-customers-customer-id-orders-order-id-items-cancel-put","tags":["Retail Experience Cloud Bridge"],"summary":"Cancel Customer Order Items","description":"Cancel items from the customer order with the provided customer ID and order ID.\n\nRequired fields:\n- customer_id\n- order_id\n\nA successful request cancels the specified order items and returns the updated list of cancelled items.\n","security":[{"GA":["erc-ecommerce-orders:write"]}],"parameters":[{"name":"customer_id","in":"path","required":true,"description":"The customer id","schema":{"type":"string","minLength":1,"maxLength":255,"example":"customer123"}},{"name":"order_id","in":"path","required":true,"description":"The order id","schema":{"type":"string","minLength":1,"maxLength":255,"example":"order789"}},{"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":50,"minLength":1,"example":"Brand A"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ids"],"properties":{"ids":{"type":"array","description":"The list of order item ids to be cancelled","minItems":1,"items":{"type":"string","minLength":1},"example":["orderItem123","orderItem456","orderItem678"]}}}}}},"responses":{"200":{"description":"The list of cancelled customer order items for the provided customer id and order id.","content":{"application/json":{"schema":{"type":"object","description":"Represents the list of cancelled customer order items","required":["_embedded","_links"],"properties":{"_embedded":{"required":["items"],"type":"object","properties":{"items":{"type":"array","description":"The list of cancelled order items","items":{"type":"object","description":"Represents an item that was ordered","required":["id","name"],"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 brand of the item","example":"Brand 123"},"price":{"description":"The price of the item","allOf":[{"type":"object","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","description":"The quantity of the item","example":10},"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","example":10},"refundable_quantity":{"type":"integer","description":"The quantity of the item that is refundable","example":3},"deliveries":{"type":"array","description":"List of deliveries where the item is inserted","items":{"allOf":[{"type":"object","description":"Represents an order item delivery resource","properties":{"id":{"type":"string","description":"The ID of the order delivery","example":"orderDelivery123"},"delivery_quantity":{"type":"integer","description":"The quantity of items associated with the delivery","example":10},"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","properties":{"type":{"description":"The type of the state/step","allOf":[{"type":"string","description":"Represents the detailed type of a given order status info event","enum":["UNKNOWN","ATTEMPTED_DELIVERY","READY_FOR_PICKUP","PICKED_UP","CONFIRMED","IN_TRANSIT","OUT_FOR_DELIVERY","DELIVERED","FAILURE"],"example":"IN_TRANSIT"}]},"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","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/"}}}]},"returnable_quantity":{"type":"integer","description":"The quantity of the item delivery that is returnable","example":1},"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 order item","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/customer123/orders/order789/items/cancel"}}}}}}},"examples":{"Cancelled Order Items 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,"sku":"Sku 123","deliverable_quantity":10,"refundable_quantity":0},{"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,"sku":"Sku 456","deliverable_quantity":20,"refundable_quantity":0},{"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,"sku":"Sku 678","deliverable_quantity":10,"refundable_quantity":0}]},"_links":{"self":{"href":"http://api-docs.talkdesk.org/erc/ecommerce/customers/customer123/orders/order789/items/cancel"}}}}}}}},"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"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"1974010","message":"Invalid JWT."}},"Account not configured to use ERC E-Commerce APIs":{"value":{"code":"1974011","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":"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."}}}},"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}/orders/{order_id}/change-shipping-address":{"post":{"operationId":"erc-ecommerce-customers-customer-id-orders-order-id-change-shipping-address-post","tags":["Retail Experience Cloud Bridge"],"summary":"Change Order Shipping Address","description":"Change the shipping address of a customer's order.\n\nRequired fields:\n- customer_id\n- order_id\n\nA successful request updates the shipping address and returns the order with the new address.\n","security":[{"GA":["erc-ecommerce-orders:write"]}],"parameters":[{"name":"customer_id","in":"path","required":true,"description":"The customer id","schema":{"type":"string","minLength":1,"maxLength":255,"example":"customer123"}},{"name":"order_id","in":"path","required":true,"description":"The order id","schema":{"type":"string","minLength":1,"maxLength":255,"example":"order123"}},{"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":50,"minLength":1,"example":"Brand A"}}],"requestBody":{"required":true,"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","properties":{"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 to the ISO 3166-1 alpha-2 codes","example":"PT"}}},{"type":"object","properties":{"id":{"type":"string","description":"The ID of the address","example":"address123"},"default":{"type":"boolean","description":"Whether this is the default address","example":false}}}]},"example":{"phone_number":"+351910000000","first_name":"John","last_name":"Doe","address":"Lisbon","zip_code":"20000000","city":"Lisbon","country_code":"PT","region_code":"PT-11"}}}},"responses":{"200":{"description":"The order information updated with the new shipping_address","content":{"application/json":{"schema":{"allOf":[{"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"},"brand":{"type":"string","description":"The brand associated with the order","example":"brand"},"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_address":{"description":"The address to which the order will be/was shipped","allOf":[{"type":"object","description":"Represents an address of a customer or order","properties":{"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 to the ISO 3166-1 alpha-2 codes","example":"PT"}}}]},"billing_address":{"description":"The billing address associated with the order","allOf":[{"type":"object","description":"Represents an address of a customer or order","properties":{"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 to the ISO 3166-1 alpha-2 codes","example":"PT"}}}]},"items_number":{"type":"integer","description":"The number of order items","example":3},"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","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","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","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","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","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","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","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","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"}}}]}}}]},"payment_details":{"description":"The payment details of the order","allOf":[{"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"}}}]},"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"},"cancellation_status":{"type":"string","description":"The cancellation status of the order","example":"CANCELLATION_REQUESTED"},"fulfillment_status":{"type":"string","description":"The fulfillment status of the order","example":"FULFILLED"},"payment_status":{"type":"string","description":"The payment status of the order","example":"PAID"},"delivery_status":{"type":"string","description":"The delivery status of the order","example":"DELIVERED"},"return_status":{"type":"string","description":"The return status of the order","example":"RETURN_IN_PROGRESS"},"custom_fields":{"type":"object","description":"The custom fields associated with the provider","additionalProperties":true},"is_refundable":{"type":"boolean","description":"Indicates whether the current order is refundable","example":true},"is_returnable":{"type":"boolean","description":"Indicates whether the current order is returnable","example":true},"is_cancellable":{"type":"boolean","description":"Indicates whether the current order can be cancelled","example":true},"is_change_shipping_address_allowed":{"type":"boolean","description":"Indicates whether the shipping address of the order can be changed","example":false}}}]},"examples":{"Valid Order":{"value":{"id":"order456","order_number":"#Y34DHR","customer_id":"customer123","brand":"brand","purchase_datetime":"2021-09-14T12:16:50.078Z","delivery_type":"SHIPPING","shipping_address":{"first_name":"John","last_name":"Doe","phone_number":"+351910000000","address":"Lisbon","zip_code":"20000000","city":"Lisbon","region_code":"PT-11","country_code":"PT"},"billing_address":{"first_name":"John","last_name":"Doe","phone_number":"+351910000000","address":"Lisbon","zip_code":"20000000","city":"Lisbon","region_code":"PT-11","country_code":"PT"},"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"}},"payment_details":{"card_brand":"Visa","card_brand_image_url":"https://external-integration.url.com/payment_card_brand_icon.svg","card_number":"**** **** **** *567"},"order_extra_info":{"highlighted_item_image_url":"https://external-integration.url.com/payment_card_brand_icon.jpg"},"items_number":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":"1974000","message":"Bad request."}},"Invalid Address":{"value":{"code":"1974001","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":"1974010","message":"Invalid JWT."}},"Account not configured to use ERC E-Commerce APIs":{"value":{"code":"1974011","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":"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}/orders/{order_id}/cancel":{"post":{"operationId":"erc-ecommerce-customers-customer-id-orders-order-id-cancel-post","tags":["Retail Experience Cloud Bridge"],"summary":"Cancel Customer Order","description":"Cancel a customer's order.\n\nRequired fields:\n- customer_id\n- order_id\n\nA successful request cancels the order and returns it with the updated status CANCELLED.\n","security":[{"GA":["erc-ecommerce-orders:write"]}],"parameters":[{"name":"customer_id","in":"path","required":true,"description":"The customer id","schema":{"type":"string","minLength":1,"maxLength":255,"example":"customer123"}},{"name":"order_id","in":"path","required":true,"description":"The order id","schema":{"type":"string","minLength":1,"maxLength":255,"example":"order123"}},{"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":50,"minLength":1,"example":"Brand A"}}],"requestBody":{"description":"The order cancellation options. The body itself is optional — call the endpoint without a body to cancel with provider defaults.\n","content":{"application/json":{"schema":{"type":"object","description":"Options applied when cancelling a customer's order. All fields are optional. Provider support varies per field; fields not supported by the resolved provider are accepted by the API and silently ignored on the provider side rather than rejected. The request body itself is optional — calling the endpoint without a body cancels the order with provider defaults (`cancel_reason=other`, `restock=false`, no customer notification, no automatic refund).\n","properties":{"cancel_reason":{"type":"string","minLength":1,"maxLength":255,"description":"Hint describing why the order is being cancelled. The value is normalised by the underlying provider — for Shopify, it is matched case-insensitively against the `OrderCancelReason` GraphQL enum (`customer`, `declined`, `fraud`, `inventory`, `staff`, `other`); unrecognised values are accepted by the API but recorded as `other` on the provider side. If omitted or blank, `other` is used. The field is informational only — it does not by itself block or alter cancellation eligibility.\n","example":"other"},"restock":{"type":"boolean","default":false,"description":"If true, instruct the provider to return the order's items to inventory as part of the cancellation. Currently honoured by Shopify; ignored by providers that do not expose an inventory restock operation on cancel. Defaults to false.\n","example":false},"notify_customer":{"type":"boolean","description":"If true, send a cancellation notification to the customer through the provider's standard channel (for Shopify, the merchant's configured cancellation email is sent). If omitted, the provider's own default notification behaviour applies — typically no email is sent.\n","example":true},"staff_note":{"type":"string","minLength":1,"maxLength":1000,"description":"Internal note attached to the cancellation, visible only to merchant staff in the provider's admin interface — never shown to the customer. Useful for audit trail (acting agent, free-text reason details, ticket reference, etc.). Currently honoured by Shopify.\n","example":"Cancelled at customer request — verified ID match (ticket #4821)"},"refund_method":{"type":"object","description":"How any outstanding balance on the order is refunded as part of the cancellation. Currently supported by Shopify only. The two sub-options are mutually exclusive — set at most one. If `refund_method` is omitted or both sub-fields are unset, no refund is issued automatically and the merchant can refund later via the provider's admin UI or via the dedicated refund API.\n","not":{"required":["original_payment_method","store_credit"]},"properties":{"original_payment_method":{"type":"boolean","description":"If true, refund the order amount back to the original payment method (e.g. the customer's credit card or wallet). Mutually exclusive with `store_credit`.\n","example":true},"store_credit":{"type":"object","description":"Issue the refund as store credit instead of a payment-method refund. Mutually exclusive with `original_payment_method`.\n","properties":{"expires_at":{"type":"string","format":"date-time","description":"Optional expiration timestamp for the issued store credit (ISO 8601, UTC). If omitted, the store credit does not expire.\n","example":"2027-01-01T00:00:00Z"}}}}},"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}}},"example":{"cancel_reason":"customer","restock":true,"notify_customer":true,"staff_note":"Cancelled at customer request — verified ID match (ticket #4821)","refund_method":{"original_payment_method":true},"custom_fields_type":"BIGCOMMERCE","custom_fields":{"custom_field_1":"99999"}}}}},"responses":{"200":{"description":"The order information updated with the new status CANCELLED","content":{"application/json":{"schema":{"allOf":[{"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"},"brand":{"type":"string","description":"The brand associated with the order","example":"brand"},"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_address":{"description":"The address to which the order will be/was shipped","allOf":[{"type":"object","description":"Represents an address of a customer or order","properties":{"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 to the ISO 3166-1 alpha-2 codes","example":"PT"}}}]},"billing_address":{"description":"The billing address associated with the order","allOf":[{"type":"object","description":"Represents an address of a customer or order","properties":{"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 to the ISO 3166-1 alpha-2 codes","example":"PT"}}}]},"items_number":{"type":"integer","description":"The number of order items","example":3},"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","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","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","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","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","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","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","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","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"}}}]}}}]},"payment_details":{"description":"The payment details of the order","allOf":[{"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"}}}]},"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"},"cancellation_status":{"type":"string","description":"The cancellation status of the order","example":"CANCELLATION_REQUESTED"},"fulfillment_status":{"type":"string","description":"The fulfillment status of the order","example":"FULFILLED"},"payment_status":{"type":"string","description":"The payment status of the order","example":"PAID"},"delivery_status":{"type":"string","description":"The delivery status of the order","example":"DELIVERED"},"return_status":{"type":"string","description":"The return status of the order","example":"RETURN_IN_PROGRESS"},"custom_fields":{"type":"object","description":"The custom fields associated with the provider","additionalProperties":true},"is_refundable":{"type":"boolean","description":"Indicates whether the current order is refundable","example":true},"is_returnable":{"type":"boolean","description":"Indicates whether the current order is returnable","example":true},"is_cancellable":{"type":"boolean","description":"Indicates whether the current order can be cancelled","example":true},"is_change_shipping_address_allowed":{"type":"boolean","description":"Indicates whether the shipping address of the order can be changed","example":false}}}]},"examples":{"Valid Order":{"value":{"id":"order456","order_number":"#Y34DHR","brand":"brand","customer_id":"customer123","purchase_datetime":"2021-09-14T12:16:50.078Z","delivery_type":"SHIPPING","shipping_address":{"first_name":"John","last_name":"Doe","phone_number":"+351910000000","address":"Lisbon","zip_code":"20000000","city":"Lisbon","region_code":"PT-11","country_code":"PT"},"billing_address":{"first_name":"John","last_name":"Doe","phone_number":"+351910000000","address":"Lisbon","zip_code":"20000000","city":"Lisbon","region_code":"PT-11","country_code":"PT"},"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"}},"payment_details":{"card_brand":"Visa","card_brand_image_url":"https://external-integration.url.com/payment_card_brand_icon.svg","card_number":"**** **** **** *567"},"order_extra_info":{"highlighted_item_image_url":"https://external-integration.url.com/payment_card_brand_icon.jpg"},"items_number":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":"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"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"1974010","message":"Invalid JWT."}},"Account not configured to use ERC E-Commerce APIs":{"value":{"code":"1974011","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":"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}/orders/{order_id}/cancel-preview":{"get":{"operationId":"erc-ecommerce-customers-customer-id-orders-order-id-cancel-preview-get","tags":["Retail Experience Cloud Bridge"],"summary":"Get order cancellation preview","description":"Retrieves pre-cancellation preview data for a customer's order.\n\nUse this endpoint to populate the cancellation UI before submitting the\ncancel request. The response includes:\n\n- `use_new_cancel_flow` — whether to render the rich cancel popup\n (Shopify) or the legacy single-field flow (BigCommerce, Custom).\n- `supports_refund_on_cancel` — whether the order has a paid balance\n eligible for refund on cancellation.\n- `cancel_reasons` — the list of selectable cancellation reason options.\n- `refund_payments` — the suggested refund amount and payment gateway\n for the original payment method.\n- `refundable_items` — line items that would be included in the refund.\n\nFor BigCommerce and Custom integrations, `use_new_cancel_flow` is always\n`false`. In that case, `cancel_reasons` and `refundable_items` are returned\nas empty lists, and `refund_payments` is empty lists.\n","security":[{"GA":["erc-ecommerce-orders:read"]}],"parameters":[{"name":"customer_id","in":"path","required":true,"description":"The customer identifier.","schema":{"type":"string","minLength":1,"maxLength":255,"example":"customer123"}},{"name":"order_id","in":"path","required":true,"description":"The order identifier.","schema":{"type":"string","minLength":1,"maxLength":255,"example":"order123"}},{"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":50,"minLength":1,"example":"Brand A"}}],"responses":{"200":{"description":"Pre-cancellation preview data for the order.","content":{"application/json":{"schema":{"type":"object","description":"Pre-cancellation preview data for a customer's order. The response allows the caller to render the cancellation UI — including the refund payment breakdown, selectable cancellation reasons, and the list of refundable items — before the cancel request is submitted.\n`use_new_cancel_flow` indicates whether the richer cancellation UI should be shown. Currently `true` only for Shopify integrations; `false` for BigCommerce and Custom, which only support the legacy single-field cancel flow.\n","required":["use_new_cancel_flow","supports_refund_on_cancel","cancel_reasons","refundable_items"],"properties":{"use_new_cancel_flow":{"type":"boolean","description":"If `true`, the caller should render the rich cancel popup (refund payment method selector, reason dropdown, staff note, notify-customer and restock checkboxes). If `false`, only the legacy cancel reason text field should be shown.\n","example":true},"supports_refund_on_cancel":{"type":"boolean","description":"If `true`, the order has an outstanding paid balance that can be refunded as part of the cancellation. If `false` (e.g., an unpaid order, or a non-Shopify integration), no refund selector should be rendered.\n","example":true},"cancel_reasons":{"type":"array","description":"Ordered list of cancellation reason options to display in the UI dropdown. Empty for non-Shopify integrations.\n","items":{"type":"object","required":["value","label"],"properties":{"value":{"type":"string","description":"Enum value to pass as `cancel_reason` in the cancel request body.\n","example":"CUSTOMER"},"label":{"type":"string","description":"Human-readable label for display in the UI.","example":"Customer changed or canceled order"}}}},"refund_payments":{"type":"array","description":"Suggested refund entries, one per payment method used in the original order. For orders with a single payment method this array contains one element. For orders with split payments (e.g. credit card + gift card), each payment source appears as a separate entry. Returns an empty array when `supports_refund_on_cancel` is `false` (e.g. an unpaid order or a non-Shopify integration).\n","items":{"type":"object","required":["amount"],"properties":{"amount":{"description":"Amount that would be refunded.","type":"object","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"}}},"formatted_gateway":{"type":"string","nullable":true,"description":"Human-readable payment gateway name (e.g. `\"Manual\"`, `\"Shopify Payments\"`). May be `null` if the gateway name is unavailable.\n","example":"Manual"}}}},"refundable_items":{"type":"array","description":"Line items that would be refunded as part of this cancellation. Empty for non-Shopify integrations or unpaid orders.\n","items":{"type":"object","required":["line_item_id","title","quantity","max_refundable_quantity","restockable","original_unit_price"],"properties":{"line_item_id":{"type":"string","description":"Provider-specific line item identifier.","example":"gid://shopify/LineItem/1234567890"},"title":{"type":"string","description":"Product title.","example":"Classic T-Shirt"},"sku":{"type":"string","nullable":true,"description":"Stock Keeping Unit code.","example":"6310/202"},"variant_title":{"type":"string","nullable":true,"description":"Variant label (e.g. colour, size).","example":"Brown"},"image_url":{"type":"string","nullable":true,"description":"URL of the product image thumbnail.","example":"https://cdn.shopify.com/s/files/..."},"quantity":{"type":"integer","description":"Quantity ordered.","example":1},"max_refundable_quantity":{"type":"integer","description":"Maximum quantity eligible for refund.","example":1},"restockable":{"type":"boolean","description":"Whether this item can be returned to inventory on cancellation.","example":true},"original_unit_price":{"description":"Unit price at time of purchase.","type":"object","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"}}}}}}}},"examples":{"Shopify paid order":{"value":{"use_new_cancel_flow":true,"supports_refund_on_cancel":true,"cancel_reasons":[{"value":"CUSTOMER","label":"Customer changed or canceled order"},{"value":"DECLINED","label":"Payment declined"},{"value":"FRAUD","label":"Fraudulent order"},{"value":"INVENTORY","label":"Items unavailable"},{"value":"STAFF","label":"Staff error"},{"value":"OTHER","label":"Other"}],"refund_payments":[{"amount":{"value":805.2,"currency":"USD"},"formatted_gateway":"Manual"},{"amount":{"value":64.9,"currency":"USD"},"formatted_gateway":"(For Testing) Bogus Gateway"}],"refundable_items":[{"line_item_id":"gid://shopify/LineItem/1234567890","title":"Classic T-Shirt","sku":"6310/202","variant_title":"Brown","image_url":"https://cdn.shopify.com/s/files/example.jpg","quantity":1,"max_refundable_quantity":1,"restockable":true,"original_unit_price":{"value":390,"currency":"USD"}}]}},"Shopify unpaid order":{"value":{"use_new_cancel_flow":true,"supports_refund_on_cancel":false,"cancel_reasons":[{"value":"CUSTOMER","label":"Customer changed or canceled order"},{"value":"DECLINED","label":"Payment declined"},{"value":"FRAUD","label":"Fraudulent order"},{"value":"INVENTORY","label":"Items unavailable"},{"value":"STAFF","label":"Staff error"},{"value":"OTHER","label":"Other"}],"refund_payments":[],"refundable_items":[]}},"BigCommerce order":{"value":{"use_new_cancel_flow":false,"supports_refund_on_cancel":false,"cancel_reasons":[],"refund_payments":[],"refundable_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":"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"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"1974010","message":"Invalid JWT."}},"Account not configured to use ERC E-Commerce APIs":{"value":{"code":"1974011","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":"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."}}}},"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}/shipments":{"get":{"operationId":"erc-ecommerce-customers-customer-id-shipments-get","tags":["Retail Experience Cloud Bridge"],"summary":"Get Customer Shipments","description":"Read the customer shipments for the provided customer id.\n\nRequired fields:\n- customer_id\n\nA successful request returns the list of shipments for the provided customer.\n","security":[{"GA":["erc-ecommerce-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","required":["shipments"],"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":"string","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_updated":{"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":"string","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","required":["href"],"properties":{"href":{"type":"string","format":"uri","example":"http://api-docs.talkdesk.org/erc/ecommerce/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/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_updated":"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/customers/customer123/shipments?limit=2&order_by=last_update:desc"},"next":{"href":"http://api-docs.talkdesk.org/erc/ecommerce/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"}}}}}},"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"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"1974010","message":"Invalid JWT."}},"Account not configured to use ERC E-Commerce APIs":{"value":{"code":"1974011","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":"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."}}}},"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}/shipments/schedule":{"post":{"operationId":"erc-ecommerce-customers-customer-id-shipments-schedule-post","tags":["Retail Experience Cloud Bridge"],"summary":"Schedule Customer Shipments","description":"Schedule the customer shipment for the provided order id or delivery id.\n\nRequired fields:\n- customer_id\n- id (slot ID to schedule)\n\nA successful request schedules the shipment slot and returns the shipment details.\n","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 query. 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","minLength":1,"maxLength":255,"description":"The slot id which user wants to schedule","example":"slot123"},"order_id":{"type":"string","minLength":1,"maxLength":255,"description":"The order id","example":"order123"},"delivery_id":{"type":"string","minLength":1,"maxLength":255,"description":"The delivery id","example":"delivery123"}}},"example":{"id":"slot123","order_id":"order123","delivery_id":"delivery123"}}}},"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":{"examples":{"Generic Bad Request":{"value":{"code":"1974000","message":"Bad request."}},"Invalid Combined Param":{"value":{"code":"1974002","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":"1974010","message":"Invalid JWT."}},"Account not configured to use ERC E-Commerce APIs":{"value":{"code":"1974011","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":"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"}}}}}},"examples":{"Generic Bad Request":{"value":{"code":"1974000","message":"Bad request."}},"Invalid Combined Param":{"value":{"code":"1974002","message":"At least one of the parameters should be provided.","fields":[{"name":"customer_id"},{"name":"order_id"},{"name":"delivery_id"}]}}}}}},"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}/most-recent-order":{"get":{"operationId":"erc-ecommerce-customers-customer-id-most-recent-order-get","tags":["Retail Experience Cloud Bridge"],"summary":"Get Most Recent Order","description":"Read the customer most recent order for the provided customer id.\n\nRequired fields:\n- customer_id\n\nA successful request returns the customer's most recent order.\n","security":[{"GA":["erc-ecommerce-orders:read"]}],"parameters":[{"name":"customer_id","in":"path","required":true,"description":"The customer id.","schema":{"type":"string","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"}}],"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"},"brand":{"type":"string","description":"The brand the customer","example":"brand"},"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","properties":{"generic_type":{"description":"The generic type of the state/step","allOf":[{"type":"string","description":"Represents the generic type of a given order status info event","enum":["UNKNOWN","CONFIRMED","ON_ITS_WAY","OUT_FOR_DELIVERY","DELIVERED"],"example":"IN_TRANSIT"}]},"detailed_type":{"description":"The detailed type of the state/step","allOf":[{"type":"string","description":"Represents the detailed type of a given order status info event","enum":["UNKNOWN","ATTEMPTED_DELIVERY","READY_FOR_PICKUP","PICKED_UP","CONFIRMED","IN_TRANSIT","OUT_FOR_DELIVERY","DELIVERED","FAILURE"],"example":"IN_TRANSIT"}]},"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","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_address":{"description":"The address to which the order will be/was shipped","allOf":[{"type":"object","description":"Represents an address of a customer or order","properties":{"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 to the ISO 3166-1 alpha-2 codes","example":"PT"}}}]},"is_cancellable":{"type":"boolean","description":"Flag indicating if the order can be cancelled","example":true},"is_change_shipping_address_allowed":{"type":"boolean","description":"Flag indicating if the shipping address of the order can be changed","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"],"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 brand of the item","example":"Brand 123"},"price":{"description":"The price of the item","allOf":[{"type":"object","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","description":"The quantity of the item","example":10},"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","example":10},"refundable_quantity":{"type":"integer","description":"The quantity of the item that is refundable","example":3},"deliveries":{"type":"array","description":"List of deliveries where the item is inserted","items":{"allOf":[{"type":"object","description":"Represents an order item delivery resource","properties":{"id":{"type":"string","description":"The ID of the order delivery","example":"orderDelivery123"},"delivery_quantity":{"type":"integer","description":"The quantity of items associated with the delivery","example":10},"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","properties":{"type":{"description":"The type of the state/step","allOf":[{"type":"string","description":"Represents the detailed type of a given order status info event","enum":["UNKNOWN","ATTEMPTED_DELIVERY","READY_FOR_PICKUP","PICKED_UP","CONFIRMED","IN_TRANSIT","OUT_FOR_DELIVERY","DELIVERED","FAILURE"],"example":"IN_TRANSIT"}]},"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","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/"}}}]},"returnable_quantity":{"type":"integer","description":"The quantity of the item delivery that is returnable","example":1},"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 order item","additionalProperties":true}}}]},"is_refundable":{"type":"boolean","description":"Indicates whether the current order is refundable","example":true},"is_returnable":{"type":"boolean","description":"Indicates whether the current order is returnable","example":true},"payment_status":{"type":"string","description":"The payment status of the order","example":"PAID"},"delivery_status":{"type":"string","description":"The delivery status of the order","example":"DELIVERED"},"return_status":{"type":"string","description":"The return status of the order","example":"RETURN_IN_PROGRESS"},"cancellation_status":{"type":"string","description":"The cancellation status of the order","example":"CANCELLATION_REQUESTED"},"fulfillment_status":{"type":"string","description":"The fulfillment status of the order","example":"FULFILLED"},"_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/most-recent-order"}}}}}}},"examples":{"Valid Order":{"value":{"id":"order456","customer_id":"customer123","brand":"brand","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_address":{"first_name":"John","last_name":"Doe","phone_number":"+351910000000","address":"Lisbon","zip_code":"20000000","city":"Lisbon","region_code":"PT-11","country_code":"PT"},"is_cancellable":true,"is_change_shipping_address_allowed":true,"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"},"is_refundable":true,"is_returnable":true,"payment_status":"PAID","delivery_status":"DELIVERED","return_status":"NONE","cancellation_status":"NONE","fulfillment_status":"FULFILLED","_links":{"self":{"href":"http://api-docs.talkdesk.org/erc/ecommerce/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":"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."}}}}}}},"/erc/ecommerce/customers/shipments/available-slots":{"get":{"operationId":"erc-ecommerce-customers-shipments-available-slots-get","tags":["Retail Experience Cloud Bridge"],"summary":"Get Shipment Available Slots","description":"Read the customer shipment available slots for the provided customer id, order id or delivery id.\n\nA successful request returns the list of available shipment slots.\n","security":[{"GA":["erc-ecommerce-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"],"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","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/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/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/customers/shipments/available-slots?limit=2&order_by=date:asc"},"next":{"href":"http://api-docs.talkdesk.org/erc/ecommerce/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":"1974000","message":"Bad request."}},"Invalid Combined Param":{"value":{"code":"1974002","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":"1974010","message":"Invalid JWT."}},"Account not configured to use ERC E-Commerce APIs":{"value":{"code":"1974011","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":"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"}}}}}},"examples":{"Generic Bad Request":{"value":{"code":"1974000","message":"Bad request."}},"Invalid Combined Param":{"value":{"code":"1974002","message":"At least one of the parameters should be provided.","fields":[{"name":"customer_id"},{"name":"order_id"},{"name":"delivery_id"}]}}}}}},"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/cart/items":{"put":{"operationId":"erc-ecommerce-cart-items-put","tags":["Retail Experience Cloud Bridge"],"summary":"Sync cart items","description":"Synchronize (replace) the line items in a cart.\n\nThis endpoint creates a new cart or updates an existing one by replacing all current\nline items with the provided items.\n\nCart resolution logic:\n- If `cart_id` is provided in the body, the cart with that ID is updated directly.\n- If `customer_id` is provided (without `cart_id`), the system looks for an existing\n active cart for that customer. If found, it replaces the lines; otherwise, a new cart is created.\n- If neither `cart_id` nor `customer_id` is provided, a new cart is created.\n\nRequired fields:\n- interaction_id (the current interaction/conversation ID)\n- cart_lines (at least one item)\n\nA successful request returns the cart with the updated line items.\n","security":[{"GA":["erc-ecommerce-cart:write"]}],"requestBody":{"required":true,"description":"Sync Cart Items Request.","content":{"application/json":{"schema":{"type":"object","description":"The sync cart items request body. Replaces the cart lines with the provided items.","required":["interaction_id","cart_lines"],"properties":{"interaction_id":{"type":"string","minLength":1,"maxLength":255,"description":"The ID of the current interaction (conversation) associated with this cart operation.\n","example":"interaction-12345"},"brand":{"type":"string","minLength":1,"maxLength":255,"description":"The brand of the provider you want to use. If the account is multi-brand, this field is required.\n","example":"my-store"},"cart_id":{"type":"string","minLength":1,"description":"The ID of an existing cart to update. If provided, the cart lines will be replaced directly. If omitted, the system will attempt to find an existing active cart by customer_id or create a new one.\n","example":"Z2NwLXVzLWNlbnRyYWwxOjAxSk|123123fff"},"customer_id":{"type":"string","minLength":1,"description":"The ID of the customer. Used to find or associate an existing active cart when cart_id is not provided.\n","example":"cust-001"},"cart_lines":{"type":"array","description":"The line items to set in the cart. Must contain at least one item.","minItems":1,"items":{"type":"object","description":"A line item representing a product variant and its quantity.","required":["variant_id","quantity"],"properties":{"variant_id":{"type":"string","description":"The ID of the product variant to add to the cart.","minLength":1,"example":"44618913988897"},"quantity":{"type":"integer","description":"The quantity of this variant to add. Must be at least 1.","minimum":1,"maximum":100000,"example":2}}}}}},"examples":{"Sync Cart Items Request":{"value":{"interaction_id":"interaction-12345","customer_id":"cust-001","cart_lines":[{"variant_id":"44618913988897","quantity":2},{"variant_id":"4618913988898","quantity":1}]}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"required":["cart_id"],"type":"object","description":"Represents a 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"},"checkout":{"description":"The checkout access details for the cart, if available.","nullable":true,"type":"object","required":["url","expires_at"],"properties":{"url":{"type":"string","format":"uri","description":"The checkout URL for the cart.","example":"https://api.talkdesk.com/erc/ecommerce/cart/Z2NwLXVzLWNlbnRyYWwxOjAxSk%7C123123fff/checkout?token=a3f1c2d4e5b6&brand=my-store"},"expires_at":{"type":"string","format":"date-time","description":"When the checkout token expires (ISO 8601 with timezone offset).","example":"2026-06-27T10:00:00+00:00"}}},"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","type","discount_code"],"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","quantity","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","format":"uri","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","type","discount_code"],"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"},"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},"delivery_address":{"description":"The delivery address associated with the cart, if set.","nullable":true,"type":"object","properties":{"first_name":{"type":"string","description":"The first name of the recipient.","example":"Neo"},"last_name":{"type":"string","description":"The last name of the recipient.","example":"Shi"},"phone_number":{"type":"string","description":"The phone number of the recipient.","example":"+8613800138000"},"address":{"type":"string","description":"The street address.","example":"Rua Cidade de Nampula 3148"},"zip_code":{"type":"string","description":"The postal/zip code.","example":"1800-105"},"city":{"type":"string","description":"The city.","example":"Lisboa"},"region_code":{"type":"string","description":"The region or state code.","example":"PT-11","nullable":true},"country_code":{"type":"string","description":"The ISO 3166-1 alpha-2 country code.","example":"PT"}}},"selected_delivery_option":{"description":"The currently selected delivery option for the cart, if set.","nullable":true,"type":"object","required":["handle"],"properties":{"handle":{"type":"string","description":"The unique handle identifying this delivery option.","example":"postal-7a2d1d-1"},"title":{"type":"string","description":"The display title of the delivery option.","example":"Standard Shipping"},"estimated_cost":{"description":"The estimated cost of this delivery option.","nullable":true,"type":"object","required":["amount","currency_code"],"properties":{"amount":{"type":"string","description":"The cost amount as a decimal string.","example":"50.0"},"currency_code":{"type":"string","description":"The ISO 4217 currency code.","example":"EUR"}}}}},"cart_discount_applications":{"type":"array","description":"Cart-level discount applications reported by the commerce platform (Shopify only). May be an empty array when no discounts are applied; otherwise it contains the code, automatic, or custom discounts applied to the cart.","items":{"type":"object","description":"A cart-level discount application reported by the commerce platform. Code discounts carry a code; automatic and custom discounts carry a title.","required":["type","allocated_amount","currency_code"],"properties":{"type":{"type":"string","description":"The discount source type.","enum":["CODE","AUTOMATIC","CUSTOM","UNKNOWN"]},"code":{"type":"string","description":"The discount code. Present for CODE-type discounts."},"title":{"type":"string","description":"The discount title. Present for AUTOMATIC and CUSTOM discounts."},"allocated_amount":{"type":"string","description":"The total amount allocated by this discount across the cart."},"currency_code":{"type":"string","description":"The ISO 4217 currency code of the allocated amount."}}}},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","description":"The link to the cart"}}}}}}},"examples":{"Sync Cart Items Response":{"value":{"cart_id":"Z2NwLXVzLWNlbnRyYWwxOjAxSk|123123fff","checkout":{"url":"https://api.talkdesk.com/erc/ecommerce/cart/Z2NwLXVzLWNlbnRyYWwxOjAxSk%7C123123fff/checkout?token=a3f1c2d4e5b6&brand=my-store","expires_at":"2026-06-27T10:00:00+00:00"},"total_quantity":"3","currency":"USD","cost":{"base_amount":"109.97","discounts_amount":"0.00","final_amount":"109.97","taxes_amount":"0.00"},"cart_discounts":[],"cart_lines":[{"line_id":"line-001","variant_id":"44618913988897","variant_title":"Default Title","product_id":"prod-001","sku":"SKU-001","default_image":"https://cdn.shopify.com/s/files/image.png","quantity":"2","cost":{"base_amount":"29.99","discounts_amount":"0.00","final_amount":"59.98","taxes_amount":"0.00"},"cart_lines_discounts":[]},{"line_id":"line-002","variant_id":"44618913988898","variant_title":"Size L","product_id":"prod-002","sku":"SKU-002","default_image":"https://cdn.shopify.com/s/files/hoodie.png","quantity":"1","cost":{"base_amount":"49.99","discounts_amount":"0.00","final_amount":"49.99","taxes_amount":"0.00"},"cart_lines_discounts":[]}],"cart_discount_applications":[]}}}}}},"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"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"1974010","message":"Invalid JWT."}},"Account not configured to use ERC E-Commerce APIs":{"value":{"code":"1974011","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":"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 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":"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/cart/{cart_id}/delivery-address":{"put":{"operationId":"erc-ecommerce-cart-cart-id-delivery-address-put","tags":["Retail Experience Cloud Bridge"],"summary":"Set cart delivery address","description":"Sets or updates the delivery address on a cart and returns available delivery options.","security":[{"GA":["erc-ecommerce-cart:write"]}],"parameters":[{"name":"cart_id","in":"path","required":true,"description":"The cart ID","schema":{"type":"string","example":"Z2NwLXVzLWNlbnRyYWwxOjAxSk5QN1I4WEdFNjE3SjVWOUhHQjNSSzk3"}},{"name":"brand","in":"query","required":false,"description":"The brand of the provider you want to use. If the account is multi-brand, this parameter is required.\n","schema":{"type":"string","maxLength":255,"minLength":1,"example":"Brand 123"}}],"requestBody":{"required":true,"description":"Delivery address to apply to the cart","content":{"application/json":{"schema":{"type":"object","properties":{"address_id":{"type":"string","description":"The ID of an existing address in the customer's address book"},"first_name":{"type":"string","description":"First name for the delivery address"},"last_name":{"type":"string","description":"Last name for the delivery address"},"address":{"type":"string","description":"Street address"},"city":{"type":"string","description":"City"},"country_code":{"type":"string","description":"ISO 3166-1 alpha-2 country code"},"zip_code":{"type":"string","description":"Postal/zip code"},"phone_number":{"type":"string","description":"Phone number"}}},"examples":{"Set Delivery Address Request":{"value":{"first_name":"John","last_name":"Doe","address":"123 Main St","city":"San Francisco","country_code":"US","zip_code":"94105","phone_number":"+14155550100"}}}}}},"responses":{"200":{"description":"Delivery address applied with available delivery options returned","content":{"application/json":{"schema":{"type":"object","required":["available_delivery_options"],"properties":{"delivery_group_id":{"type":"string","description":"The ID of the delivery group","nullable":true},"delivery_address":{"description":"The applied delivery address.","nullable":true,"type":"object","properties":{"first_name":{"type":"string","description":"The first name of the recipient.","example":"Neo"},"last_name":{"type":"string","description":"The last name of the recipient.","example":"Shi"},"phone_number":{"type":"string","description":"The phone number of the recipient.","example":"+8613800138000"},"address":{"type":"string","description":"The street address.","example":"Rua Cidade de Nampula 3148"},"zip_code":{"type":"string","description":"The postal/zip code.","example":"1800-105"},"city":{"type":"string","description":"The city.","example":"Lisboa"},"region_code":{"type":"string","description":"The region or state code.","example":"PT-11","nullable":true},"country_code":{"type":"string","description":"The ISO 3166-1 alpha-2 country code.","example":"PT"}}},"available_delivery_options":{"type":"array","description":"List of delivery options available for the applied address.","items":{"type":"object","description":"The currently selected delivery option for the cart.","required":["handle"],"properties":{"handle":{"type":"string","description":"The unique handle identifying this delivery option.","example":"postal-7a2d1d-1"},"title":{"type":"string","description":"The display title of the delivery option.","example":"Standard Shipping"},"estimated_cost":{"description":"The estimated cost of this delivery option.","nullable":true,"type":"object","required":["amount","currency_code"],"properties":{"amount":{"type":"string","description":"The cost amount as a decimal string.","example":"50.0"},"currency_code":{"type":"string","description":"The ISO 4217 currency code.","example":"EUR"}}}}}}}},"examples":{"Set Delivery Address Response":{"value":{"delivery_group_id":"group-001","delivery_address":{"first_name":"John","last_name":"Doe","address":"123 Main St","city":"San Francisco","country_code":"US","zip_code":"94105","phone_number":"+14155550100"},"available_delivery_options":[{"handle":"standard-shipping","title":"Standard Shipping (5-7 days)","estimated_cost":{"amount":"5.99","currency_code":"USD"}},{"handle":"express-shipping","title":"Express Shipping (1-2 days)","estimated_cost":{"amount":"15.99","currency_code":"USD"}}]}}}}}},"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":"1974000","message":"Bad request."}},"Invalid Address":{"value":{"code":"1974001","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":"1974010","message":"Invalid JWT."}},"Account not configured to use ERC E-Commerce APIs":{"value":{"code":"1974011","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":"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 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":"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/cart/{cart_id}/delivery-option":{"put":{"operationId":"erc-ecommerce-cart-cart-id-delivery-option-put","tags":["Retail Experience Cloud Bridge"],"summary":"Select cart delivery option","description":"Selects a delivery option for the cart.","security":[{"GA":["erc-ecommerce-cart:write"]}],"parameters":[{"name":"cart_id","in":"path","required":true,"description":"The cart ID","schema":{"type":"string","example":"Z2NwLXVzLWNlbnRyYWwxOjAxSk5QN1I4WEdFNjE3SjVWOUhHQjNSSzk3"}},{"name":"brand","in":"query","required":false,"description":"The brand of the provider you want to use. If the account is multi-brand, this parameter is required.\n","schema":{"type":"string","maxLength":255,"minLength":1,"example":"Brand 123"}}],"requestBody":{"required":true,"description":"Delivery option to select for the cart","content":{"application/json":{"schema":{"type":"object","required":["delivery_group_id","delivery_option_handle"],"properties":{"delivery_group_id":{"type":"string","description":"The ID of the delivery group"},"delivery_option_handle":{"type":"string","description":"The handle of the delivery option to select"}}},"examples":{"Select Delivery Option Request":{"value":{"delivery_group_id":"group-001","delivery_option_handle":"standard-shipping"}}}}}},"responses":{"200":{"description":"The selected delivery option for the cart","content":{"application/json":{"schema":{"type":"object","properties":{"selected_delivery_option":{"description":"The selected delivery option, if any.","nullable":true,"type":"object","required":["handle"],"properties":{"handle":{"type":"string","description":"The unique handle identifying this delivery option.","example":"postal-7a2d1d-1"},"title":{"type":"string","description":"The display title of the delivery option.","example":"Standard Shipping"},"estimated_cost":{"description":"The estimated cost of this delivery option.","nullable":true,"type":"object","required":["amount","currency_code"],"properties":{"amount":{"type":"string","description":"The cost amount as a decimal string.","example":"50.0"},"currency_code":{"type":"string","description":"The ISO 4217 currency code.","example":"EUR"}}}}}}},"examples":{"Select Delivery Option Response":{"value":{"selected_delivery_option":{"handle":"standard-shipping","title":"Standard Shipping (5-7 days)","estimated_cost":{"amount":"5.99","currency_code":"USD"}}}}}}}},"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":"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"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"1974010","message":"Invalid JWT."}},"Account not configured to use ERC E-Commerce APIs":{"value":{"code":"1974011","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":"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 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":"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/cart/{cart_id}/bind":{"post":{"operationId":"erc-ecommerce-cart-cart-id-bind-post","tags":["Retail Experience Cloud Bridge"],"summary":"Bind customer to cart","description":"Binds a customer to a cart and returns the updated cart.","security":[{"GA":["erc-ecommerce-cart:write"]}],"parameters":[{"name":"cart_id","in":"path","required":true,"description":"The cart ID","schema":{"type":"string","example":"Z2NwLXVzLWNlbnRyYWwxOjAxSk5QN1I4WEdFNjE3SjVWOUhHQjNSSzk3"}},{"name":"brand","in":"query","required":false,"description":"The brand of the provider you want to use. If the account is multi-brand, this parameter is required.\n","schema":{"type":"string","maxLength":255,"minLength":1,"example":"Brand 123"}}],"requestBody":{"required":true,"description":"Customer binding request","content":{"application/json":{"schema":{"type":"object","required":["interaction_id"],"properties":{"interaction_id":{"type":"string","description":"The Talkdesk interaction ID to associate with this cart"},"customer_id":{"type":"string","description":"The customer ID to bind to the cart. If not provided, the cart is not associated with any customer."}}},"examples":{"Bind Customer Request":{"value":{"interaction_id":"interaction-abc123","customer_id":"customer-456"}}}}}},"responses":{"200":{"description":"The updated cart with the customer bound","content":{"application/json":{"schema":{"required":["cart_id"],"type":"object","description":"Represents a 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"},"checkout":{"description":"The checkout access details for the cart, if available.","nullable":true,"type":"object","required":["url","expires_at"],"properties":{"url":{"type":"string","format":"uri","description":"The checkout URL for the cart.","example":"https://api.talkdesk.com/erc/ecommerce/cart/Z2NwLXVzLWNlbnRyYWwxOjAxSk%7C123123fff/checkout?token=a3f1c2d4e5b6&brand=my-store"},"expires_at":{"type":"string","format":"date-time","description":"When the checkout token expires (ISO 8601 with timezone offset).","example":"2026-06-27T10:00:00+00:00"}}},"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","type","discount_code"],"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","quantity","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","format":"uri","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","type","discount_code"],"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"},"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},"delivery_address":{"description":"The delivery address associated with the cart, if set.","nullable":true,"type":"object","properties":{"first_name":{"type":"string","description":"The first name of the recipient.","example":"Neo"},"last_name":{"type":"string","description":"The last name of the recipient.","example":"Shi"},"phone_number":{"type":"string","description":"The phone number of the recipient.","example":"+8613800138000"},"address":{"type":"string","description":"The street address.","example":"Rua Cidade de Nampula 3148"},"zip_code":{"type":"string","description":"The postal/zip code.","example":"1800-105"},"city":{"type":"string","description":"The city.","example":"Lisboa"},"region_code":{"type":"string","description":"The region or state code.","example":"PT-11","nullable":true},"country_code":{"type":"string","description":"The ISO 3166-1 alpha-2 country code.","example":"PT"}}},"selected_delivery_option":{"description":"The currently selected delivery option for the cart, if set.","nullable":true,"type":"object","required":["handle"],"properties":{"handle":{"type":"string","description":"The unique handle identifying this delivery option.","example":"postal-7a2d1d-1"},"title":{"type":"string","description":"The display title of the delivery option.","example":"Standard Shipping"},"estimated_cost":{"description":"The estimated cost of this delivery option.","nullable":true,"type":"object","required":["amount","currency_code"],"properties":{"amount":{"type":"string","description":"The cost amount as a decimal string.","example":"50.0"},"currency_code":{"type":"string","description":"The ISO 4217 currency code.","example":"EUR"}}}}},"cart_discount_applications":{"type":"array","description":"Cart-level discount applications reported by the commerce platform (Shopify only). May be an empty array when no discounts are applied; otherwise it contains the code, automatic, or custom discounts applied to the cart.","items":{"type":"object","description":"A cart-level discount application reported by the commerce platform. Code discounts carry a code; automatic and custom discounts carry a title.","required":["type","allocated_amount","currency_code"],"properties":{"type":{"type":"string","description":"The discount source type.","enum":["CODE","AUTOMATIC","CUSTOM","UNKNOWN"]},"code":{"type":"string","description":"The discount code. Present for CODE-type discounts."},"title":{"type":"string","description":"The discount title. Present for AUTOMATIC and CUSTOM discounts."},"allocated_amount":{"type":"string","description":"The total amount allocated by this discount across the cart."},"currency_code":{"type":"string","description":"The ISO 4217 currency code of the allocated amount."}}}},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","description":"The link to the cart"}}}}}}},"examples":{"Bind Customer Response":{"value":{"cart_id":"7c357571-84bc-4238-8d21-06f794a0c68c","customer_id":"customer-456","total_quantity":"2","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":"89.99","discounts_amount":"0","final_amount":"89.99"},"cart_lines":[{"line_id":"1363c133-c9d2-4cf0-bdb3-2f67c240f9ce","variant_id":"72","variant_title":"Utility Caddy","product_id":"104","sku":"OFSUC","quantity":"2","cost":{"base_amount":"44.99","discounts_amount":"0","final_amount":"44.99"}}],"cart_discount_applications":[],"brand":"my-store"}}}}}},"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":"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"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"1974010","message":"Invalid JWT."}},"Account not configured to use ERC E-Commerce APIs":{"value":{"code":"1974011","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":"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 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":"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/cart":{"get":{"operationId":"erc-ecommerce-customers-cart-get","tags":["Retail Experience Cloud Bridge"],"summary":"Get Customer Cart","description":"Read the cart of the customer by customer_id, cart_id, or interaction_id.\n\nRequired fields:\n- At least one of customer_id, cart_id, or interaction_id must be provided.\n\nA successful request returns the cart data including delivery address and\nselected delivery option when available.\n","security":[{"GA":["erc-ecommerce-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":"interaction_id","in":"query","description":"The ID of the interaction (conversation) associated with this cart.","required":false,"schema":{"type":"string"},"example":"interaction-12345"},{"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"}}],"responses":{"200":{"description":"The cart data found for the provided customer_id, cart_id, or interaction_id.","content":{"application/json":{"schema":{"allOf":[{"required":["cart_id"],"type":"object","description":"Represents a 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"},"checkout":{"description":"The checkout access details for the cart, if available.","nullable":true,"type":"object","required":["url","expires_at"],"properties":{"url":{"type":"string","format":"uri","description":"The checkout URL for the cart.","example":"https://api.talkdesk.com/erc/ecommerce/cart/Z2NwLXVzLWNlbnRyYWwxOjAxSk%7C123123fff/checkout?token=a3f1c2d4e5b6&brand=my-store"},"expires_at":{"type":"string","format":"date-time","description":"When the checkout token expires (ISO 8601 with timezone offset).","example":"2026-06-27T10:00:00+00:00"}}},"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","type","discount_code"],"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","quantity","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","format":"uri","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","type","discount_code"],"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"},"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},"delivery_address":{"description":"The delivery address associated with the cart, if set.","nullable":true,"type":"object","properties":{"first_name":{"type":"string","description":"The first name of the recipient.","example":"Neo"},"last_name":{"type":"string","description":"The last name of the recipient.","example":"Shi"},"phone_number":{"type":"string","description":"The phone number of the recipient.","example":"+8613800138000"},"address":{"type":"string","description":"The street address.","example":"Rua Cidade de Nampula 3148"},"zip_code":{"type":"string","description":"The postal/zip code.","example":"1800-105"},"city":{"type":"string","description":"The city.","example":"Lisboa"},"region_code":{"type":"string","description":"The region or state code.","example":"PT-11","nullable":true},"country_code":{"type":"string","description":"The ISO 3166-1 alpha-2 country code.","example":"PT"}}},"selected_delivery_option":{"description":"The currently selected delivery option for the cart, if set.","nullable":true,"type":"object","required":["handle"],"properties":{"handle":{"type":"string","description":"The unique handle identifying this delivery option.","example":"postal-7a2d1d-1"},"title":{"type":"string","description":"The display title of the delivery option.","example":"Standard Shipping"},"estimated_cost":{"description":"The estimated cost of this delivery option.","nullable":true,"type":"object","required":["amount","currency_code"],"properties":{"amount":{"type":"string","description":"The cost amount as a decimal string.","example":"50.0"},"currency_code":{"type":"string","description":"The ISO 4217 currency code.","example":"EUR"}}}}},"cart_discount_applications":{"type":"array","description":"Cart-level discount applications reported by the commerce platform (Shopify only). May be an empty array when no discounts are applied; otherwise it contains the code, automatic, or custom discounts applied to the cart.","items":{"type":"object","description":"A cart-level discount application reported by the commerce platform. Code discounts carry a code; automatic and custom discounts carry a title.","required":["type","allocated_amount","currency_code"],"properties":{"type":{"type":"string","description":"The discount source type.","enum":["CODE","AUTOMATIC","CUSTOM","UNKNOWN"]},"code":{"type":"string","description":"The discount code. Present for CODE-type discounts."},"title":{"type":"string","description":"The discount title. Present for AUTOMATIC and CUSTOM discounts."},"allocated_amount":{"type":"string","description":"The total amount allocated by this discount across the cart."},"currency_code":{"type":"string","description":"The ISO 4217 currency code of the allocated amount."}}}},"_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","checkout":{"url":"https://api.talkdesk.com/erc/ecommerce/cart/7c357571-84bc-4238-8d21-06f794a0c68c/checkout?token=a3f1c2d4e5b6&brand=Brand+A","expires_at":"2026-06-27T10:00:00+00:00"},"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"},"cart_lines_discounts":[{"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 A","delivery_address":{"first_name":"Neo","last_name":"Shi","phone_number":"+8613800138000","address":"Rua Cidade de Nampula 3148","zip_code":"1800-105","city":"Lisboa","country_code":"PT"},"selected_delivery_option":{"handle":"postal-7a2d1d-1","title":"Standard Shipping","estimated_cost":{"amount":"50.0","currency_code":"USD"}},"cart_discount_applications":[{"type":"CODE","code":"SAVE5","allocated_amount":"5.00","currency_code":"USD"},{"type":"AUTOMATIC","title":"Spend $40 save","allocated_amount":"2.50","currency_code":"USD"}],"_links":{"self":{"href":"http://api-docs.talkdesk.org/erc/ecommerce/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":"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"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"1974010","message":"Invalid JWT."}},"Account not configured to use ERC E-Commerce APIs":{"value":{"code":"1974011","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":"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."}}}},"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/cart/{cart_id}/checkout/token":{"post":{"operationId":"erc-ecommerce-cart-cart-id-checkout-token-post","x-internal":true,"tags":["Retail Experience Cloud Bridge"],"summary":"Generate cart checkout token","description":"Generates (or refreshes) a short-lived access token for the cart checkout URL.\n\nThe token is used to construct a secure, time-limited URL that allows a customer\nto be redirected to the provider's checkout page without requiring a Talkdesk JWT.\n\nCalling this endpoint again for the same cart overwrites the previous token.\n\nThe response includes the full checkout URL (`checkout_url`) that can be shared\ndirectly with the customer.\n","security":[{"GA":["erc-ecommerce-cart:write"]}],"parameters":[{"name":"cart_id","in":"path","required":true,"description":"The ID of the cart for which to generate a checkout token.","schema":{"type":"string","minLength":1,"maxLength":255,"example":"Z2NwLXVzLWNlbnRyYWwxOjAxSk5QN1I4WEdFNjE3SjVWOUhHQjNSSzk3"}},{"name":"brand","in":"query","required":false,"description":"The brand of the provider you want to use. If the account is multi-brand, this parameter is required.\n","schema":{"type":"string","maxLength":255,"minLength":1,"example":"my-store"}}],"responses":{"200":{"description":"Checkout token generated successfully.","content":{"application/json":{"schema":{"type":"object","description":"The response body for a successful checkout token generation.","required":["cart_id","token","expires_at","checkout_url"],"properties":{"cart_id":{"type":"string","description":"The ID of the cart.","example":"Z2NwLXVzLWNlbnRyYWwxOjAxSk|123123fff"},"token":{"type":"string","description":"The opaque access token (64-character hex string).","example":"a3f1c2d4e5b6a3f1c2d4e5b6a3f1c2d4e5b6a3f1c2d4e5b6a3f1c2d4e5b6a3f1"},"expires_at":{"type":"string","format":"date-time","description":"When this token expires (ISO 8601 with timezone offset).","example":"2026-06-27T10:00:00+00:00"},"checkout_url":{"type":"string","format":"uri","description":"The full checkout redirect URL, including the token as a query parameter.","example":"https://api.talkdesk.com/erc/ecommerce/cart/Z2NwLXVzLWNlbnRyYWwxOjAxSk%7C123123fff/checkout?token=a3f1c2d4e5b6&brand=my-store"}}},"examples":{"Generate Checkout Token Response":{"value":{"cart_id":"Z2NwLXVzLWNlbnRyYWwxOjAxSk|123123fff","token":"a3f1c2d4e5b6a3f1c2d4e5b6a3f1c2d4e5b6a3f1c2d4e5b6a3f1c2d4e5b6a3f1","expires_at":"2026-06-27T10:00:00+00:00","checkout_url":"https://api.talkdesk.com/erc/ecommerce/cart/Z2NwLXVzLWNlbnRyYWwxOjAxSk%7C123123fff/checkout?token=a3f1c2d4e5b6a3f1c2d4e5b6a3f1c2d4e5b6a3f1c2d4e5b6a3f1c2d4e5b6a3f1&brand=my-store"}}}}}},"400":{"description":"Bad Request — e.g. the cart is not in ACTIVE status.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"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":"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"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"1974010","message":"Invalid JWT."}},"Account not configured to use ERC E-Commerce APIs":{"value":{"code":"1974011","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":"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 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":"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/cart/{cart_id}/checkout":{"get":{"operationId":"erc-ecommerce-cart-cart-id-checkout-get","x-internal":true,"tags":["Retail Experience Cloud Bridge"],"summary":"Redirect to cart checkout","description":"Validates the checkout access token for the given cart and redirects (HTTP 302)\nto the provider's checkout URL.\n\nThis is a **public endpoint** — no Talkdesk JWT is required. It is intended to be\nused as the link shared with the customer to proceed to checkout.\n","parameters":[{"name":"cart_id","in":"path","required":true,"description":"The ID of the cart to redirect to checkout.","schema":{"type":"string","minLength":1,"maxLength":255,"example":"Z2NwLXVzLWNlbnRyYWwxOjAxSk5QN1I4WEdFNjE3SjVWOUhHQjNSSzk3"}},{"name":"token","in":"query","required":false,"description":"The checkout access token previously generated via the token endpoint. If missing or invalid, the request is rejected with HTTP 401.\n","schema":{"type":"string","example":"a3f1c2d4e5b6a3f1c2d4e5b6a3f1c2d4e5b6a3f1c2d4e5b6a3f1c2d4e5b6a3f1"}},{"name":"brand","in":"query","required":false,"description":"The brand of the provider you want to use. If the account is multi-brand, this parameter is required.\n","schema":{"type":"string","maxLength":255,"minLength":1,"example":"my-store"}}],"responses":{"302":{"description":"Redirect to the provider's checkout URL.\nThe `Location` header contains the provider checkout URL (e.g. Shopify checkout URL).\n","headers":{"Location":{"description":"The provider checkout URL to which the client is redirected.","schema":{"type":"string","format":"uri","example":"https://my-store.myshopify.com/cart/c/Z2NwLXVzLWNlbnRyYWwxOjAxSk"}}}},"400":{"description":"Bad Request — e.g. brand is required for multi-brand accounts but was not provided.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"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":"1974000","message":"Bad request."}}}}}},"401":{"description":"Unauthorized — the token is missing, invalid, or expired; or the cart is not ACTIVE.\n","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"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 or Expired Token":{"value":{"code":"1974010","message":"Invalid JWT."}}}}}},"404":{"description":"Not Found — the cart does not exist.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"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."}}}},"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/orders":{"get":{"operationId":"erc-ecommerce-orders-get","tags":["Retail Experience Cloud Bridge"],"summary":"Get Orders","description":"Read the orders provided by the account id.\n\nA successful request returns the list of orders for the account.\n","security":[{"GA":["erc-ecommerce-orders:read"]}],"parameters":[{"name":"limit","in":"query","description":"The amount of orders we want to get","required":false,"schema":{"type":"integer","example":5,"minimum":1,"maximum":50,"default":10}},{"name":"cursor","in":"query","description":"The opaque string that represents the cursor after which the 'limit' amount of orders are retrieved","schema":{"type":"string","default":""},"example":"eyJsYXN0X2lkIjo0MDU5NTY2MzQyMTY2LCJsYXN0X3ZhbHVlIjoiMjAyMS0wNi0yMyAyMjowNTowOC41MjU5OTEifQ==","allowEmptyValue":true},{"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":50,"minLength":1,"example":"Brand A"}},{"name":"order_by","in":"query","required":false,"description":"The parameter to sort by. Use order_by=key1:desc for descending, or order_by=key1:asc for ascending.","schema":{"type":"string","default":"purchase_datetime:desc","x-sorting_default_order":"desc","x-sorting_fields":["purchase_datetime","id","order_number","items_number"]},"example":"purchase_datetime:desc","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"]}}],"responses":{"200":{"description":"The list of orders found with the provided account 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":{"allOf":[{"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"},"brand":{"type":"string","description":"The brand associated with the order","example":"brand"},"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_address":{"description":"The address to which the order will be/was shipped","allOf":[{"type":"object","description":"Represents an address of a customer or order","properties":{"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 to the ISO 3166-1 alpha-2 codes","example":"PT"}}}]},"billing_address":{"description":"The billing address associated with the order","allOf":[{"type":"object","description":"Represents an address of a customer or order","properties":{"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 to the ISO 3166-1 alpha-2 codes","example":"PT"}}}]},"items_number":{"type":"integer","description":"The number of order items","example":3},"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","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","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","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","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","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","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","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","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"}}}]}}}]},"payment_details":{"description":"The payment details of the order","allOf":[{"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"}}}]},"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"},"cancellation_status":{"type":"string","description":"The cancellation status of the order","example":"CANCELLATION_REQUESTED"},"fulfillment_status":{"type":"string","description":"The fulfillment status of the order","example":"FULFILLED"},"payment_status":{"type":"string","description":"The payment status of the order","example":"PAID"},"delivery_status":{"type":"string","description":"The delivery status of the order","example":"DELIVERED"},"return_status":{"type":"string","description":"The return status of the order","example":"RETURN_IN_PROGRESS"},"custom_fields":{"type":"object","description":"The custom fields associated with the provider","additionalProperties":true},"is_refundable":{"type":"boolean","description":"Indicates whether the current order is refundable","example":true},"is_returnable":{"type":"boolean","description":"Indicates whether the current order is returnable","example":true},"is_cancellable":{"type":"boolean","description":"Indicates whether the current order can be cancelled","example":true},"is_change_shipping_address_allowed":{"type":"boolean","description":"Indicates whether the shipping address of the order can be changed","example":false}}},{"type":"object","properties":{"is_cancellable":{"type":"boolean","description":"Flag indicating if the order can be cancelled","example":true},"is_change_shipping_address_allowed":{"type":"boolean","description":"Flag indicating if the shipping address of the order can be changed","example":true}}}]}}}},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"uri","example":"http://api-docs.talkdesk.org/erc/ecommerce/orders?limit=2"}}},"next":{"type":"object","properties":{"href":{"type":"string","format":"uri","example":"http://api-docs.talkdesk.org/erc/ecommerce/orders?limit=2&cursor=eyJsYXN0X2lkIjoxMjQ4MzU4NTYzODYyLCJsYXN0X3ZhbHVlIjoiMjAxOS0wNi0xNyAwMjoyMzo0Mi4wMDAwMDAifQ=="}}}}}}},"examples":{"Valid Order List":{"value":{"_embedded":{"orders":[{"id":"order456","order_number":"#Y34DHR","customer_id":"customer123","brand":"brand","purchase_datetime":"2021-09-14T12:16:50.078Z","delivery_type":"SHIPPING","shipping_address":{"first_name":"John","last_name":"Doe","phone_number":"+351910000000","address":"Lisbon","zip_code":"20000000","city":"Lisbon","region_code":"PT-11","country_code":"PT"},"billing_address":{"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"}},"payment_details":{"card_brand":"Visa","card_brand_image_url":"https://external-integration.url.com/payment_card_brand_icon.svg","card_number":"**** **** **** *567"},"order_extra_info":{"highlighted_item_image_url":"https://external-integration.url.com/payment_card_brand_icon.jpg"},"status":"CONFIRMED","is_cancellable":true,"is_change_shipping_address_allowed":true},{"id":"order789","order_number":"#Y35DHR","brand":"brand","customer_id":"customer123","purchase_datetime":"2021-09-14T12:16:50.078Z","delivery_type":"SHIPPING","shipping_address":{"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","is_cancellable":false,"is_change_shipping_address_allowed":false}]},"_links":{"self":{"href":"http://api-docs.talkdesk.org/erc/ecommerce/orders?limit=2"},"next":{"href":"http://api-docs.talkdesk.org/erc/ecommerce/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":"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"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"1974010","message":"Invalid JWT."}},"Account not configured to use ERC E-Commerce APIs":{"value":{"code":"1974011","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":"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."}}}},"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/products":{"get":{"operationId":"erc-ecommerce-products-get","tags":["Retail Experience Cloud Bridge"],"summary":"Get Products","description":"Get/search the products of the store we are integrated with.\n\nA successful request returns the list of found products.\n","security":[{"GA":["erc-ecommerce-products:read"]}],"parameters":[{"name":"limit","in":"query","description":"The amount of products we want to get","required":false,"schema":{"type":"integer","example":5,"minimum":1,"maximum":50,"default":10}},{"name":"cursor","in":"query","description":"The opaque string that represents the cursor after which the 'limit' amount of products are retrieved","schema":{"type":"string","default":""},"example":"eyJsYXN0X2lkIjo0MDU5NTY2MzQyMTY2LCJsYXN0X3ZhbHVlIjoiMjAyMS0wNi0yMyAyMjowNTowOC41MjU5OTEifQ==","allowEmptyValue":true},{"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":50,"minLength":1,"example":"Brand A"}},{"name":"search","in":"query","description":"The search string by which we should search products.","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 associated with the product","example":"brand"},"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","minLength":1},"image_url":{"type":"string","description":"The URL of the product image","format":"uri","example":"https://external-integration.url.com/product_image.png","minLength":1}}}},"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","minLength":1},"values":{"type":"array","description":"The list of possible values for the product option","example":["White","Black","Red","Purple"],"items":{"type":"string","minLength":1}}}}},"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","minLength":1},"sku":{"type":"string","description":"The SKU of the product variant","example":"productVariant123Sku","minLength":0},"price":{"type":"object","description":"The price of the product variant","allOf":[{"type":"object","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","minLength":1}},"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","minLength":1},"example":{"Color":"White","Size":"XS"}},"available_quantity":{"type":"integer","format":"int64","description":"The product's variant quantity available in stock","default":0,"example":1000}}}}}}}}},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"uri","example":"http://api-docs.talkdesk.org/erc/ecommerce/products?limit=2"}}},"next":{"type":"object","properties":{"href":{"type":"string","format":"uri","example":"http://api-docs.talkdesk.org/erc/ecommerce/products?limit=2&cursor=eyJsYXN0X2lkIjoxMjQ4MzU4NTYzODYyLCJsYXN0X3ZhbHVlIjoiMjAxOS0wNi0xNyAwMjoyMzo0Mi4wMDAwMDAifQ=="}}}}}}},"examples":{"Valid Order List":{"value":{"_embedded":{"products":[{"id":"product123","title":"Linen dress","brand":"brand","description":"This is the description of an example linen dress","default_variant_id":"product123Variant1","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}]},{"id":"product456","description":"This is the description of an example floral print dress","brand":"brand","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}]}]},"_links":{"self":{"href":"http://api-docs.talkdesk.org/erc/ecommerce/products?limit=2"},"next":{"href":"http://api-docs.talkdesk.org/erc/ecommerce/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":"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"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"1974010","message":"Invalid JWT."}},"Account not configured to use ERC E-Commerce APIs":{"value":{"code":"1974011","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":"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."}}}},"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/brand":{"get":{"operationId":"erc-ecommerce-brand-get","x-internal":true,"tags":["Retail Experience Cloud Bridge"],"summary":"Get All Brands","description":"Get all the brand information for the current Talkdesk account.\n\nA successful request returns all brand information for the current account.\n","security":[{"GA":["erc-ecommerce-customers:read"]}],"responses":{"200":{"description":"All the brand information for the Talkdesk account.","content":{"application/json":{"schema":{"allOf":[{"type":"object","description":"Represents integration settings for industries, supporting single or multiple integrations","required":["_links"],"properties":{"multiple_integrations":{"type":"array","description":"A list of integration settings","items":{"type":"object","description":"Integration setting for a specific e-commerce platform","properties":{"brand_name":{"type":"string","description":"The brand name associated with this integration","example":"td-qa-nike"},"brand_domain_id":{"type":"string","description":"The domain ID for the brand","example":"gid://shopify/Shop/97383612748"},"integration_id":{"type":"string","description":"Integration ID (e.g., shopify)","example":"shopify"}}}},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string","format":"uri","example":"https://api-docs.talkdesk.org/erc/ecommerce/brand"}}}}}}}]},"examples":{"Valid Integration Credentials":{"value":{"multiple_integrations":[{"brand_name":"Acme Inc.","brand_domain_id":"acme.com","integration_id":"shopify"},{"brand_name":"Beta Corp","brand_domain_id":"beta.com","integration_id":"bigcommerce"}],"_links":{"self":{"href":"https://api-docs.talkdesk.org/erc/ecommerce/brand"}}}}}}}},"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":"1974011","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":"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."}}}}}}},"/erc/ecommerce/customers/technician-visits/available-slots":{"get":{"operationId":"erc-ecommerce-customers-technician-visits-available-slots-get","tags":["Retail Experience Cloud Bridge"],"summary":"Get Customer Technician Visit Slots","description":"Read the customer technician visits available slots for the provided customer id or visit id.\n\nA successful request returns the list of available technician visit slots.\n","security":[{"GA":["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,"default":"date:asc","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"],"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","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":{"operationId":"erc-ecommerce-customers-customer-id-technician-visits-schedule-post","tags":["Retail Experience Cloud Bridge"],"summary":"Schedule Customer Technician Visits","description":"Schedule the customer technician visits for the provided visit id.\n\nRequired fields:\n- customer_id\n- id (slot ID to schedule)\n\nA successful request schedules the technician visit for the specified visit ID.\n","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":"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":"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":{"operationId":"erc-ecommerce-customers-customer-id-technician-visits-get","tags":["Retail Experience Cloud Bridge"],"summary":"Get Customer Technician Visits","description":"Read the customer technician visits for the provided customer id.\n\nRequired fields:\n- customer_id\n\nA successful request returns the list of technician visits for the provided customer.\n","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,"default":"","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","required":["visits"],"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"},"brand":{"type":"string","description":"The brand of the provider","example":"Brand A"},"address":{"type":"object","description":"The address for this customer","properties":{"id":{"type":"string","description":"The address identifier","example":"address1234"},"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","required":["id"],"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":{"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/external/customers":{"get":{"operationId":"erc-ecommerce-external-customers-get","tags":["Retail Experience Cloud Bridge"],"summary":"Get External Customers","description":"Read the external customers.\n\nA successful request returns the list of external customers.\n","security":[{"GA":["erc-ecommerce-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":1}},{"name":"per_page","in":"query","required":false,"description":"Limit the number of customers per page. Defaults to 10.","schema":{"type":"integer","default":10,"minimum":1,"maximum":100,"example":10}},{"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":50,"minLength":1,"example":"Brand 123"}},{"name":"matchMode","in":"query","required":false,"description":"The match mode for customer search. Defaults to \"exact\". Valid values: \"exact\", \"fuzzy\".\n","schema":{"type":"string","enum":["exact","fuzzy"],"default":"exact","example":"exact"}},{"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","_links"],"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":["customer_id","name","updated_at","created_at"],"properties":{"customer_id":{"type":"string","description":"The ID of the customer","example":"5863685193889"},"name":{"type":"string","description":"The name of the customer","example":"john"},"brand":{"type":"string","nullable":true,"description":"The brand associated with the customer, if applicable","example":"my-shop"},"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","required":["href"],"properties":{"href":{"type":"string","format":"uri","example":"https://api-docs.talkdesk.org/erc/ecommerce/external/customers"}}}}}}},"examples":{"Valid Customer":{"value":{"total":1,"count":1,"page":1,"per_page":1,"total_pages":1,"_embedded":{"contacts":[{"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":"https://api-docs.talkdesk.org/erc/ecommerce/external/customers"}}}}}}}},"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"}}}}}},"examples":{"Invalid JWT":{"value":{"code":"1974010","message":"Invalid JWT."}},"Account not configured to use ERC E-Commerce APIs":{"value":{"code":"1974011","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":"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."}}}},"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/shopify-webhooks-handler/credentials":{"get":{"operationId":"erc-ecommerce-shopify-webhooks-handler-credentials-get","tags":["Retail Experience Cloud Bridge"],"summary":"Get Shopify Integration Credentials","description":"Get the Shopify Integration credentials for the currently authenticated Talkdesk account.\n\nA successful request returns the Shopify Integration credentials for the authenticated account.\n","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":{"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},"integration_id":{"type":"string","description":"The unique identifier for this integration","minLength":0,"maxLength":2147483647},"shopify_integration_credential":{"type":"object","description":"Represents the Shopify Integration credentials","properties":{"shopify_store_id":{"type":"string","description":"The unique identifier of the Shopify store","minLength":0,"maxLength":2147483647},"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}}},"callbar_customer_search":{"type":"boolean","description":"Indicates whether callbar customer search is enabled for this integration"}}},"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},"integration_id":{"type":"string","description":"The unique identifier for this integration","minLength":0,"maxLength":2147483647},"shopify_integration_credential":{"type":"object","description":"Represents the Shopify Integration credentials","properties":{"shopify_store_id":{"type":"string","description":"The unique identifier of the Shopify store","minLength":0,"maxLength":2147483647},"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}}},"callbar_customer_search":{"type":"boolean","description":"Indicates whether callbar customer search is enabled for this integration"}}}},"callbar_customer_search":{"type":"boolean","description":"Indicates whether callbar customer search is enabled"}}},{"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":{"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":{"operationId":"erc-ecommerce-shopify-webhooks-handler-credentials-put","tags":["Retail Experience Cloud Bridge"],"summary":"Update Shopify Integration Credentials","description":"Upsert the Shopify Integration credentials for the currently authenticated Talkdesk account.\n\nRequired fields:\n- shopify_store_domain\n- shopify_api_key\n- shopify_api_secret\n\nA successful request upserts the Shopify Integration credentials and returns the updated credentials.\n","security":[{"GA":["erc-ecommerce-shopify-webhooks-handler-credentials:write"]}],"requestBody":{"description":"The Shopify Integration credentials to be configured for the authenticated Talkdesk account","required":true,"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":{"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":{"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},"integration_id":{"type":"string","description":"The unique identifier for this integration","minLength":0,"maxLength":2147483647},"shopify_integration_credential":{"type":"object","description":"Represents the Shopify Integration credentials","properties":{"shopify_store_id":{"type":"string","description":"The unique identifier of the Shopify store","minLength":0,"maxLength":2147483647},"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}}},"callbar_customer_search":{"type":"boolean","description":"Indicates whether callbar customer search is enabled for this integration"}}},"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},"integration_id":{"type":"string","description":"The unique identifier for this integration","minLength":0,"maxLength":2147483647},"shopify_integration_credential":{"type":"object","description":"Represents the Shopify Integration credentials","properties":{"shopify_store_id":{"type":"string","description":"The unique identifier of the Shopify store","minLength":0,"maxLength":2147483647},"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}}},"callbar_customer_search":{"type":"boolean","description":"Indicates whether callbar customer search is enabled for this integration"}}}},"callbar_customer_search":{"type":"boolean","description":"Indicates whether callbar customer search is enabled"}}},{"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":{"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":{"operationId":"erc-ecommerce-shopify-webhooks-handler-credentials-delete","tags":["Retail Experience Cloud Bridge"],"summary":"Delete Shopify Integration Credentials","description":"Delete the Shopify Integration credentials configured for the currently authenticated Talkdesk account.\n\nRequired fields:\n- shopify_store_domain\n\nA successful request deletes the Shopify Integration credentials for the specified store domain.\n","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":{"operationId":"erc-ecommerce-return-reasons-get","tags":["Retail Experience Cloud Bridge"],"summary":"Get Available Return Reasons","description":"Retrieve the list of available return reasons.\n\nA successful request returns the list of available return reasons.\n","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"},"sub_reasons":{"type":"array","description":"Optional list of sub-reasons","items":{"type":"string"},"example":["Too tight around shoulders","Too tight around chest"]}}}},"_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","sub_reasons":["Too tight around shoulders","Too tight around chest"]}],"_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":{"operationId":"erc-ecommerce-return-calculations-post","tags":["Retail Experience Cloud Bridge"],"summary":"Calculate Return Refund Amount","description":"Calculate the expected refund amount for a return request.\n\nRequired fields:\n- order_id\n- return_line_items\n\nA successful request returns the expected refund amounts for the return request.\n","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.","minimum":0,"exclusiveMinimum":true,"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","_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.","minLength":3,"maxLength":3,"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.","minLength":3,"maxLength":3,"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.","minLength":3,"maxLength":3,"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.","minLength":3,"maxLength":3,"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.","minLength":3,"maxLength":3,"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.","minLength":3,"maxLength":3,"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.","minLength":3,"maxLength":3,"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.","minLength":3,"maxLength":3,"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.","minLength":3,"maxLength":3,"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":{"operationId":"erc-ecommerce-order-cancel-return-return-id-post","tags":["Retail Experience Cloud Bridge"],"summary":"Cancel a Return","description":"Cancel a return by the provided return ID.\n\nRequired fields:\n- return_id\n\nA successful request cancels the return for the specified return ID.\n","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"}},{"name":"cancel_reason","in":"query","required":false,"description":"The reason for cancelling the return.","schema":{"type":"string","maxLength":255,"minLength":1,"example":"Customer changed mind"}}],"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":{"operationId":"erc-ecommerce-order-create-return-post","tags":["Retail Experience Cloud Bridge"],"summary":"Create a New Return","description":"Create a new return for an order.\n\nRequired fields:\n- order_id\n- return_line_items\n\nA successful request returns the newly created return details for the specified order.\n","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.","minimum":0,"exclusiveMinimum":true,"example":30},"return_method":{"type":"string","description":"The return method for the return.","example":"SHIP_TO_STORE"}}},"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,"return_method":"SHIP_TO_STORE"}}}}}},"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"},"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/order/create-return"}}}}}}},"examples":{"Create Return Response":{"value":{"order_id":"order789","return_id":"return001","status":"OPEN","name":"return123","custom_fields":{"key1":"value1"},"_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."}}}}}}},"/erc/ecommerce/refund/suggested":{"post":{"operationId":"erc-ecommerce-refund-suggested-post","tags":["Retail Experience Cloud Bridge"],"summary":"Get Suggested Refund","description":"Calculate the suggested refund for an order or return. Supports two workflows: (1) direct refund from an order with specified line items, or (2) refund after a return where line items and totals are pre-calculated from the return.\n\nRequired fields:\n- order_id or return_id (one must be provided)\n\nA successful request returns the suggested refund details for the specified order or return.\n","security":[{"GA":["erc-ecommerce-return:read"]}],"requestBody":{"description":"Suggested refund request containing either an order ID with line items, or a return ID.","content":{"application/json":{"schema":{"type":"object","description":"The suggested refund request body.","properties":{"order_id":{"type":"string","description":"The order ID to calculate the suggested refund for. Either order_id or return_id must be provided.\n","minLength":1,"maxLength":255,"example":"order789"},"return_id":{"type":"string","description":"The return ID to calculate the suggested refund for. Either order_id or return_id must be provided.\n","minLength":1,"maxLength":255,"example":"28916416673"},"brand":{"type":"string","description":"The brand identifier. If the account is multi-brand, this parameter is required.\n","minLength":1,"maxLength":255,"example":"The Brand"},"refund_line_items":{"type":"array","description":"The line items to include in the suggested refund calculation.","items":{"type":"object","description":"A line item for the suggested refund calculation.","required":["line_item_id","quantity"],"properties":{"line_item_id":{"type":"string","description":"The line item ID.","example":"line_item_1"},"quantity":{"type":"integer","description":"The quantity to refund.","example":1}}}},"shipping_amount":{"type":"number","description":"The shipping amount to refund. Must be positive.","minimum":0,"exclusiveMinimum":true,"example":10},"refund_shipping":{"type":"boolean","description":"Whether to include shipping in the refund.","example":false},"refund_duties":{"type":"array","description":"The duties to include in the refund.","items":{"type":"object","description":"A duty to include in the refund.","required":["duty_id"],"properties":{"duty_id":{"type":"string","description":"The duty ID.","example":"duty_1"}}}},"suggest_full_refund":{"type":"boolean","description":"Whether to suggest a full refund for the order.","example":false}}},"examples":{"Suggested Refund By Return ID":{"value":{"return_id":"28916416673","brand":"The Brand"}},"Suggested Refund By Order ID":{"value":{"order_id":"order789","brand":"The Brand","refund_line_items":[{"line_item_id":"line_item_1","quantity":1},{"line_item_id":"line_item_2","quantity":2}],"shipping_amount":10,"refund_shipping":true,"suggest_full_refund":false}}}}}},"responses":{"200":{"description":"The suggested refund details.","content":{"application/json":{"schema":{"type":"object","description":"The suggested refund response body.","required":["amount","maximum_refundable","subtotal","total_tax","total_duties","discounted_subtotal","shipping","suggested_transactions","suggested_refund_methods","refund_line_items","_links"],"properties":{"amount":{"type":"object","description":"The total suggested refund amount.","required":["value","currency"],"properties":{"value":{"type":"number","description":"The amount value.","example":30},"currency":{"type":"string","description":"The currency code.","minLength":3,"maxLength":3,"example":"EUR"}}},"maximum_refundable":{"type":"object","description":"The maximum amount that can be refunded.","required":["value","currency"],"properties":{"value":{"type":"number","description":"The amount value.","example":30},"currency":{"type":"string","description":"The currency code.","minLength":3,"maxLength":3,"example":"EUR"}}},"subtotal":{"type":"object","description":"The subtotal of the refund.","required":["value","currency"],"properties":{"value":{"type":"number","description":"The amount value.","example":30},"currency":{"type":"string","description":"The currency code.","minLength":3,"maxLength":3,"example":"EUR"}}},"total_tax":{"type":"object","description":"The total tax amount of the refund.","required":["value","currency"],"properties":{"value":{"type":"number","description":"The amount value.","example":30},"currency":{"type":"string","description":"The currency code.","minLength":3,"maxLength":3,"example":"EUR"}}},"total_duties":{"type":"object","description":"The total duties amount of the refund.","required":["value","currency"],"properties":{"value":{"type":"number","description":"The amount value.","example":30},"currency":{"type":"string","description":"The currency code.","minLength":3,"maxLength":3,"example":"EUR"}}},"discounted_subtotal":{"type":"object","description":"The discounted subtotal of the refund.","required":["value","currency"],"properties":{"value":{"type":"number","description":"The amount value.","example":30},"currency":{"type":"string","description":"The currency code.","minLength":3,"maxLength":3,"example":"EUR"}}},"shipping":{"type":"object","description":"The shipping refund details.","required":["amount","maximum_refundable","tax"],"properties":{"amount":{"type":"object","description":"The shipping refund amount.","required":["value","currency"],"properties":{"value":{"type":"number","description":"The amount value.","example":30},"currency":{"type":"string","description":"The currency code.","minLength":3,"maxLength":3,"example":"EUR"}}},"maximum_refundable":{"type":"object","description":"The maximum refundable shipping amount.","required":["value","currency"],"properties":{"value":{"type":"number","description":"The amount value.","example":30},"currency":{"type":"string","description":"The currency code.","minLength":3,"maxLength":3,"example":"EUR"}}},"tax":{"type":"object","description":"The shipping tax amount.","required":["value","currency"],"properties":{"value":{"type":"number","description":"The amount value.","example":30},"currency":{"type":"string","description":"The currency code.","minLength":3,"maxLength":3,"example":"EUR"}}}}},"suggested_transactions":{"type":"array","description":"The suggested payment transactions for the refund.","items":{"type":"object","description":"A suggested refund transaction.","required":["kind","amount"],"properties":{"gateway":{"type":"string","description":"The payment gateway.","example":"shopify_payments"},"kind":{"type":"string","description":"The transaction kind.","example":"SUGGESTED_REFUND"},"amount":{"type":"object","description":"The transaction amount.","required":["value","currency"],"properties":{"value":{"type":"number","description":"The amount value.","example":30},"currency":{"type":"string","description":"The currency code.","minLength":3,"maxLength":3,"example":"EUR"}}},"maximum_refundable":{"type":"object","description":"The maximum refundable amount for this transaction.","required":["value","currency"],"properties":{"value":{"type":"number","description":"The amount value.","example":30},"currency":{"type":"string","description":"The currency code.","minLength":3,"maxLength":3,"example":"EUR"}}},"parent_transaction_id":{"type":"string","description":"The parent transaction ID.","example":"txn_123"}}}},"suggested_refund_methods":{"type":"array","description":"The suggested refund methods.","items":{"type":"object","description":"A suggested refund method.","required":["type","amount","maximum_refundable"],"properties":{"type":{"type":"string","description":"The refund method type.","example":"CREDIT_CARD"},"amount":{"type":"object","description":"The refund method amount.","required":["value","currency"],"properties":{"value":{"type":"number","description":"The amount value.","example":30},"currency":{"type":"string","description":"The currency code.","minLength":3,"maxLength":3,"example":"EUR"}}},"maximum_refundable":{"type":"object","description":"The maximum refundable amount for this method.","required":["value","currency"],"properties":{"value":{"type":"number","description":"The amount value.","example":30},"currency":{"type":"string","description":"The currency code.","minLength":3,"maxLength":3,"example":"EUR"}}}}}},"refund_line_items":{"type":"array","description":"The line items included in the suggested refund.","items":{"type":"object","description":"A line item in the suggested refund.","required":["line_item_id","title","quantity","max_refundable_quantity","restockable","original_unit_price","subtotal","total_tax"],"properties":{"line_item_id":{"type":"string","description":"The line item ID.","example":"line_item_1"},"title":{"type":"string","description":"The product title.","example":"Blue T-Shirt"},"sku":{"type":"string","description":"The product SKU.","example":"BTS-001"},"variant_title":{"type":"string","description":"The variant title.","example":"Size M"},"image_url":{"type":"string","description":"The product image URL.","format":"uri","example":"https://cdn.example.com/images/blue-tshirt.png"},"quantity":{"type":"integer","description":"The quantity to refund.","example":1},"max_refundable_quantity":{"type":"integer","description":"The maximum quantity that can be refunded for this line item.","example":2},"restockable":{"type":"boolean","description":"Whether the item can be restocked.","example":true},"original_unit_price":{"type":"object","description":"The original unit price of the item.","required":["value","currency"],"properties":{"value":{"type":"number","description":"The amount value.","example":30},"currency":{"type":"string","description":"The currency code.","minLength":3,"maxLength":3,"example":"EUR"}}},"subtotal":{"type":"object","description":"The subtotal for this line item.","required":["value","currency"],"properties":{"value":{"type":"number","description":"The amount value.","example":30},"currency":{"type":"string","description":"The currency code.","minLength":3,"maxLength":3,"example":"EUR"}}},"total_tax":{"type":"object","description":"The total tax for this line item.","required":["value","currency"],"properties":{"value":{"type":"number","description":"The amount value.","example":30},"currency":{"type":"string","description":"The currency code.","minLength":3,"maxLength":3,"example":"EUR"}}},"custom_fields":{"type":"object","description":"Additional custom fields.","additionalProperties":true}}}},"return_context":{"type":"object","description":"The return context when the suggested refund is based on a return.","required":["return_id","return_name","order_id","status"],"properties":{"return_id":{"type":"string","description":"The return ID.","example":"return_001"},"return_name":{"type":"string","description":"The return name.","example":"Return #1234"},"order_id":{"type":"string","description":"The order ID associated with the return.","example":"order789"},"status":{"type":"string","description":"The return status.","example":"OPEN"},"line_items":{"type":"array","description":"The return line items.","items":{"type":"object","description":"A line item in the return context.","required":["line_item_id","quantity"],"properties":{"line_item_id":{"type":"string","description":"The line item ID.","example":"line_item_1"},"quantity":{"type":"integer","description":"The quantity returned.","example":1},"return_reason":{"type":"string","description":"The return reason.","example":"DEFECTIVE"},"return_reason_note":{"type":"string","description":"Additional notes about the return reason.","example":"Item arrived damaged."},"restocking_fee_percentage":{"type":"number","description":"The restocking fee percentage applied to the line item.","example":10},"restocking_fee_amount":{"type":"object","description":"The restocking fee amount applied to the line item.","required":["value","currency"],"properties":{"value":{"type":"number","description":"The amount value.","example":30},"currency":{"type":"string","description":"The currency code.","minLength":3,"maxLength":3,"example":"EUR"}}}}}}}},"custom_fields":{"type":"object","description":"Additional custom fields.","additionalProperties":true},"deductions":{"type":"object","description":"The deductions applied to the refund.","required":["total"],"properties":{"return_shipping":{"type":"object","description":"The return shipping cost deducted from the refund.","required":["value","currency"],"properties":{"value":{"type":"number","description":"The amount value.","example":30},"currency":{"type":"string","description":"The currency code.","minLength":3,"maxLength":3,"example":"EUR"}}},"restocking_fees":{"type":"object","description":"The restocking fees deducted from the refund.","required":["value","currency"],"properties":{"value":{"type":"number","description":"The amount value.","example":30},"currency":{"type":"string","description":"The currency code.","minLength":3,"maxLength":3,"example":"EUR"}}},"total":{"type":"object","description":"The total deductions amount.","required":["value","currency"],"properties":{"value":{"type":"number","description":"The amount value.","example":30},"currency":{"type":"string","description":"The currency code.","minLength":3,"maxLength":3,"example":"EUR"}}}}},"refund_owed":{"type":"object","description":"The total refund amount owed.","required":["value","currency"],"properties":{"value":{"type":"number","description":"The amount value.","example":30},"currency":{"type":"string","description":"The currency code.","minLength":3,"maxLength":3,"example":"EUR"}}},"return_item_discount":{"type":"object","description":"The discount applied to the return items.","required":["value","currency"],"properties":{"value":{"type":"number","description":"The amount value.","example":30},"currency":{"type":"string","description":"The currency code.","minLength":3,"maxLength":3,"example":"EUR"}}},"taxes_included":{"type":"boolean","description":"Whether taxes are included in the refund.","example":false},"locations":{"type":"array","description":"The locations associated with the refund.","items":{"type":"object","description":"A location associated with the refund.","required":["id","name"],"properties":{"id":{"type":"string","description":"The location ID.","example":"location_001"},"name":{"type":"string","description":"The location name.","example":"Main Warehouse"}}}},"_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/refund/suggested"}}}}}}},"examples":{"Suggested Refund Response":{"value":{"amount":{"value":150,"currency":"EUR"},"maximum_refundable":{"value":200,"currency":"EUR"},"subtotal":{"value":130,"currency":"EUR"},"total_tax":{"value":20,"currency":"EUR"},"total_duties":{"value":0,"currency":"EUR"},"discounted_subtotal":{"value":125,"currency":"EUR"},"shipping":{"amount":{"value":10,"currency":"EUR"},"maximum_refundable":{"value":15,"currency":"EUR"},"tax":{"value":2,"currency":"EUR"}},"suggested_transactions":[{"gateway":"shopify_payments","kind":"SUGGESTED_REFUND","amount":{"value":150,"currency":"EUR"},"maximum_refundable":{"value":200,"currency":"EUR"},"parent_transaction_id":"txn_123"}],"suggested_refund_methods":[{"type":"CREDIT_CARD","amount":{"value":150,"currency":"EUR"},"maximum_refundable":{"value":200,"currency":"EUR"}}],"refund_line_items":[{"line_item_id":"line_item_1","title":"Blue T-Shirt","sku":"BTS-001","variant_title":"Size M","image_url":"https://cdn.example.com/images/blue-tshirt.png","quantity":1,"max_refundable_quantity":2,"restockable":true,"original_unit_price":{"value":65,"currency":"EUR"},"subtotal":{"value":65,"currency":"EUR"},"total_tax":{"value":10,"currency":"EUR"}},{"line_item_id":"line_item_2","title":"Red Sneakers","sku":"RS-002","variant_title":"Size 42","image_url":"https://cdn.example.com/images/red-sneakers.png","quantity":1,"max_refundable_quantity":1,"restockable":true,"original_unit_price":{"value":65,"currency":"EUR"},"subtotal":{"value":65,"currency":"EUR"},"total_tax":{"value":10,"currency":"EUR"}}],"return_context":{"return_id":"return_001","return_name":"Return #1234","order_id":"order789","status":"OPEN","line_items":[{"line_item_id":"line_item_1","quantity":1,"return_reason":"DEFECTIVE","return_reason_note":"Item arrived damaged."},{"line_item_id":"line_item_2","quantity":1,"return_reason":"SIZE_TOO_SMALL","return_reason_note":"The item is too small."}]},"deductions":{"return_shipping":{"value":5,"currency":"EUR"},"restocking_fees":{"value":2,"currency":"EUR"},"total":{"value":7,"currency":"EUR"}},"refund_owed":{"value":143,"currency":"EUR"},"return_item_discount":{"value":10,"currency":"EUR"},"taxes_included":false,"locations":[{"id":"location_001","name":"Main Warehouse"}],"_links":{"self":{"href":"http://api-docs.talkdesk.org/erc/ecommerce/refund/suggested"}}}}}}}},"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/refund":{"post":{"operationId":"erc-ecommerce-refund-post","tags":["Retail Experience Cloud Bridge"],"summary":"Create a Refund","description":"Create a direct refund for an order. Supports refunding specific line items, shipping costs, and duties with configurable payment transactions and refund methods.\n\nRequired fields:\n- order_id\n\nA successful request returns the created refund details for the specified order.\n","security":[{"GA":["erc-ecommerce-return:write"]}],"requestBody":{"description":"Create refund request containing order ID, line items, and payment details.","content":{"application/json":{"schema":{"type":"object","description":"The create refund request body.","required":["order_id"],"properties":{"order_id":{"type":"string","description":"The order ID to create the refund for.","minLength":1,"maxLength":255,"example":"order789"},"brand":{"type":"string","description":"The brand identifier. If the account is multi-brand, this parameter is required.\n","minLength":1,"maxLength":255,"example":"The Brand"},"note":{"type":"string","description":"A note describing the reason for the refund.","example":"Customer requested refund due to defective item."},"notify":{"type":"boolean","description":"Whether to notify the customer about the refund.","example":true},"currency":{"type":"string","description":"The currency code for the refund.","example":"EUR"},"shipping":{"type":"object","description":"Shipping refund details.","properties":{"shipping_refund_amount":{"type":"number","description":"The shipping amount to refund.","example":10},"full_refund":{"type":"boolean","description":"Whether to fully refund shipping.","example":false}}},"refund_line_items":{"type":"array","description":"The line items to refund.","items":{"type":"object","description":"A line item to refund.","required":["line_item_id","quantity"],"properties":{"line_item_id":{"type":"string","description":"The line item ID.","minLength":1,"maxLength":255,"example":"line_item_1"},"quantity":{"type":"integer","description":"The quantity to refund.","minimum":1,"maximum":9999,"example":1},"restock_type":{"type":"string","description":"The restock type for the refunded item.","enum":["NO_RESTOCK","CANCEL","RETURN","LEGACY_RESTOCK"],"example":"RETURN"},"location_id":{"type":"string","description":"The location ID for restocking.","example":"loc_123"}}}},"transactions":{"type":"array","description":"The payment transactions for the refund.","items":{"type":"object","description":"A payment transaction for the refund.","required":["amount","gateway","kind","order_id"],"properties":{"amount":{"type":"string","description":"The transaction amount.","minLength":1,"maxLength":255,"example":"150.00"},"gateway":{"type":"string","description":"The payment gateway.","minLength":1,"maxLength":255,"example":"shopify_payments"},"kind":{"type":"string","description":"The transaction kind.","minLength":1,"maxLength":255,"example":"REFUND"},"order_id":{"type":"string","description":"The order ID.","minLength":1,"maxLength":255,"example":"order789"},"parent_id":{"type":"string","description":"The parent transaction ID.","example":"txn_123"}}}},"refund_methods":{"type":"array","description":"The refund methods to use.","items":{"type":"object","description":"A refund method.","properties":{"store_credit_refund":{"type":"object","description":"Store credit refund details.","required":["amount"],"properties":{"amount":{"type":"object","description":"The store credit amount.","required":["value","currency"],"properties":{"value":{"type":"number","description":"The amount value.","example":30},"currency":{"type":"string","description":"The currency code.","minLength":3,"maxLength":3,"example":"EUR"}}}}}}}}}},"examples":{"Create Refund Request":{"value":{"order_id":"order789","brand":"The Brand","note":"Customer requested refund due to defective item.","notify":true,"currency":"EUR","shipping":{"shipping_refund_amount":10,"full_refund":false},"refund_line_items":[{"line_item_id":"line_item_1","quantity":1,"restock_type":"RETURN","location_id":"loc_123"},{"line_item_id":"line_item_2","quantity":2,"restock_type":"RETURN"}],"transactions":[{"amount":"150.00","gateway":"shopify_payments","kind":"REFUND","order_id":"order789","parent_id":"txn_123"}]}}}}}},"responses":{"201":{"description":"The refund was successfully created.","content":{"application/json":{"schema":{"type":"object","description":"The create refund response body.","required":["refund_id","total_refunded","refund_line_items","transactions","_links"],"properties":{"refund_id":{"type":"string","description":"The unique identifier of the refund.","example":"refund_001"},"order_id":{"type":"string","description":"The unique identifier of the order.","example":"order789"},"note":{"type":"string","description":"The refund note.","example":"Customer requested refund due to defective item."},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the refund was created.","example":"2024-01-15T10:30:00.000Z"},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when the refund was last updated.","example":"2024-01-15T10:30:00.000Z"},"total_refunded":{"type":"object","description":"The total refunded amount.","required":["value","currency"],"properties":{"value":{"type":"number","description":"The amount value.","example":30},"currency":{"type":"string","description":"The currency code.","minLength":3,"maxLength":3,"example":"EUR"}}},"shipping":{"type":"object","description":"The shipping refund details.","required":["subtotal","tax"],"properties":{"subtotal":{"type":"object","description":"The shipping subtotal refunded.","required":["value","currency"],"properties":{"value":{"type":"number","description":"The amount value.","example":30},"currency":{"type":"string","description":"The currency code.","minLength":3,"maxLength":3,"example":"EUR"}}},"tax":{"type":"object","description":"The shipping tax refunded.","required":["value","currency"],"properties":{"value":{"type":"number","description":"The amount value.","example":30},"currency":{"type":"string","description":"The currency code.","minLength":3,"maxLength":3,"example":"EUR"}}}}},"total_duties":{"type":"object","description":"The total duties refunded.","required":["value","currency"],"properties":{"value":{"type":"number","description":"The amount value.","example":30},"currency":{"type":"string","description":"The currency code.","minLength":3,"maxLength":3,"example":"EUR"}}},"refund_line_items":{"type":"array","description":"The refunded line items.","items":{"type":"object","description":"A refunded line item in the response.","required":["line_item_id","title","quantity","restock_type","restocked","subtotal","total_tax"],"properties":{"id":{"type":"string","description":"The refund line item ID.","example":"rli_001"},"line_item_id":{"type":"string","description":"The original line item ID.","example":"line_item_1"},"title":{"type":"string","description":"The product title.","example":"Blue T-Shirt"},"quantity":{"type":"integer","description":"The quantity refunded.","example":1},"restock_type":{"type":"string","description":"The restock type applied.","example":"RETURN"},"restocked":{"type":"boolean","description":"Whether the item was restocked.","example":true},"subtotal":{"type":"object","description":"The subtotal for this line item refund.","required":["value","currency"],"properties":{"value":{"type":"number","description":"The amount value.","example":30},"currency":{"type":"string","description":"The currency code.","minLength":3,"maxLength":3,"example":"EUR"}}},"total_tax":{"type":"object","description":"The total tax for this line item refund.","required":["value","currency"],"properties":{"value":{"type":"number","description":"The amount value.","example":30},"currency":{"type":"string","description":"The currency code.","minLength":3,"maxLength":3,"example":"EUR"}}},"custom_fields":{"type":"object","description":"Additional custom fields.","additionalProperties":true}}}},"transactions":{"type":"array","description":"The refund transactions.","items":{"type":"object","description":"A refund transaction in the response.","required":["id","kind","status","amount"],"properties":{"id":{"type":"string","description":"The transaction ID.","example":"txn_refund_001"},"gateway":{"type":"string","description":"The payment gateway.","example":"shopify_payments"},"kind":{"type":"string","description":"The transaction kind.","example":"REFUND"},"status":{"type":"string","description":"The transaction status.","example":"SUCCESS"},"amount":{"type":"object","description":"The transaction amount.","required":["value","currency"],"properties":{"value":{"type":"number","description":"The amount value.","example":30},"currency":{"type":"string","description":"The currency code.","minLength":3,"maxLength":3,"example":"EUR"}}},"parent_transaction_id":{"type":"string","description":"The parent transaction ID.","example":"txn_123"}}}},"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/refund"}}}}}}},"examples":{"Create Refund Response":{"value":{"refund_id":"refund_001","order_id":"order789","note":"Customer requested refund due to defective item.","created_at":"2024-01-15T10:30:00.000Z","updated_at":"2024-01-15T10:30:00.000Z","total_refunded":{"value":150,"currency":"EUR"},"shipping":{"subtotal":{"value":10,"currency":"EUR"},"tax":{"value":2,"currency":"EUR"}},"total_duties":{"value":0,"currency":"EUR"},"refund_line_items":[{"id":"rli_001","line_item_id":"line_item_1","title":"Blue T-Shirt","quantity":1,"restock_type":"RETURN","restocked":true,"subtotal":{"value":65,"currency":"EUR"},"total_tax":{"value":10,"currency":"EUR"}},{"id":"rli_002","line_item_id":"line_item_2","title":"Red Sneakers","quantity":2,"restock_type":"RETURN","restocked":true,"subtotal":{"value":65,"currency":"EUR"},"total_tax":{"value":10,"currency":"EUR"}}],"transactions":[{"id":"txn_refund_001","gateway":"shopify_payments","kind":"REFUND","status":"SUCCESS","amount":{"value":150,"currency":"EUR"},"parent_transaction_id":"txn_123"}],"_links":{"self":{"href":"http://api-docs.talkdesk.org/erc/ecommerce/refund"}}}}}}}},"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/return/process-refund":{"post":{"operationId":"erc-ecommerce-return-process-refund-post","tags":["Retail Experience Cloud Bridge"],"summary":"Process return and create refund","description":"Process a return and create a refund for the associated order. This endpoint finalizes the return flow by issuing a refund tied to an existing return.\n\nRequired fields:\n- order_id\n- return_id\n\nA successful request returns the created refund details for the specified order.\n","security":[{"GA":["erc-ecommerce-return:write"]}],"requestBody":{"description":"Process return refund request containing order ID, return ID, line items, and payment details.","content":{"application/json":{"schema":{"type":"object","description":"The process return and refund request body.","required":["order_id","return_id"],"properties":{"order_id":{"type":"string","description":"The order ID to create the refund for.","minLength":1,"maxLength":255,"example":"order789"},"return_id":{"type":"string","description":"The return ID to process and refund. This field is required.","minLength":1,"maxLength":255,"example":"return_001"},"brand":{"type":"string","description":"The brand identifier. If the account is multi-brand, this parameter is required.\n","minLength":1,"maxLength":255,"example":"The Brand"},"notify":{"type":"boolean","description":"Whether to notify the customer about the refund.","example":true},"currency":{"type":"string","description":"The currency code for the refund.","minLength":3,"maxLength":3,"example":"EUR"},"refund_line_items":{"type":"array","description":"The line items to refund.","items":{"type":"object","description":"A line item to refund.","required":["line_item_id","quantity"],"properties":{"line_item_id":{"type":"string","description":"The line item ID.","minLength":1,"maxLength":255,"example":"line_item_1"},"quantity":{"type":"integer","description":"The quantity to refund.","minimum":1,"maximum":9999,"example":1},"restock_type":{"type":"string","description":"The restock type for the refunded item.","enum":["NO_RESTOCK","CANCEL","RETURN","LEGACY_RESTOCK"],"example":"RETURN"},"location_id":{"type":"string","description":"The location ID for restocking.","example":"loc_123"}}}},"transactions":{"type":"array","description":"The payment transactions for the refund.","items":{"type":"object","description":"A payment transaction for the refund.","required":["amount","gateway","kind","order_id"],"properties":{"amount":{"type":"string","description":"The transaction amount.","minLength":1,"maxLength":255,"example":"150.00"},"gateway":{"type":"string","description":"The payment gateway.","minLength":1,"maxLength":255,"example":"shopify_payments"},"kind":{"type":"string","description":"The transaction kind.","minLength":1,"maxLength":255,"example":"REFUND"},"order_id":{"type":"string","description":"The order ID.","minLength":1,"maxLength":255,"example":"order789"},"parent_id":{"type":"string","description":"The parent transaction ID.","example":"txn_123"}}}}}},"examples":{"Process Return Refund Request":{"value":{"order_id":"order789","return_id":"return_001","brand":"The Brand","notify":true,"currency":"EUR","refund_line_items":[{"line_item_id":"line_item_1","quantity":1,"restock_type":"RETURN","location_id":"loc_123"},{"line_item_id":"line_item_2","quantity":2,"restock_type":"RETURN"}],"transactions":[{"amount":"150.00","gateway":"shopify_payments","kind":"REFUND","order_id":"order789","parent_id":"txn_123"}]}}}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","description":"The create refund response body.","required":["refund_id","total_refunded","refund_line_items","transactions","_links"],"properties":{"refund_id":{"type":"string","description":"The unique identifier of the refund.","example":"refund_001"},"order_id":{"type":"string","description":"The unique identifier of the order.","example":"order789"},"note":{"type":"string","description":"The refund note.","example":"Customer requested refund due to defective item."},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the refund was created.","example":"2024-01-15T10:30:00.000Z"},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when the refund was last updated.","example":"2024-01-15T10:30:00.000Z"},"total_refunded":{"type":"object","description":"The total refunded amount.","required":["value","currency"],"properties":{"value":{"type":"number","description":"The amount value.","example":30},"currency":{"type":"string","description":"The currency code.","minLength":3,"maxLength":3,"example":"EUR"}}},"shipping":{"type":"object","description":"The shipping refund details.","required":["subtotal","tax"],"properties":{"subtotal":{"type":"object","description":"The shipping subtotal refunded.","required":["value","currency"],"properties":{"value":{"type":"number","description":"The amount value.","example":30},"currency":{"type":"string","description":"The currency code.","minLength":3,"maxLength":3,"example":"EUR"}}},"tax":{"type":"object","description":"The shipping tax refunded.","required":["value","currency"],"properties":{"value":{"type":"number","description":"The amount value.","example":30},"currency":{"type":"string","description":"The currency code.","minLength":3,"maxLength":3,"example":"EUR"}}}}},"total_duties":{"type":"object","description":"The total duties refunded.","required":["value","currency"],"properties":{"value":{"type":"number","description":"The amount value.","example":30},"currency":{"type":"string","description":"The currency code.","minLength":3,"maxLength":3,"example":"EUR"}}},"refund_line_items":{"type":"array","description":"The refunded line items.","items":{"type":"object","description":"A refunded line item in the response.","required":["line_item_id","title","quantity","restock_type","restocked","subtotal","total_tax"],"properties":{"id":{"type":"string","description":"The refund line item ID.","example":"rli_001"},"line_item_id":{"type":"string","description":"The original line item ID.","example":"line_item_1"},"title":{"type":"string","description":"The product title.","example":"Blue T-Shirt"},"quantity":{"type":"integer","description":"The quantity refunded.","example":1},"restock_type":{"type":"string","description":"The restock type applied.","example":"RETURN"},"restocked":{"type":"boolean","description":"Whether the item was restocked.","example":true},"subtotal":{"type":"object","description":"The subtotal for this line item refund.","required":["value","currency"],"properties":{"value":{"type":"number","description":"The amount value.","example":30},"currency":{"type":"string","description":"The currency code.","minLength":3,"maxLength":3,"example":"EUR"}}},"total_tax":{"type":"object","description":"The total tax for this line item refund.","required":["value","currency"],"properties":{"value":{"type":"number","description":"The amount value.","example":30},"currency":{"type":"string","description":"The currency code.","minLength":3,"maxLength":3,"example":"EUR"}}},"custom_fields":{"type":"object","description":"Additional custom fields.","additionalProperties":true}}}},"transactions":{"type":"array","description":"The refund transactions.","items":{"type":"object","description":"A refund transaction in the response.","required":["id","kind","status","amount"],"properties":{"id":{"type":"string","description":"The transaction ID.","example":"txn_refund_001"},"gateway":{"type":"string","description":"The payment gateway.","example":"shopify_payments"},"kind":{"type":"string","description":"The transaction kind.","example":"REFUND"},"status":{"type":"string","description":"The transaction status.","example":"SUCCESS"},"amount":{"type":"object","description":"The transaction amount.","required":["value","currency"],"properties":{"value":{"type":"number","description":"The amount value.","example":30},"currency":{"type":"string","description":"The currency code.","minLength":3,"maxLength":3,"example":"EUR"}}},"parent_transaction_id":{"type":"string","description":"The parent transaction ID.","example":"txn_123"}}}},"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/refund"}}}}}}},"examples":{"Process Return Refund Response":{"value":{"refund_id":"refund_001","order_id":"order789","note":"Customer requested refund due to defective item.","created_at":"2024-01-15T10:30:00.000Z","updated_at":"2024-01-15T10:30:00.000Z","total_refunded":{"value":150,"currency":"EUR"},"shipping":{"subtotal":{"value":10,"currency":"EUR"},"tax":{"value":2,"currency":"EUR"}},"total_duties":{"value":0,"currency":"EUR"},"refund_line_items":[{"id":"rli_001","line_item_id":"line_item_1","title":"Blue T-Shirt","quantity":1,"restock_type":"RETURN","restocked":true,"subtotal":{"value":65,"currency":"EUR"},"total_tax":{"value":10,"currency":"EUR"}},{"id":"rli_002","line_item_id":"line_item_2","title":"Red Sneakers","quantity":2,"restock_type":"RETURN","restocked":true,"subtotal":{"value":65,"currency":"EUR"},"total_tax":{"value":10,"currency":"EUR"}}],"transactions":[{"id":"txn_refund_001","gateway":"shopify_payments","kind":"REFUND","status":"SUCCESS","amount":{"value":150,"currency":"EUR"},"parent_transaction_id":"txn_123"}],"_links":{"self":{"href":"http://api-docs.talkdesk.org/erc/ecommerce/refund"}}}}}}}},"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/catalog/search":{"post":{"operationId":"erc-ecommerce-catalog-search-post","tags":["Retail Experience Cloud Bridge"],"summary":"Search catalog","description":"Search the product catalog of the configured e-commerce store.","security":[{"GA":["erc-ecommerce-products:read"]}],"requestBody":{"required":true,"description":"Catalog search parameters","content":{"application/json":{"schema":{"type":"object","description":"Parameters for searching the product catalog of the configured e-commerce store.","properties":{"brand":{"type":"string","description":"The brand (store identifier) to search within. Required when the account is configured with multiple integrations.\n","example":"my-shopify-store"},"query":{"type":"string","description":"Free-text search query used to match products by title, description, tags, etc.","example":"black dress"},"intent":{"type":"string","description":"Natural-language intent of the search, used by the upstream AI-powered engine to improve ranking and relevance.\n","example":"The customer is looking for a black evening dress under $100"},"filters":{"type":"object","description":"Optional filters to narrow down the product catalog search results.","properties":{"categories":{"type":"string","description":"Comma-separated list of category names to filter by. Example: `\"Women,Dresses\"` will filter products belonging to either category.\n","example":"Women,Dresses"},"price":{"type":"object","description":"Price range filter. Values are expressed in major currency units (human-readable amounts).\n","properties":{"min":{"type":"number","format":"double","description":"Minimum price in major currency units (inclusive).","example":20},"max":{"type":"number","format":"double","description":"Maximum price in major currency units (inclusive).","example":100}}}}},"pagination":{"type":"object","description":"Pagination parameters for the catalog search.","properties":{"limit":{"type":"integer","description":"Maximum number of products to return per page.","minimum":1,"maximum":50,"default":5,"example":5},"cursor":{"type":"string","nullable":true,"description":"Opaque cursor returned in a previous response's `pagination.cursor` field. Pass `null` or omit to start from the beginning.\n","example":"eyJsYXN0X2lkIjoiZ2lkOi8vc2hvcGlmeS9Qcm9kdWN0LzEyMzQ1Njc4OTAifQ=="}}}}},"example":{"brand":"gid://shopify/Shop/123","query":"black dress","intent":"The customer is looking for a black evening dress under $100","filters":{"categories":"Women,Dresses","price":{"min":20,"max":100}},"pagination":{"limit":5,"cursor":null}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","description":"Paginated list of products matching the search criteria.","required":["products","pagination"],"properties":{"products":{"type":"array","description":"List of products in the current page.","items":{"type":"object","description":"A product from the e-commerce catalog.","required":["id"],"properties":{"id":{"type":"string","description":"Unique product identifier.","example":"1234567890"},"title":{"type":"string","description":"Display name of the product.","example":"Black Evening Dress"},"brand":{"type":"string","description":"Store identifier this product belongs to.","example":"gid://shopify/Shop/123"},"description":{"type":"string","nullable":true,"description":"HTML description of the product.","example":"

    Elegant black evening dress made from premium fabric.

    "},"handle":{"type":"string","nullable":true,"description":"URL-friendly slug for the product.","example":"black-evening-dress"},"image_url":{"type":"string","nullable":true,"description":"URL of the product's primary image.","example":"https://test.com/s/files/1/0001/product-image.jpg"},"options":{"type":"array","description":"List of product option groups (e.g. Color, Size).","items":{"type":"object","description":"A named option group and its available values (e.g. Size → [S, M, L]).","required":["name","values"],"properties":{"name":{"type":"string","description":"Option group name.","example":"Size"},"values":{"type":"array","description":"Available values for this option.","items":{"type":"string"},"example":["XS","S","M","L","XL"]}}}},"variants":{"type":"array","description":"List of purchasable variants of this product.","items":{"type":"object","description":"A specific, purchasable variant of a product.","required":["id"],"properties":{"id":{"type":"string","description":"Unique variant identifier.","example":"9876543210"},"sku":{"type":"string","nullable":true,"description":"Stock Keeping Unit code.","example":"BED-BLK-M"},"title":{"type":"string","nullable":true,"description":"Variant display name (typically a combination of selected options).","example":"Black / M"},"price":{"type":"object","description":"Monetary amount with currency.","properties":{"value":{"type":"number","format":"double","description":"Amount in major currency units (e.g. `25.99` for USD, `1500` for JPY).","example":25.99},"currency":{"type":"string","description":"ISO 4217 currency code.","example":"USD"}}},"available":{"type":"boolean","description":"Whether this variant is currently available for purchase.","example":true},"checkout_url":{"type":"string","nullable":true,"description":"Direct checkout URL for this variant.","example":"https://test.com/cart/add?id=9876543210"},"image_url":{"type":"string","nullable":true,"description":"URL of the variant-specific image.","example":"https://test.com/s/files/1/0001/variant-image.jpg"},"options":{"type":"object","description":"Map of option name → selected value for this variant.","additionalProperties":{"type":"string"},"example":{"Color":"Black","Size":"M"}}}}}}}},"pagination":{"type":"object","description":"Pagination metadata for iterating through large result sets.","required":["has_next_page"],"properties":{"cursor":{"type":"string","nullable":true,"description":"Opaque cursor to pass as `pagination.cursor` in the next request to retrieve the following page. `null` when there is no next page.\n","example":"eyJsYXN0X2lkIjoiZxxxxx4NzY1NDMyMTAifQ=="},"has_next_page":{"type":"boolean","description":"Whether there are more products beyond the current page.","example":true}}}}},"examples":{"Valid product list":{"value":{"products":[{"id":"1234567890","title":"Black Evening Dress","brand":"gid://shopify/Shop/123","description":"

    Elegant black evening dress made from premium fabric.

    ","handle":"black-evening-dress","image_url":"https://test.com/s/files/1/0001/product-main.jpg","options":[{"name":"Size","values":["XS","S","M","L","XL"]},{"name":"Color","values":["Black","Navy"]}],"variants":[{"id":"9876543210","sku":"BED-BLK-M","title":"Black / M","price":{"value":89.99,"currency":"USD"},"available":true,"checkout_url":"https://test.com/cart/add?id=9876543210","image_url":"https://test.com/s/files/1/0001/variant-black-m.jpg","options":{"Color":"Black","Size":"M"}},{"id":"9876543211","sku":"BED-NVY-M","title":"Navy / M","price":{"value":89.99,"currency":"USD"},"available":false,"checkout_url":"https://test.com/cart/add?id=9876543211","image_url":"https://test.com/s/files/1/0001/variant-navy-m.jpg","options":{"Color":"Navy","Size":"M"}}]}],"pagination":{"cursor":"eyJsYXN0X2lkIjoiZxxxxx4NzY1NDMyMTAifQ==","has_next_page":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":"1984000","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":"1984010","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":"1984030","message":"Required scopes are missing."}}}},"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":"1985000","message":"Internal Server Error."}}}}}}},"/ccaas/users/{id}/status":{"put":{"operationId":"ccaas-users-id-status-put","summary":"Update User Status","description":"Updates the status of a specific user in the contact center.\nUse this endpoint to programmatically change a user's availability, for example to integrate with an external scheduling tool or automate status management workflows.
    \nNote that the user status cannot be set from neither to the following statuses: busy, after_call_work, offline.\nCustom statuses must already exist in the user's account before they can be set.","x-internal":true,"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":["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":{"operationId":"ccaas-users-status-post","summary":"Get Users Status","description":"Retrieves the current status of multiple users in a single request.\nUse this endpoint to monitor agent availability in bulk, for example to power a live agent dashboard or a workforce management integration.\nThe maximum number of user IDs per request is 20.","x-internal":true,"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":["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":{"get":{"x-namespace":"/ccaas","description":"Returns a paginated list of queues configured for the account.\nUse this endpoint to browse available queues, search by name, filter by prompt, or sort results.\nQueues represent logical groupings used to route interactions to the appropriate agents.","security":[{"GA":["queues:read"]}],"summary":"List Queues","tags":["Queues API"],"operationId":"GetAllQueues","parameters":[{"in":"query","name":"name","description":"Allows searching Queues by name.

    To fetch queues whose name partially or totally match a given string (this will be case insensitive), fill in this query parameter with the string to search for.","required":false,"schema":{"type":"string","x-filterable":true,"minLength":1}},{"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":"Quantity of queues to be listed on each page. May change the total number of pages for the same collection.","required":false,"schema":{"type":"integer","default":20,"minimum":1,"maximum":100}},{"in":"query","name":"id","description":"Allows filtering by the Queue Id (only filtering by one id is allowed).
    If the id and name parameters are both filled in, the id prevails because it is the first rule.

    To fetch a given queue, fill this query parameter with the Queue id.","required":false,"schema":{"x-filterable":true,"type":"string","minLength":1}},{"in":"query","name":"order_by","required":false,"schema":{"type":"string","minLength":1,"x-sorting_default_order":"desc","x-sorting_default_field":"updated_at","x-sorting_fields":["name"]},"description":"The order_by parameter allows you to sort the retrieved results. If not specified, the default sorting will be based on the most recent Queue update (updated_at). Sort by multiple fields is currently not supported.\n\nSupported sort fields\n* `name` - Sort by queue name\n\nExamples\n* `order_by=name:desc` - Retrieve results sorted by queue name in descending order.\n"},{"in":"query","name":"prompt_ids","example":"prompt_id1,prompt_id2","required":false,"schema":{"type":"string","x-filterable":true,"minLength":1},"description":"Allows filtering by Prompt Id(s). Supports one or more values, separated by commas.

    To fetch queues where the agent_waiting_music settings match specific Prompt Id(s), provide the Prompt Id(s) in this query parameter."}],"responses":{"200":{"description":"Queues list successfully","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"type":"integer"},"count":{"type":"integer"},"page":{"type":"integer"},"per_page":{"type":"integer"},"_embedded":{"type":"object","properties":{"queues":{"type":"array","items":{"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"]}}},"required":["queues"]},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string"}},"required":["href"]},"page":{"type":"object","properties":{"href":{"type":"string"}},"required":["href"]},"prev":{"type":"object","properties":{"href":{"type":"string"}},"required":["href"],"nullable":true},"next":{"type":"object","properties":{"href":{"type":"string"}},"required":["href"],"nullable":true}},"required":["self","page"]}},"required":["total","count","page","per_page","_embedded","_links"]},"example":{"total":3,"count":1,"page":2,"per_page":1,"_embedded":{"queues":[{"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}}}}]},"_links":{"self":{"href":"http://api-docs.talkdesk.org/queues"},"page":{"href":"http://api-docs.talkdesk.org/queues?page=2"},"prev":{"href":"http://api-docs.talkdesk.org/queues?page=1"},"next":{"href":"http://api-docs.talkdesk.org/queues?page=3"}}}}}},"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."}}}},"422":{"description":"Invalid query parameters","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0490006","message":"Invalid query parameters","fields":[{"name":"page","description":"must be greater than or equal to 1"},{"name":"per_page","description":"must be greater than or equal to 1"}]}}}},"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."}}}}}}},"/ccaas/queues/users":{"post":{"x-namespace":"/ccaas","description":"Assigns the provided users to the provided queues.\nSome relevant information regarding this endpoint:\n\n- The operation is idempotent. If the user already has the queue it becomes a no-op. The API returns success as if the operation went through\n- It fails with the appropriate HTTP error code when the request does not conform to the pre-conditions\n- Any other failure that is not expected will be reported back in the response of endpoint with a `200 OK`.\n This means that consumers always have to check the response to determine if the operation was a success or not (or only partial success)\n- The endpoint is not transactional. If some error occurs it might have updated some resources\n\n## Pre-conditions\nCurrently the pre-conditions that are checked are:\n- Some invalid user id exists (it does not conform to the ID spec)\n- Some queue has over a number of defined (default 100) users in the payload.\n","security":[{"GA":["queues:write"]}],"summary":"Assign users to queues","tags":["Queues API"],"operationId":"AssignUsersToQueues","requestBody":{"description":"An array of objects. Each object contain the queue and the respective users to assign to that queue","required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The queue id"},"users":{"type":"array","description":"A list of account user's ids","items":{"type":"string"}}},"required":["id","users"]}},"example":[{"id":"english","users":["444f4380ccc31543cdb7c6c2a","444f4380ccc31543cdb7c6c2b","444f4380ccc31543cdb7c6c2c","44f4380ccc31543cdb7c6c2d"]}]}}},"responses":{"200":{"description":"Processed the operation requested.\n\nThe success, error or partial success of the API must always be done checking the response as shown in the endpoint description.\n\nIf the `result` field returns `OK` then no errors were found. Otherwise errors occured and should be checked.\n","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","description":"The values will either be `OK`, to signal everything went fine, or `KO` to signal there were errors","enum":["OK","KO"]},"errors":{"type":"array","items":{"type":"object","properties":{"queue_id":{"type":"string"},"user_id":{"type":"string"},"error":{"type":"string","description":"This is an error code"},"description":{"type":"string"}},"required":["queue_id","error","description"]}}},"required":["result","errors"]},"examples":{"Success":{"value":{"result":"OK","errors":[]}},"Operation with errors":{"value":{"result":"KO","errors":[]}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"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."}}}},"422":{"description":"The size of the users array exceeds the permitted maximum 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":"0490007","message":"The number of users being assigned to a queue is out of bounds"}}}},"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."}}}}}},"delete":{"x-namespace":"/ccaas","description":"This endpoint receives objects with a queue identifier and the users to unassign from those queues.\n\nSome relevant information regarding this endpoint:\n\n- The operation is idempotent. If the user already is not assigned to a queue the operation becomes no-op. The API returns success as if the operation went through\n- It fails with the appropriate HTTP error code when the request does not conform to the pre-conditions\n- Any other failure that is not expected will be reported back in the response of endpoint with a `200 OK`.\n This means that consumers always have to check the response to determine if the operation was a success or not (or only partial success)\n- The endpoint is not transactional. If some error occurs it might have updated some resources\n- Its mandatory for a user to have at least one queue assigned\n\n## Pre-conditions\nCurrently the pre-conditions that are checked are:\n- Some invalid user id exists (it does not conform to the ID spec)\n- A object has over a number of defined (default 100) users in the payload.\n- There are up to 100 objects for the bulk request\n","security":[{"GA":["queues:write"]}],"summary":"Unassings users to queues","tags":["Queues API"],"operationId":"UnassignUsersToQueues","requestBody":{"description":"An array of objects. Each object contain the queue and the respective users to unassign to that queue","required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The queue id"},"users":{"type":"array","description":"A list of account user's ids","items":{"type":"string"}}},"required":["id","users"]}},"example":[{"id":"english","users":["444f4380ccc31543cdb7c6c2a","444f4380ccc31543cdb7c6c2b","444f4380ccc31543cdb7c6c2c","44f4380ccc31543cdb7c6c2d"]}]}}},"responses":{"200":{"description":"Processed the operation requested.\n\nThe success, error or partial success of the API must always be done checking the response as shown in the endpoint description.\n\nIf the `result` field returns `OK` then no errors were found. Otherwise errors occured and should be checked.\n","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","description":"The values will either be `OK`, to signal everything went fine, or `KO` to signal there were errors","enum":["OK","KO"]},"errors":{"type":"array","items":{"type":"object","properties":{"queue_id":{"type":"string"},"user_id":{"type":"string"},"error":{"type":"string","description":"This is an error code"},"description":{"type":"string"}},"required":["queue_id","error","description"]}}},"required":["result","errors"]},"examples":{"Success":{"value":{"result":"OK","errors":[]}},"Operation with errors":{"value":{"result":"KO","errors":[]}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"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":"Cannot unassign queue from user","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0490014","message":"User has only one queue assigned"}}}},"422":{"description":"The size of the users array exceeds the permitted maximum 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":"0490007","message":"The number of users being unassigned to a queue is out of bounds"}}}},"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."}}}}}}},"/ccaas/queues/{queue_id}/users":{"get":{"x-namespace":"/ccaas","description":"Returns a paginated list of users assigned to a specific queue.\nUse this endpoint to inspect queue membership, for example when auditing agent assignments or displaying queue details in a management UI.\nResults can be filtered by the user's active status.\n","security":[{"GA":["queues-users:read"]}],"summary":"List Queue Users","tags":["Queues API"],"operationId":"GetQueueUsers","parameters":[{"name":"queue_id","in":"path","description":"Identifier of the queue","required":true,"schema":{"type":"string"}},{"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":"Quantity of users to be listed on each page.","required":false,"schema":{"type":"integer","default":50,"minimum":1,"maximum":100}},{"in":"query","name":"active","description":"Filter the results by active flag.","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"List of users assigned to queue returned successfully","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"type":"integer","description":"Total number of users assigned to the queue"},"count":{"type":"integer","description":"Number of users in the current page"},"page":{"type":"integer"},"per_page":{"type":"integer"},"queue_id":{"type":"string","description":"The identifier of the queue"},"_embedded":{"type":"object","properties":{"users":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The user identifier"},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string"}},"required":["href"]}},"required":["self"]}},"required":["id","_links"]}}},"required":["users"]},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string"}},"required":["href"]},"page":{"type":"object","properties":{"href":{"type":"string"}},"required":["href"]},"prev":{"type":"object","properties":{"href":{"type":"string"}},"required":["href"],"nullable":true},"next":{"type":"object","properties":{"href":{"type":"string"}},"required":["href"],"nullable":true}},"required":["self","page"]}},"required":["total","count","page","per_page","queue_id","_embedded","_links"]},"example":{"total":3,"count":2,"page":1,"per_page":2,"queue_id":"agents","_embedded":{"users":[{"id":"60a7c1e2f1b3c4d5e6f7a8b9","_links":{"self":{"href":"https://api.talkdeskapp.com/users/60a7c1e2f1b3c4d5e6f7a8b9"}}},{"id":"60a7c1e2f1b3c4d5e6f7a8c0","_links":{"self":{"href":"https://api.talkdeskapp.com/users/60a7c1e2f1b3c4d5e6f7a8c0"}}}]},"_links":{"self":{"href":"https://api.talkdeskapp.com/ccaas/queues/agents/users?page=1&per_page=2"},"page":{"href":"https://api.talkdeskapp.com/ccaas/queues/agents/users?page=1&per_page=2"},"prev":null,"next":{"href":"https://api.talkdeskapp.com/ccaas/queues/agents/users?page=2&per_page=2"}}}}}},"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."}}}},"404":{"description":"Queue not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0490004","message":"Queue Not Found"}}}},"422":{"description":"Invalid query parameters","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0490006","message":"Invalid query parameters","fields":[{"name":"page","description":"must be greater than or equal to 1"},{"name":"per_page","description":"must be greater than or equal to 1"}]}}}},"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"],"summary":"Get the paginated list of locations","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":"phone_number","in":"query","required":false,"schema":{"type":"string","example":"+1 (555)","description":"Performs a case-insensitive substring match against the location's phone numbers. An empty string is treated as absent, and no filter is applied.","default":"","minLength":0,"maxLength":255}},{"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","staffs"],"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"}}}},"staffs":{"type":"array","description":"The list of staff members assigned to this location.","default":[],"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","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}},"staffs":[{"id":"a1b2c3d4-0000-0000-0000-000000000001","name":"Dr. Ana Costa","external_id":"staff-001","relationships":[{"id":"d06b0425-c9eb-d8a3-a7c0-ce14d96a651f","name":"General Consultation"}],"tags":[{"id":"tag-001","name":"Cardiologist"}]}]},{"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"}],"staffs":[]}]},"_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"],"summary":"Get location cities","description":"Get location cities","x-internal":true,"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"],"summary":"Get location names","description":"Get location names","x-internal":true,"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"],"summary":"Get the paginated list of locations","description":"Get the paginated list of locations for agent view","x-internal":true,"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","staffs"],"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"}}}},"staffs":{"type":"array","description":"The list of staff members assigned to this location.","default":[],"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","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"],"summary":"Get locations and staffs for agents","description":"Get the list of locations and staffs for agent view","x-internal":true,"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":"A free-text search term to filter locations and staff by relevance. Supports partial word matching\n(e.g., `\"bos\"` matches `\"Boston\"`). Terms shorter than 3 characters are ignored.\nWhen provided, results are sorted by relevance score (highest first), then alphabetically by name.\nWhen omitted or empty, all matching results are returned sorted alphabetically. A maximum of 100 results are returned.\n\n**When searching for locations, the following fields are matched:**\n- Location name and alternative names\n- Location type\n- Address, zip code, city, region, country\n- Phone number (partial/fuzzy match)\n- Names and types of associated services\n\n**When searching for staff, the following fields are matched:**\n- Staff name and specialities (highest priority)\n- Job title and visit type names\n- Languages and gender\n- Contact values (phone numbers, emails) — partial/fuzzy match\n- Names and types of associated services\n- Associated tag values\n","example":"Boston cardiology","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":"Boston cardiology","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"],"summary":"Get customer addresses","description":"get customer addresses","x-internal":true,"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"],"summary":"Get a location by id","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","staffs"],"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"}}}},"staffs":{"type":"array","description":"The list of staff members assigned to this location.","default":[],"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"}}}}}}}}}]},{"allOf":[{"type":"object","required":["name","time_zone","address","staffs"],"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"}}}},"staffs":{"type":"array","description":"The list of staff members assigned to this location.","default":[],"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"}}}}}}}}},{"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"],"summary":"Get location next week opening hours","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"],"summary":"Get the paginated list of services","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"],"summary":"Get the paginated list of services","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"],"summary":"Get the paginated list of services","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"],"summary":"Get a service by id","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"],"summary":"Get service next week opening hours","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"],"summary":"Get Google geo addresses","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"],"summary":"Get Google geocoding","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"],"summary":"Get the paginated list of service types","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"],"summary":"Get service names","description":"Get service names","x-internal":true,"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"],"summary":"Get service durations","description":"Get service durations","x-internal":true,"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"],"summary":"Search staffs by conditions","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"],"summary":"Get staff specialities","description":"Get staff specialities","x-internal":true,"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"],"summary":"Get paginated staffs for agent view","description":"Get the paginated list of staffs for agent view","x-internal":true,"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"],"summary":"Get the paginated list of specialties","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":"cardiology","description":"The specialty of the staff who can provide the service","default":"","minLength":0,"maxLength":9999}},{"name":"location_name","in":"query","required":false,"schema":{"type":"string","example":"South Lyon","description":"The name of the location which can provide the service","default":"","minLength":0,"maxLength":150}},{"name":"location_type","in":"query","required":false,"schema":{"type":"string","example":"Store","description":"The type of the location which can provide the service","default":"","minLength":0,"maxLength":150}},{"name":"location_id","in":"query","required":false,"schema":{"type":"string","example":"loc-ext-id-1","description":"The external ID of the location","default":"","minLength":0,"maxLength":150}},{"name":"staff_id","in":"query","required":false,"schema":{"type":"string","example":"staff-ext-id-1","description":"The external ID of the staff member","default":"","minLength":0,"maxLength":150}},{"name":"staff_name","in":"query","required":false,"schema":{"type":"string","example":"Jane Smith","description":"The name of the staff member","default":"","minLength":0,"maxLength":9999}},{"name":"staff_visit_type","in":"query","required":false,"schema":{"type":"string","example":"in-person","description":"The visit type name of the staff member","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"],"summary":"Get staff genders","description":"Get staff genders","x-internal":true,"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":{"operationId":"industries-scheduler-teams-get","tags":["INDUSTRIES SCHEDULER API"],"summary":"Get teams associated to an account","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":{"operationId":"industries-scheduler-availabilities-post","tags":["INDUSTRIES SCHEDULER API"],"summary":"Get availabilities by email","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":{"operationId":"industries-scheduler-appointment-get","tags":["INDUSTRIES SCHEDULER API"],"summary":"Get appointments associated to an account","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":{"operationId":"industries-scheduler-appointment-post","tags":["INDUSTRIES SCHEDULER API"],"summary":"Create and notify appointment via SMS","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":{"operationId":"industries-scheduler-appointment-put","tags":["INDUSTRIES SCHEDULER API"],"summary":"Update appointment by eventId","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":{"operationId":"industries-scheduler-appointment-cancel-post","tags":["INDUSTRIES SCHEDULER API"],"summary":"Delete appointment by eventId","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."}}}}}}},"/industries/workflows/schedules":{"get":{"tags":["industries-workflows"],"summary":"List workflow schedules","description":"Returns the paginated list of workflow schedules owned by the authenticated account.","operationId":"listIndustriesWorkflowSchedules","security":[{"GA":["industries-workflows:read"]}],"parameters":[{"name":"page_size","in":"query","required":false,"description":"Number of items per page. Values outside the range are clamped.","schema":{"type":"integer","minimum":1,"maximum":100,"default":50}},{"name":"cursor","in":"query","required":false,"description":"Cursor token returned by a previous call to fetch the next page.","schema":{"type":"string","minLength":1,"maxLength":2048}}],"responses":{"200":{"description":"The paginated list of schedules.","content":{"application/json":{"schema":{"type":"object","required":["_embedded","per_page"],"properties":{"total":{"type":"integer","description":"Total number of schedules. Returns -1 when unknown."},"per_page":{"type":"integer","description":"Number of items per page."},"page_token":{"type":"string","nullable":true,"description":"Token pointing to the current page (echoed from the request)."},"next_page_token":{"type":"string","nullable":true,"description":"Token to retrieve the next page. Absent when there are no more pages."},"_embedded":{"type":"object","required":["schedules"],"properties":{"schedules":{"type":"array","items":{"type":"object","required":["id","is_paused"],"properties":{"id":{"type":"string","minLength":1,"maxLength":256,"description":"The schedule identifier."},"workflow_name":{"type":"string","nullable":true,"minLength":1,"maxLength":256,"description":"The name of the workflow implementation that runs on each scheduled execution."},"job_name":{"type":"string","nullable":true,"minLength":1,"maxLength":256,"description":"Optional logical job name associated with this schedule."},"cron_expression":{"type":"string","nullable":true,"minLength":1,"maxLength":256,"description":"Cron expression that drives the schedule. Null when the schedule fires only once at start_at."},"start_at":{"type":"string","format":"date-time","nullable":true,"description":"Optional one-shot start time for the schedule."},"payload":{"type":"object","nullable":true,"description":"Payload passed to the workflow when triggered.","additionalProperties":true},"is_paused":{"type":"boolean","description":"Whether the schedule is currently paused."},"created_at":{"type":"string","format":"date-time","nullable":true,"description":"Creation timestamp of the schedule."},"next_run_time":{"type":"string","format":"date-time","nullable":true,"description":"Next scheduled run time."}}}}}},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string"}}},"next":{"type":"object","properties":{"href":{"type":"string"}}}}}}},"example":{"total":-1,"per_page":50,"page_token":null,"next_page_token":"eyJvZmZzZXQiOjUwfQ==","_embedded":{"schedules":[{"id":"c52251b809da47de8eeea68bf832b1e4","workflow_name":"ContactsSyncWorkflow","job_name":"contacts-sync","cron_expression":"0 */5 * * * *","start_at":null,"payload":{"external_id":"12443"},"is_paused":false,"created_at":"2026-04-20T10:29:16.854494Z","next_run_time":"2026-04-24T18:00:00Z"}]},"_links":{"self":{"href":"https://api.talkdeskapp.com/industries/workflows/schedules?per_page=50"},"next":{"href":"https://api.talkdeskapp.com/industries/workflows/schedules?per_page=50&page_token=eyJvZmZzZXQiOjUwfQ=="}}}}}},"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":"1750400","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":"1750401","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":"1750403","message":"Required scopes are missing."}}}},"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":"1750500","message":"Internal Server Error."}}}}}},"post":{"tags":["industries-workflows"],"summary":"Create a workflow schedule","description":"Creates a new schedule that will trigger the configured workflow on the given cron expression.","operationId":"createIndustriesWorkflowSchedule","security":[{"GA":["industries-workflows:write"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workflow_name","task_queue"],"properties":{"workflow_name":{"type":"string","minLength":1,"maxLength":256,"description":"Name of the workflow implementation that will run on each scheduled execution."},"task_queue":{"type":"string","minLength":1,"maxLength":256,"description":"The task queue that will run the workflow."},"job_name":{"type":"string","nullable":true,"minLength":1,"maxLength":256,"description":"Optional logical job name associated with this schedule."},"cron_expression":{"type":"string","nullable":true,"minLength":1,"maxLength":256,"description":"Cron expression for the schedule. Either cron_expression or start_at must be provided."},"start_at":{"type":"string","format":"date-time","nullable":true,"description":"Optional one-shot start time. Use this instead of cron_expression to fire the schedule a single time."},"payload":{"type":"object","description":"Payload passed to the workflow on each execution.","additionalProperties":true},"tags":{"type":"array","description":"Optional tags to apply to every workflow produced by the schedule.","items":{"type":"string","minLength":1,"maxLength":256}}}},"example":{"workflow_name":"ContactsSyncWorkflow","task_queue":"contacts-sync-queue","job_name":"contacts-sync","cron_expression":"0 */5 * * * *","start_at":null,"payload":{"external_id":"12443"},"tags":["tenant:acme"]}}}},"responses":{"201":{"description":"The schedule was created.","content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","minLength":1,"maxLength":256,"description":"The identifier of the newly created schedule."}}},"example":{"id":"c52251b809da47de8eeea68bf832b1e4"}}}},"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":"1750400","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":"1750401","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":"1750403","message":"Required scopes are missing."}}}},"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":"1750500","message":"Internal Server Error."}}}}}}},"/industries/workflows/schedules/{id}":{"patch":{"tags":["industries-workflows"],"summary":"Pause or resume a schedule","description":"Updates the paused state of an existing schedule.","operationId":"updateIndustriesWorkflowSchedule","security":[{"GA":["industries-workflows:write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The schedule identifier.","schema":{"type":"string","minLength":1,"maxLength":256}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["is_paused"],"properties":{"is_paused":{"type":"boolean","description":"Whether the schedule should be paused (true) or resumed (false)."}}},"example":{"is_paused":true}}}},"responses":{"200":{"description":"The schedule was 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":"1750400","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":"1750401","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":"1750403","message":"Required scopes are missing."}}}},"404":{"description":"Schedule not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1750404","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":"1750500","message":"Internal Server Error."}}}}}},"delete":{"tags":["industries-workflows"],"summary":"Delete a schedule","description":"Permanently removes a schedule.","operationId":"deleteIndustriesWorkflowSchedule","security":[{"GA":["industries-workflows:write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The schedule identifier.","schema":{"type":"string","minLength":1,"maxLength":256}}],"responses":{"204":{"description":"The schedule was 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":"1750401","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":"1750403","message":"Required scopes are missing."}}}},"404":{"description":"Schedule not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1750404","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":"1750500","message":"Internal Server Error."}}}}}}},"/industries/workflows":{"get":{"tags":["industries-workflows"],"summary":"List workflows","description":"Returns the paginated list of workflows for the authenticated account. Supports filtering by workflow name, job name, status, time ranges, and tags.","operationId":"listIndustriesWorkflows","security":[{"GA":["industries-workflows:read"]}],"parameters":[{"name":"page_size","in":"query","required":false,"description":"Number of items per page. Values outside the range are clamped.","schema":{"type":"integer","minimum":1,"maximum":100,"default":50}},{"name":"cursor","in":"query","required":false,"description":"Cursor token returned by a previous call to fetch the next page.","schema":{"type":"string","minLength":1,"maxLength":2048}},{"name":"workflow_name","in":"query","required":false,"description":"Filter by the workflow name.","schema":{"type":"string","minLength":1,"maxLength":256}},{"name":"job_name","in":"query","required":false,"description":"Filter by the job name.","schema":{"type":"string","minLength":1,"maxLength":256}},{"name":"status","in":"query","required":false,"description":"Filter by workflow status. Repeat the parameter to filter by multiple statuses.","style":"form","explode":true,"schema":{"type":"array","items":{"type":"string","description":"High-level status of a workflow.","minLength":1,"maxLength":16,"enum":["RUNNING","COMPLETED","FAILED","CANCELLED","TERMINATED","TIMED_OUT"]}}},{"name":"start_time_from","in":"query","required":false,"description":"Return workflows started at or after this timestamp (inclusive).","schema":{"type":"string","format":"date-time","minLength":20,"maxLength":40}},{"name":"start_time_to","in":"query","required":false,"description":"Return workflows started at or before this timestamp (inclusive).","schema":{"type":"string","format":"date-time","minLength":20,"maxLength":40}},{"name":"close_time_from","in":"query","required":false,"description":"Return workflows closed at or after this timestamp (inclusive).","schema":{"type":"string","format":"date-time","minLength":20,"maxLength":40}},{"name":"close_time_to","in":"query","required":false,"description":"Return workflows closed at or before this timestamp (inclusive).","schema":{"type":"string","format":"date-time","minLength":20,"maxLength":40}},{"name":"tags","in":"query","required":false,"description":"Filter by tags. Repeat the parameter to match multiple tags.","style":"form","explode":true,"schema":{"type":"array","items":{"type":"string","minLength":1,"maxLength":256}}},{"name":"include_progress","in":"query","required":false,"description":"When true, each running workflow in the response is enriched with its overall completion percentage.","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"The paginated list of workflows.","content":{"application/json":{"schema":{"type":"object","required":["_embedded","per_page"],"properties":{"total":{"type":"integer","description":"Total number of workflows matching the filters."},"per_page":{"type":"integer"},"page_token":{"type":"string","nullable":true},"next_page_token":{"type":"string","nullable":true},"_embedded":{"type":"object","required":["workflows"],"properties":{"workflows":{"type":"array","items":{"type":"object","required":["id","workflow_name","status","tags"],"properties":{"id":{"type":"string","minLength":1,"maxLength":256,"description":"The workflow identifier."},"run_id":{"type":"string","nullable":true,"minLength":1,"maxLength":256,"description":"The run identifier of the workflow."},"workflow_name":{"type":"string","minLength":1,"maxLength":256,"description":"The name of the workflow implementation."},"job_name":{"type":"string","nullable":true,"minLength":1,"maxLength":256,"description":"The logical job name the workflow belongs to."},"status":{"type":"string","description":"High-level status of a workflow.","minLength":1,"maxLength":16,"enum":["RUNNING","COMPLETED","FAILED","CANCELLED","TERMINATED","TIMED_OUT"]},"created_at":{"type":"string","format":"date-time","nullable":true},"started_at":{"type":"string","format":"date-time","nullable":true},"completed_at":{"type":"string","format":"date-time","nullable":true},"next_run_at":{"type":"string","format":"date-time","nullable":true,"description":"Next scheduled run time when the workflow is driven by a schedule."},"tags":{"type":"array","items":{"type":"string","minLength":1,"maxLength":256}},"progress":{"type":"integer","nullable":true,"description":"Overall completion percentage (0-100). Only populated when include_progress is true.","minimum":0,"maximum":100},"schedule_id":{"type":"string","nullable":true,"minLength":1,"maxLength":256,"description":"Identifier of the schedule that triggered this workflow, if any."},"cron_expression":{"type":"string","nullable":true,"minLength":1,"maxLength":256,"description":"Cron expression of the schedule that triggered this workflow, if any."}}}}}},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string"}}},"next":{"type":"object","properties":{"href":{"type":"string"}}}}}}},"example":{"total":1,"per_page":50,"page_token":null,"next_page_token":null,"_embedded":{"workflows":[{"id":"ContactsSyncWorkflow-8fa5b2c3-d7e1-4a9b-b3c4-62f1a7e0d9aa","run_id":"6b2a4a40-9ee1-4d93-ae5e-c9c7f5a7f3b1","workflow_name":"ContactsSyncWorkflow","job_name":"contacts-sync","status":"RUNNING","created_at":"2026-04-24T09:55:00Z","started_at":"2026-04-24T09:55:01Z","completed_at":null,"next_run_at":null,"tags":["tenant:acme"],"progress":42,"schedule_id":null,"cron_expression":null}]},"_links":{"self":{"href":"https://api.talkdeskapp.com/industries/workflows?per_page=50"}}}}}},"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":"1750400","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":"1750401","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":"1750403","message":"Required scopes are missing."}}}},"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":"1750500","message":"Internal Server Error."}}}}}},"post":{"tags":["industries-workflows"],"summary":"Start a workflow","description":"Starts a new workflow for the authenticated account.","operationId":"startIndustriesWorkflow","security":[{"GA":["industries-workflows:write"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workflow_name","task_queue"],"properties":{"workflow_name":{"type":"string","minLength":1,"maxLength":256,"description":"Name of the workflow implementation to execute."},"task_queue":{"type":"string","minLength":1,"maxLength":256,"description":"The task queue that will run the workflow."},"job_name":{"type":"string","nullable":true,"minLength":1,"maxLength":256,"description":"Optional logical job name associated with this workflow."},"workflow_id":{"type":"string","minLength":1,"maxLength":256,"nullable":true,"description":"Optional client-provided identifier for the workflow. When omitted, a new identifier is generated."},"payload":{"type":"object","description":"Payload passed to the workflow.","additionalProperties":true},"tags":{"type":"array","items":{"type":"string","minLength":1,"maxLength":256}}}},"example":{"workflow_name":"ContactsSyncWorkflow","task_queue":"contacts-sync-queue","job_name":"contacts-sync","workflow_id":null,"payload":{"external_id":"12443"},"tags":["tenant:acme"]}}}},"responses":{"201":{"description":"The workflow was started.","content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","minLength":1,"maxLength":256,"description":"The identifier of the newly started workflow."}}},"example":{"id":"ContactsSyncWorkflow-8fa5b2c3-d7e1-4a9b-b3c4-62f1a7e0d9aa"}}}},"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":"1750400","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":"1750401","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":"1750403","message":"Required scopes are missing."}}}},"409":{"description":"A workflow with this ID is already running.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1750409","message":"A workflow with this ID is already running."}}}},"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":"1750500","message":"Internal Server Error."}}}}}}},"/industries/workflows/{id}":{"get":{"tags":["industries-workflows"],"summary":"Get a workflow","description":"Returns the detailed state of a workflow, including its actions and associated schedule (when applicable).","operationId":"getIndustriesWorkflow","security":[{"GA":["industries-workflows:read"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The workflow identifier.","schema":{"type":"string","minLength":1,"maxLength":256}}],"responses":{"200":{"description":"The workflow details.","content":{"application/json":{"schema":{"type":"object","required":["id","workflow_name","status","tags","actions"],"properties":{"id":{"type":"string","minLength":1,"maxLength":256},"run_id":{"type":"string","nullable":true,"minLength":1,"maxLength":256},"workflow_name":{"type":"string","minLength":1,"maxLength":256},"job_name":{"type":"string","nullable":true,"minLength":1,"maxLength":256},"status":{"type":"string","description":"High-level status of a workflow.","minLength":1,"maxLength":16,"enum":["RUNNING","COMPLETED","FAILED","CANCELLED","TERMINATED","TIMED_OUT"]},"created_at":{"type":"string","format":"date-time","nullable":true},"started_at":{"type":"string","format":"date-time","nullable":true},"completed_at":{"type":"string","format":"date-time","nullable":true},"next_run_at":{"type":"string","format":"date-time","nullable":true,"description":"Next scheduled run time when the workflow is driven by a schedule."},"tags":{"type":"array","items":{"type":"string","minLength":1,"maxLength":256}},"progress":{"type":"integer","nullable":true,"minimum":0,"maximum":100,"description":"Overall completion percentage for running workflows."},"payload":{"type":"object","nullable":true,"additionalProperties":true},"actions":{"type":"array","items":{"type":"object","required":["id","activity"],"properties":{"id":{"type":"string","minLength":1,"maxLength":256,"description":"The action identifier within the workflow."},"display_name":{"type":"string","nullable":true,"minLength":1,"maxLength":256},"activity":{"type":"string","minLength":1,"maxLength":256,"description":"The name of the underlying activity."},"payload":{"type":"object","nullable":true,"additionalProperties":true},"result":{"type":"object","nullable":true,"additionalProperties":true}}}},"schedule":{"allOf":[{"type":"object","required":["schedule_id","is_paused"],"properties":{"schedule_id":{"type":"string","minLength":1,"maxLength":256},"cron_expression":{"type":"string","nullable":true,"minLength":1,"maxLength":256,"description":"Cron expression that drives the schedule. Null when the schedule fires only once at start_at."},"start_at":{"type":"string","format":"date-time","nullable":true,"description":"Optional one-shot start time for the schedule."},"is_paused":{"type":"boolean"}}}],"nullable":true,"description":"Present when the workflow was triggered by a schedule."}}},"example":{"id":"ContactsSyncWorkflow-8fa5b2c3-d7e1-4a9b-b3c4-62f1a7e0d9aa","run_id":"6b2a4a40-9ee1-4d93-ae5e-c9c7f5a7f3b1","workflow_name":"ContactsSyncWorkflow","job_name":"contacts-sync","status":"RUNNING","created_at":"2026-04-24T09:55:00Z","started_at":"2026-04-24T09:55:01Z","completed_at":null,"next_run_at":null,"tags":["tenant:acme"],"progress":42,"payload":{"external_id":"12443"},"actions":[{"id":"action-1","display_name":"Fetch contacts","activity":"FetchContactsActivity","payload":{"batch_size":100},"result":null}],"schedule":{"schedule_id":"c52251b809da47de8eeea68bf832b1e4","cron_expression":"0 */5 * * * *","start_at":null,"is_paused":false}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1750401","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":"1750403","message":"Required scopes are missing."}}}},"404":{"description":"Workflow not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1750404","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":"1750500","message":"Internal Server Error."}}}}}},"patch":{"tags":["industries-workflows"],"summary":"Cancel or terminate a workflow","description":"Transitions a running workflow to CANCELLED or TERMINATED.","operationId":"updateIndustriesWorkflow","security":[{"GA":["industries-workflows:write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The workflow identifier.","schema":{"type":"string","minLength":1,"maxLength":256}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["status"],"properties":{"status":{"type":"string","minLength":1,"maxLength":16,"description":"Target status to transition the workflow to. Only cancel/terminate transitions are supported.","enum":["CANCELLED","TERMINATED"]}}},"example":{"status":"CANCELLED"}}}},"responses":{"200":{"description":"The updated workflow details.","content":{"application/json":{"schema":{"type":"object","required":["id","workflow_name","status","tags","actions"],"properties":{"id":{"type":"string","minLength":1,"maxLength":256},"run_id":{"type":"string","nullable":true,"minLength":1,"maxLength":256},"workflow_name":{"type":"string","minLength":1,"maxLength":256},"job_name":{"type":"string","nullable":true,"minLength":1,"maxLength":256},"status":{"type":"string","description":"High-level status of a workflow.","minLength":1,"maxLength":16,"enum":["RUNNING","COMPLETED","FAILED","CANCELLED","TERMINATED","TIMED_OUT"]},"created_at":{"type":"string","format":"date-time","nullable":true},"started_at":{"type":"string","format":"date-time","nullable":true},"completed_at":{"type":"string","format":"date-time","nullable":true},"next_run_at":{"type":"string","format":"date-time","nullable":true,"description":"Next scheduled run time when the workflow is driven by a schedule."},"tags":{"type":"array","items":{"type":"string","minLength":1,"maxLength":256}},"progress":{"type":"integer","nullable":true,"minimum":0,"maximum":100,"description":"Overall completion percentage for running workflows."},"payload":{"type":"object","nullable":true,"additionalProperties":true},"actions":{"type":"array","items":{"type":"object","required":["id","activity"],"properties":{"id":{"type":"string","minLength":1,"maxLength":256,"description":"The action identifier within the workflow."},"display_name":{"type":"string","nullable":true,"minLength":1,"maxLength":256},"activity":{"type":"string","minLength":1,"maxLength":256,"description":"The name of the underlying activity."},"payload":{"type":"object","nullable":true,"additionalProperties":true},"result":{"type":"object","nullable":true,"additionalProperties":true}}}},"schedule":{"allOf":[{"type":"object","required":["schedule_id","is_paused"],"properties":{"schedule_id":{"type":"string","minLength":1,"maxLength":256},"cron_expression":{"type":"string","nullable":true,"minLength":1,"maxLength":256,"description":"Cron expression that drives the schedule. Null when the schedule fires only once at start_at."},"start_at":{"type":"string","format":"date-time","nullable":true,"description":"Optional one-shot start time for the schedule."},"is_paused":{"type":"boolean"}}}],"nullable":true,"description":"Present when the workflow was triggered by a schedule."}}},"example":{"id":"ContactsSyncWorkflow-8fa5b2c3-d7e1-4a9b-b3c4-62f1a7e0d9aa","run_id":"6b2a4a40-9ee1-4d93-ae5e-c9c7f5a7f3b1","workflow_name":"ContactsSyncWorkflow","job_name":"contacts-sync","status":"RUNNING","created_at":"2026-04-24T09:55:00Z","started_at":"2026-04-24T09:55:01Z","completed_at":null,"next_run_at":null,"tags":["tenant:acme"],"progress":42,"payload":{"external_id":"12443"},"actions":[{"id":"action-1","display_name":"Fetch contacts","activity":"FetchContactsActivity","payload":{"batch_size":100},"result":null}],"schedule":{"schedule_id":"c52251b809da47de8eeea68bf832b1e4","cron_expression":"0 */5 * * * *","start_at":null,"is_paused":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"}}}}}},"example":{"code":"1750400","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":"1750401","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":"1750403","message":"Required scopes are missing."}}}},"404":{"description":"Workflow not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1750404","message":"Resource not found."}}}},"422":{"description":"The workflow cannot be transitioned to the requested status.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1750422","message":"Cannot transition the execution to the requested status."}}}},"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":"1750500","message":"Internal Server Error."}}}}}}},"/industries/workflows/{id}/progress":{"get":{"tags":["industries-workflows"],"summary":"Get workflow progress","description":"Returns the overall completion percentage of a workflow along with per-action progress.","operationId":"getIndustriesWorkflowProgress","security":[{"GA":["industries-workflows:read"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The workflow identifier.","schema":{"type":"string","minLength":1,"maxLength":256}}],"responses":{"200":{"description":"The progress of the workflow.","content":{"application/json":{"schema":{"type":"object","required":["id","overall_percentage","actions","_links"],"properties":{"id":{"type":"string","minLength":1,"maxLength":256,"description":"The workflow identifier the progress refers to."},"overall_percentage":{"type":"integer","description":"Overall completion percentage (0-100). Returns -1 when progress is not yet available.","minimum":-1,"maximum":100},"actions":{"type":"array","items":{"type":"object","required":["action_id","activity_name","status","weight","percentage"],"properties":{"action_id":{"type":"string","minLength":1,"maxLength":256},"activity_name":{"type":"string","minLength":1,"maxLength":256},"status":{"type":"string","minLength":1,"maxLength":32,"description":"Current status of the action."},"weight":{"type":"integer","description":"Relative weight of the action in the overall progress computation."},"percentage":{"type":"integer","description":"Completion percentage of the individual action.","minimum":0,"maximum":100}}}},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string","minLength":1,"maxLength":2048}}}}}}},"example":{"id":"ContactsSyncWorkflow-8fa5b2c3-d7e1-4a9b-b3c4-62f1a7e0d9aa","overall_percentage":42,"actions":[{"action_id":"action-1","activity_name":"FetchContactsActivity","status":"COMPLETED","weight":1,"percentage":100},{"action_id":"action-2","activity_name":"PersistContactsActivity","status":"RUNNING","weight":1,"percentage":20}],"_links":{"self":{"href":"https://api.talkdeskapp.com/industries/workflows/ContactsSyncWorkflow-8fa5b2c3-d7e1-4a9b-b3c4-62f1a7e0d9aa/progress"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1750401","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":"1750403","message":"Required scopes are missing."}}}},"404":{"description":"Workflow not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"1750404","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":"1750500","message":"Internal Server Error."}}}}}}},"/interaction-custom-fields":{"post":{"operationId":"interaction-custom-fields-post","x-namespace":"/interaction-custom-fields","summary":"Publish 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}}},{"description":"Filter external sources by their connector type. Accepts multiple values to filter by more than one connector type.\n","in":"query","name":"connector_type","schema":{"type":"array","items":{"description":"The type of the external source.","enum":["CUSTOM"],"example":"CUSTOM","type":"string","maxLength":255}}},{"description":"Filter external sources by their current indexing status. Accepts multiple values to filter by more than one status.\n","in":"query","name":"status","schema":{"type":"array","items":{"description":"The current indexing status of an external source.","type":"string","minLength":2,"maxLength":20,"enum":["NOT_INDEXED","OK","INDEXING","ERROR","INCOMPLETE"],"example":"OK"}}},{"description":"Return only external sources whose last sync ended at or after this timestamp. Must be a valid ISO 8601 date-time string (e.g. `2024-01-15T10:00:00.000Z`).\n","in":"query","name":"last_sync_after","schema":{"type":"string","format":"date-time","minLength":20,"maxLength":30,"example":"2024-01-15T10:00:00.000Z"}},{"description":"Return only external sources whose last sync ended at or before this timestamp. Must be a valid ISO 8601 date-time string (e.g. `2024-01-15T23:59:59.000Z`).\n","in":"query","name":"last_sync_before","schema":{"type":"string","format":"date-time","minLength":20,"maxLength":30,"example":"2024-01-15T23:59:59.000Z"}},{"description":"Comma-separated list of sort specifications in the form `field:direction`.\n\nSupported sort fields:\n* `name` - Sort by external source name\n* `status` - Sort by indexing status\n* `last_sync` - Sort by the date of the last completed sync\n\nSupported directions: `asc`, `desc`. Multiple fields can be combined.\nDefaults to `name:asc` when omitted.\n\nExamples:\n* `order_by=name:asc` - Sort by name ascending\n* `order_by=last_sync:desc` - Sort by last sync date descending\n* `order_by=name:asc,status:desc` - Sort by name then status\n","in":"query","name":"order_by","required":false,"schema":{"type":"string","minLength":1,"maxLength":200,"example":"name:asc,status:desc","x-sorting_fields":["name","status","last_sync"],"x-sorting_default_order":"asc"}}],"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"},"aggregations":{"description":"Aggregated counts of external sources grouped by status. Values reflect the currently active filters.","type":"object","properties":{"by_status":{"description":"Aggregated counts of external sources grouped by their effective status. Counts respect the active filters applied to the list request.","type":"object","required":["total","deactivated","success","failed","incomplete"],"properties":{"total":{"description":"Total number of external sources matching the current filters.","type":"integer"},"deactivated":{"description":"Number of disabled (enabled=false) external sources.","type":"integer"},"success":{"description":"Number of enabled external sources with indexing status OK.","type":"integer"},"failed":{"description":"Number of enabled external sources with indexing status ERROR.","type":"integer"},"incomplete":{"description":"Number of enabled external sources with indexing status INCOMPLETE.","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."}},"x-internal":true,"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."}},"x-internal":true,"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."}},"x-internal":true,"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."}},"x-internal":true,"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."}},"x-internal":true,"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."}},"x-internal":true,"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."}},"x-internal":true,"security":[{"EarlyAccess":["km-external-sources:write"]}],"tags":["Knowledge Management"]}},"/omnichannel/interactions/{resource_type}":{"delete":{"operationId":"interactions_elimination","tags":["DCE Tracking"],"summary":"Interaction Resource Deletion","description":"Permanently deletes resources associated with interactions, filtered by resource type and interaction IDs. Currently, only the `transcript` resource type is supported. Use this endpoint for compliance-driven data removal or cleanup of interaction records. The operation is irreversible and processes deletions in bulk. Returns a summary of successfully deleted and failed items.","x-internal":true,"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"}}}}}}},"/omnichannel/tracking/execute/action":{"post":{"operationId":"PostConnectionExecution","summary":"Execute a digital connection action","description":"Executes an action on a digital connection associated with a message, optionally passing contact attributes to the connection action.","x-internal":true,"security":[{"EarlyAccess":["digital-connection-execution:write"]}],"tags":["DCE Tracking"],"parameters":[{"name":"Authorization","in":"header","description":"A token used to access the API.","required":true,"schema":{"type":"string","minLength":1,"maxLength":5000},"example":"Bearer 2pUwO0zU7PTlWXVHE6G1GDI3niEVML"}],"requestBody":{"description":"Specifies the message, connection, and action to execute.","required":true,"content":{"application/json":{"schema":{"description":"Post request body for digital connection execution.","type":"object","required":["message_id","connection_id","action_id"],"properties":{"message_id":{"type":"string","minLength":1,"maxLength":255,"description":"Primary key of a message in Talkdesk Digital Channel."},"connection_id":{"type":"string","minLength":1,"maxLength":255,"description":"The unique identifier of the connection to execute."},"action_id":{"type":"string","minLength":1,"maxLength":255,"description":"The unique identifier of the action to perform on the connection."},"contact_attributes":{"type":"object","description":"Optional contact attributes to pass to the connection action.","additionalProperties":{"type":"string","minLength":1,"maxLength":255}}}},"example":{"message_id":"f4c5c1c71a3e4a679b3e8c23f2d0d5a1","connection_id":"9f8e7d6c5b4a3210fedcba9876543210","action_id":"a1b2c3d4e5f6478a9b0c1d2e3f4a5b6c","contact_attributes":{}}}}},"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":"1540000","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":"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"}}}}}},"options":{"summary":"Get allowed methods for the connection execution endpoint","description":"Returns the allowed HTTP methods for the connection execution endpoint.","operationId":"ConnectionExecutionOptions","x-internal":true,"tags":["DCE Tracking"],"responses":{"204":{"description":"No Content","headers":{"Allow":{"schema":{"type":"string","example":"POST, OPTIONS"}}}},"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":"1540001","message":"Not Found"}}}}}}},"/outbound/notifications":{"post":{"tags":["Outbound Notifications API"],"summary":"Send outbound notification messages","description":"Send outbound notification messages at scale through multiple channels (WhatsApp, SMS), utilizing various message types. The request body is polymorphic — the `channel` field determines which message schema applies. WhatsApp supports rich media content and template messages; SMS supports plain text body messages.\n","operationId":"SendOutboundNotificationMessage","x-internal":true,"security":[{"EarlyAccess":["outbound-notifications:write"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["channel","sender","messages"],"discriminator":{"propertyName":"channel"},"oneOf":[{"type":"object","required":["channel","sender","messages"],"properties":{"channel":{"type":"string","description":"Channel to send the message through","enum":["WHATSAPP"]},"sender":{"type":"string","description":"WhatsApp Business sender identifier (phone number)","minLength":1,"maxLength":255},"messages":{"type":"array","items":{"type":"object","required":["destinations"],"oneOf":[{"required":["content"]},{"required":["template"]}],"properties":{"destinations":{"type":"array","description":"Message destinations","items":{"type":"object","required":["to"],"properties":{"to":{"type":"string","description":"Recipient destination identifier (phone number, email, etc.)","minLength":1,"maxLength":255},"message_id":{"type":"string","description":"Optional client-provided message ID for tracking","minLength":1,"maxLength":100}}},"minItems":1},"content":{"type":"object","required":["body"],"properties":{"body":{"oneOf":[{"type":"object","required":["text","type"],"properties":{"type":{"type":"string","minLength":1,"enum":["TEXT"]},"text":{"type":"string","description":"Message text content","minLength":1,"maxLength":4096}}},{"type":"object","required":["url","type"],"properties":{"type":{"type":"string","minLength":1,"enum":["IMAGE"]},"url":{"type":"string","description":"URL of the media file","format":"uri","minLength":1,"maxLength":2048},"text":{"type":"string","description":"Optional text associated with the image","minLength":1,"maxLength":1024}}}]}}},"template":{"type":"object","description":"Template message details that differ by channel","oneOf":[{"type":"object","description":"Template message details with optional parameters","required":["name","language"],"properties":{"name":{"type":"string","description":"Template name","minLength":1,"maxLength":512},"language":{"type":"string","description":"Template language code (e.g., \"en\")","minLength":1},"variables":{"type":"object","additionalProperties":{"type":"string","minLength":1,"maxLength":4096},"description":"Template variables by numeric key","example":{"1":"Jane","2":"Doe"}}}}]}}},"description":"Array of WhatsApp messages to send","minItems":1,"maxItems":500},"options":{"type":"object","description":"Options for WhatsApp notification requests","properties":{"bulk_id":{"type":"string","description":"Optional bulk ID. If not provided, a UUID is generated.","minLength":1,"maxLength":100},"group_id":{"type":"string","description":"Optional logical group ID. If not provided, bulkId is used.","minLength":1,"maxLength":100},"group_name":{"type":"string","description":"Optional logical group name.","minLength":1,"maxLength":255},"group_info":{"type":"object","additionalProperties":{"type":"string","minLength":1,"maxLength":500},"description":"Optional metadata map for the group."},"bind_conversation":{"type":"object","description":"Conversation binding options. Only supported for WhatsApp channel. When enabled, sent messages are bound to conversations in Talkdesk.\n","properties":{"enabled":{"type":"boolean","description":"Whether to bind sent messages to conversations.","default":false},"ttl_in_minutes":{"type":"integer","description":"Optional TTL for the conversation binding in minutes. Honored only when bind_conversation.enabled is true. Valid range: 30–21600 (30 minutes to 15 days).\n","minimum":30,"maximum":21600,"nullable":true,"example":60}}}}}}},{"type":"object","required":["channel","sender","messages"],"properties":{"channel":{"type":"string","description":"Channel to send the message through","enum":["SMS"]},"sender":{"type":"string","description":"SMS sender identifier. Must be a valid SMS touchpoint registered in the Talkdesk account (phone number).\n","minLength":1,"maxLength":255},"messages":{"type":"array","items":{"type":"object","required":["destinations","body"],"properties":{"destinations":{"type":"array","description":"Message destinations","items":{"type":"object","required":["to"],"properties":{"to":{"type":"string","description":"Recipient destination identifier (phone number, email, etc.)","minLength":1,"maxLength":255},"message_id":{"type":"string","description":"Optional client-provided message ID for tracking","minLength":1,"maxLength":100}}},"minItems":1},"body":{"type":"string","description":"SMS message text content","minLength":1}}},"description":"Array of SMS messages to send","minItems":1,"maxItems":500},"options":{"type":"object","description":"Options for SMS notification requests. Note that bind_conversation is not supported for SMS.","properties":{"bulk_id":{"type":"string","description":"Optional bulk ID. If not provided, a UUID is generated.","minLength":1,"maxLength":100},"group_id":{"type":"string","description":"Optional logical group ID. If not provided, bulkId is used.","minLength":1,"maxLength":100},"group_name":{"type":"string","description":"Optional logical group name.","minLength":1,"maxLength":255},"group_info":{"type":"object","additionalProperties":{"type":"string","minLength":1,"maxLength":500},"description":"Optional metadata map for the group."}}}}}]},"examples":{"WhatsApp Image Message":{"value":{"channel":"WHATSAPP","sender":"123456789","messages":[{"destinations":[{"to":"987654321"}],"content":{"body":{"url":"https://example.com/image.jpg","type":"IMAGE","text":"Check this out"}}}]}},"WhatsApp Template Message":{"value":{"channel":"WHATSAPP","sender":"123456789","messages":[{"destinations":[{"to":"987654321","message_id":"client-msg-1"}],"template":{"name":"welcome_message","language":"en"}}]}},"WhatsApp Template Message With Parameters":{"value":{"channel":"WHATSAPP","sender":"123456789","messages":[{"destinations":[{"to":"987654321"},{"to":"5551234567"}],"template":{"name":"welcome_message","language":"en","variables":{"1":"Talkdesk","2":"Support Team"}}}],"options":{"bulk_id":"bulk-123"}}},"SMS Text Message":{"value":{"channel":"SMS","sender":"+15551234567","messages":[{"destinations":[{"to":"+15559876543"}],"body":"Your appointment is confirmed for tomorrow at 3 PM."}],"options":{"bulk_id":"sms-bulk-001"}}}}}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"type":"object","required":["bulk_id","messages"],"properties":{"bulk_id":{"type":"string","description":"Unique bulk identifier"},"messages":{"type":"array","items":{"type":"object","required":["message_id","destination","status"],"properties":{"message_id":{"type":"string","description":"Unique message identifier from the provider (Infobip, Twilio, etc.)"},"destination":{"type":"string","description":"Message destination"},"status":{"type":"string","description":"Message sending status","enum":["PENDING"]}}}}}},"example":{"bulk_id":"0f0d3c86-2355-4409-9968-ac871cdf88d0","messages":[{"message_id":"infobip-msg-id-123","destination":"987654321","status":"PENDING"}]}}}},"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"}}}}}},"example":{"code":"2140001","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":"2140002","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":"2140003","message":"Forbidden"}}}},"500":{"description":"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":"2140007","message":"Internal Server Error"}}}}}}},"/campaign/messages":{"post":{"operationId":"SendCampaignMessages","summary":"Send Bulk Campaign Messages","description":"Send a bulk campaign message, delivering it through one or more channel bindings. Currently supports the SMS and EMAIL channels.\n","x-internal":true,"security":[{"EarlyAccess":["campaign-message:write"]}],"tags":["Campaign Messages"],"parameters":[{"name":"Authorization","in":"header","description":"A token used to access the API.","required":true,"schema":{"type":"string","minLength":1,"maxLength":5000},"example":"Bearer 2pUwO0zU7PTlWXVHE6G1GDI3niEVML"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["bulk_id","campaign_id","campaign_info","callback_url","domain","bindings"],"properties":{"bulk_id":{"type":"string","minLength":1,"description":"The unique identifier for the bulk message"},"campaign_id":{"type":"string","minLength":1,"description":"The unique identifier for the campaign."},"campaign_info":{"type":"object","description":"Additional information about the campaign.","minProperties":1,"required":["campaign_name"],"properties":{"campaign_name":{"type":"string","minLength":1,"description":"The name of the campaign."}},"additionalProperties":true},"callback_url":{"type":"string","minLength":1,"format":"uri","description":"A URL to which the server will send the message result after processing the request."},"domain":{"type":"string","minLength":1,"format":"uri","description":"The base URL Talkdesk uses to invoke the Noetica API for this campaign."},"bindings":{"type":"array","minItems":1,"description":"An array containing one or more message bindings.","items":{"type":"object","required":["binding_id","record_id","prefix","record_info","channel","from","to","body","additional_info"],"properties":{"binding_id":{"type":"string","minLength":1,"description":"The unique identifier for this message binding."},"record_id":{"type":"string","minLength":1,"description":"The unique identifier for the record associated with this message."},"prefix":{"type":"string","minLength":1,"description":"A prefix used to identify the record type."},"record_info":{"type":"object","description":"Additional information about the record.","minProperties":1,"additionalProperties":true},"channel":{"type":"string","description":"The channel used to send the message. Currently only SMS and EMAIL are supported.","enum":["SMS","EMAIL"]},"additional_info":{"type":"object","description":"Additional metadata for the binding.","required":["list_id","list_name"],"properties":{"list_id":{"type":"string","minLength":1,"description":"The unique identifier of the record list this binding belongs to."},"list_name":{"type":"string","minLength":1,"description":"The name of the record list this binding belongs to."}},"additionalProperties":true},"from":{"type":"string","minLength":1,"description":"The sender identifier (e.g. phone number or alpha sender id)."},"to":{"type":"string","minLength":1,"description":"The recipient identifier (e.g. phone number)."},"subject":{"type":"string","description":"The message subject. Required (may be an empty string) when channel is EMAIL; ignored for SMS."},"body":{"type":"string","minLength":1,"description":"The message body."}}}}}},"examples":{"SMS Campaign Message":{"value":{"bulk_id":"123456789000","campaign_id":"14152020893","campaign_info":{"campaign_name":"Appointment Reminders"},"callback_url":"https://webhook.site/7939a539-4396-44a6-86ba-9bd0715ea6d9","domain":"https://webhook.site","bindings":[{"binding_id":"123456789000","record_id":"14152020893","prefix":"CUST","record_info":{"first_name":"Jane"},"channel":"SMS","from":"+123456789000","to":"+14152020893","subject":"","body":"hello","additional_info":{"list_id":"list-001","list_name":"Appointment Reminders List"}}]}},"Email Campaign Message":{"value":{"bulk_id":"123456789001","campaign_id":"14152020894","campaign_info":{"campaign_name":"Appointment Reminders"},"callback_url":"https://webhook.site/7939a539-4396-44a6-86ba-9bd0715ea6d9","domain":"https://webhook.site","bindings":[{"binding_id":"123456789001","record_id":"14152020894","prefix":"CUST","record_info":{"first_name":"Jane"},"channel":"EMAIL","from":"notifications@example.com","to":"jane.doe@example.com","subject":"Your appointment is confirmed","body":"Hello Jane, your appointment is confirmed for tomorrow at 3 PM.","additional_info":{"list_id":"list-001","list_name":"Appointment Reminders List"}}]}}}}}},"responses":{"200":{"description":"The message was accepted to be delivered","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["bulk_id","campaign_id"],"properties":{"id":{"type":"string","description":"The unique identifier for the campaign message request. Reserved for a planned response enhancement; not yet returned by the current service implementation.\n"},"bulk_id":{"type":"string"},"campaign_id":{"type":"string"},"_links":{"type":"object","description":"Reserved for a planned response enhancement; not yet returned by the current service implementation.\n","required":["self"],"properties":{"self":{"type":"object","required":["href"],"properties":{"href":{"type":"string","description":"The URI of the campaign message request"}}}}}}},"example":{"bulk_id":"123456789000","campaign_id":"14152020893"}}}},"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":"2140001","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":"2140002","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":"2140003","message":"Forbidden"}}}}}},"options":{"summary":"Campaign Messages Endpoint Options","description":"Returns the allowed HTTP methods for the campaign messages endpoint.","operationId":"CampaignMessagesOptions","tags":["Campaign Messages"],"responses":{"204":{"description":"OK","headers":{"Allow":{"schema":{"type":"string","example":"POST, OPTIONS"}}}},"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":"2140004","message":"Not Found"}}}}}}},"/industries-settings/configurations/{service}/{type}/{type_id}/filter":{"get":{"operationId":"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":{"operationId":"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 locations, services, or staff members from a CSV file","description":"Add (or update) a list of locations, services, or staff members from a CSV file. The endpoint accepts a directory_type path parameter that determines the type of directory to import. The CSV must use comma as the column separator. For pipe-separated multi-value fields, use pipe (|) as the list separator and colon (:) as the key-value separator. The CSV columns vary per type — see each section below.\n\n**locations — CSV columns**\n\n- **LOCATION_ID**\n - _optional_\n - External identifier of the location. If omitted, a random UUID is generated. Used as the upsert key.\n\n- **LOCATION_NAME**\n - _required_\n - Name of the location.\n\n- **LOCATION_ALTERNATIVE_NAMES**\n - _optional_\n - Alternative names separated by |. Example: Store A|Store B\n\n- **LOCATION_TYPE**\n - _optional_\n - Type/category of the location. Free text.\n\n- **ADDRESS_STREET**\n - _required_\n - Street address of the location.\n\n- **ADDRESS_POSTAL_CODE**\n - _required_\n - Postal/zip code of the location.\n\n- **ADDRESS_CITY**\n - _optional_\n - City of the location.\n\n- **ADDRESS_REGION**\n - _optional_\n - Region or state (country subdivision).\n\n- **COUNTRY_NAME**\n - _required_\n - Country name.\n\n- **LOCATION_PICTURE_URL**\n - _optional_\n - Public image URL. Must start with http:// or https:// and end in .jpg, .jpeg, .png, or .webp. Max 1MB, 550x220px.\n\n- **PHONE_NUMBER**\n - _optional_\n - Phone numbers. Format per entry: number:label. Multiple entries separated by |. Example: +12029182132:Main|+12029182133:Fax\n\n- **TIMEZONE**\n - _required_\n - IANA timezone ID. Example: America/Los_Angeles, Europe/Lisbon.\n\n- **BUSINESS_MON / BUSINESS_TUE / BUSINESS_WED / BUSINESS_THU / BUSINESS_FRI / BUSINESS_SAT / BUSINESS_SUN**\n - _optional_\n - Business hours per weekday. Format per slot: hh:mmAM-hh:mmPM. Multiple slots separated by |. Example: 09:00AM-01:00PM|02:00PM-05:00PM\n\n- **SPECIAL_DATES**\n - _optional_\n - JSON array of special dates/holidays. Each element has the fields name, date (yyyy-MM-dd), repeat_rule (DOES_NOT_REPEATS, MONTHLY, or YEARLY), business_hours (array of open_at/close_at in HH:mm:ss), and notes.\n\n\n---\n\n**staffs — CSV columns**\n\n- **STAFF_ID**\n - _optional_\n - External identifier of the staff member. If omitted, a random UUID is generated.\n\n- **NAME**\n - _required_\n - Full name of the staff member.\n\n- **DESCRIPTION**\n - _optional_\n - Bio or description of the staff member.\n\n- **SPECIALTIES**\n - _optional_\n - Specialties separated by |. Example: cardiology|pediatrics\n\n- **PRONOUNS**\n - _optional_\n - Pronouns. Example: she/her, he/his, they/them\n\n- **MANAGER**\n - _optional_\n - Name of the direct manager/supervisor.\n\n- **JOB_TITLE**\n - _optional_\n - Professional title. Example: Senior Cardiologist\n\n- **CONTACT**\n - _optional_\n - Contact entries separated by |. Format per entry: type:value or type:value:description. Example: phone:+12029182132:Work|email:jane@example.com:Work Email\n\n- **PHOTO_URL**\n - _optional_\n - Public photo URL. Must start with http:// or https:// and end in .jpg, .jpeg, .png, or .webp.\n\n- **GENDER**\n - _optional_\n - Gender of the staff member. Free text.\n\n- **LANGUAGES**\n - _optional_\n - Languages spoken, separated by |. Example: English|Spanish\n\n- **DATE_OF_BIRTH**\n - _optional_\n - Date of birth. Format: yyyy-MM-dd or yyyy/MM/dd. Example: 1980-05-15\n\n- **EMPLOYMENT_START_DATE**\n - _optional_\n - Date of hire. Format: yyyy-MM-dd or yyyy/MM/dd. Example: 2018-03-01\n\n- **LOCATION_AND_SERVICE_NAMES**\n - _optional_\n - Location/service relationships separated by |. Format per entry: locationExternalId:serviceExternalId. Either part may be empty (e.g. :serviceId or locationId:). Both IDs must exist for the account, and the service must belong to the referenced location. Example: loc-id-1:svc-id-1|loc-id-2:\n\n- **VISIT_TYPES**\n - _optional_\n - Visit types separated by |. Format per entry: id:name. Example: in-person:In-Person|virtual:Virtual\n\n- **TAGS**\n - _optional_\n - JSON array of tag objects. Each element has the fields tag_name, background_color, and text_color (hex). Example: [{\"tag_name\":\"VIP\",\"background_color\":\"#EFDBFF\",\"text_color\":\"#391085\"}]\n\n\n---\n\n**services — CSV columns**\n\n- **SERVICE_ID**\n - _optional_\n - External identifier of the service. If omitted, a random UUID is generated.\n\n- **SERVICE_NAME**\n - _required_\n - Name of the service.\n\n- **DESCRIPTION**\n - _required_\n - Description of the service.\n\n- **SERVICE_TYPE**\n - _optional_\n - Type/category of the service. Free text.\n\n- **DURATION**\n - _optional_\n - Duration of the service. Free text. Example: 30-45 minutes\n\n- **VIRTUAL_LOCATION_URL**\n - _optional_\n - URL for virtual/online appointments.\n\n- **PRICE**\n - _optional_\n - Price of the service. Free text. Example: 50$, Free\n\n- **PHONE_NUMBER**\n - _optional_\n - Phone numbers. Format per entry: number:label. Multiple entries separated by |. Example: +12029182132:Appointments\n\n- **TIMEZONE**\n - _optional — required when any BUSINESS_* column or SPECIAL_DATES is provided_\n - IANA timezone ID. Example: Europe/Lisbon.\n\n- **BUSINESS_MON / BUSINESS_TUE / BUSINESS_WED / BUSINESS_THU / BUSINESS_FRI / BUSINESS_SAT / BUSINESS_SUN**\n - _optional_\n - Business hours per weekday. Format per slot: hh:mmAM-hh:mmPM. Multiple slots separated by |. Example: 09:00AM-01:00PM|02:00PM-05:00PM\n\n- **LOCATIONS**\n - _optional_\n - External IDs of associated locations separated by |. Each ID must exist for the account. Example: loc-ext-id-1|loc-ext-id-2\n\n- **SPECIAL_DATES**\n - _optional_\n - JSON array of special dates/holidays. Each element has the fields name, date (yyyy-MM-dd), repeat_rule (DOES_NOT_REPEATS, MONTHLY, or YEARLY), business_hours (array of open_at/close_at in HH:mm:ss), and notes.\n","operationId":"publicUploadLocationsDirectory","security":[{"GA":["locations-directory-bulk-operation:write"]}],"parameters":[{"name":"directory_type","in":"path","description":"The directory type to import.","required":true,"schema":{"type":"string","minLength":1,"enum":["locations","services","staffs"],"example":"locations"}}],"requestBody":{"description":"CSV file with directory data. The columns vary depending on the directory_type — see the endpoint description above for the full column reference for each type.\n","required":true,"content":{"multipart/form-data":{"schema":{"type":"object","required":["file"],"properties":{"file":{"type":"string","format":"binary","description":"CSV file with the rows to import. The accepted columns depend on the `directory_type` path parameter:\n- `locations` — see the locations CSV column reference in the endpoint description.\n- `staffs` — see the staffs CSV column reference in the endpoint description.\n- `services` — see the services CSV column reference in the endpoint description.\n"}}},"examples":{"locations":{"summary":"Locations CSV example","value":{"file":"LOCATION_ID,LOCATION_NAME,LOCATION_ALTERNATIVE_NAMES,LOCATION_TYPE,ADDRESS_STREET,ADDRESS_POSTAL_CODE,ADDRESS_CITY,ADDRESS_REGION,COUNTRY_NAME,PHONE_NUMBER,TIMEZONE,BUSINESS_MON,BUSINESS_TUE,BUSINESS_WED,BUSINESS_THU,BUSINESS_FRI,BUSINESS_SAT,BUSINESS_SUN,SPECIAL_DATES\n123,South Lyon,Southside|SL,Store,796 Hillcrest Ave,48178,Los Angeles,California,United States,+12029182132:Main,America/Los_Angeles,09:00-17:00,09:00-17:00,09:00-17:00,09:00-17:00,09:00-17:00,,,\"[{\"\"name\"\":\"\"Labor Day\"\",\"\"date\"\":\"\"2025-09-01\"\",\"\"business_hours\"\":[]}]\"\n"}},"staffs":{"summary":"Staffs CSV example","value":{"file":"STAFF_ID,NAME,DESCRIPTION,SPECIALTIES,PRONOUNS,MANAGER,JOB_TITLE,CONTACT,PHOTO_URL,GENDER,LANGUAGES,DATE_OF_BIRTH,EMPLOYMENT_START_DATE,LOCATION_AND_SERVICE_NAMES,VISIT_TYPES,TAGS\n3,Jane Smith,Cardiologist,cardiology|pediatrics,she/her,Dr. Johnson,Senior Cardiologist,phone:+12029182132:Work,https://example.com/p.jpg,Female,English|Spanish,1980-05-15,2018-03-01,loc-id-1:svc-id-1,in-person:In-Person,\"[{\"\"tag_name\"\":\"\"VIP\"\",\"\"background_color\"\":\"\"#EFDBFF\"\"}]\"\n"}},"services":{"summary":"Services CSV example","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\nsvc-001,Cardiology Consult,In-Person,45 minutes,Consultation with a cardiologist,,50$,+12029182132:Appointments,America/New_York,09:00-17:00,09:00-17:00,09:00-17:00,09:00-17:00,09:00-17:00,,,loc-ext-id-1,\"[{\"\"name\"\":\"\"Christmas\"\",\"\"date\"\":\"\"2025-12-25\"\",\"\"business_hours\"\":[]}]\"\n"}}}}}},"responses":{"202":{"description":"The file has been accepted and will be processed asynchronously."},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"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":"2552"}},{"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."}}}}}}}}},"/healthcare/guarantors/{guarantor_id}/billing":{"get":{"tags":["HLS Providers"],"summary":"Get guarantor billing summary","description":"Returns the billing summary for a guarantor, including balance details, aging summaries, payment plan information, and associated patient records. At least one of `patient_id` or `self_service_id` must be provided.","operationId":"getGuarantorBillingSummary","security":[{"GA":["hls-guarantor-billing:read"]}],"parameters":[{"name":"guarantor_id","in":"path","required":true,"description":"Unique identifier of the guarantor whose billing summary is being retrieved.","schema":{"type":"string","minLength":1,"example":"2552"}},{"name":"patient_id","in":"query","required":false,"description":"Patient identifier. At least one of `patient_id` or `self_service_id` must be provided.","schema":{"type":"string","minLength":1,"example":"enh2Q1c0oNRtWzXZrnG4tKw3"}},{"name":"self_service_id","in":"query","required":false,"description":"Self-service identifier. At least one of `patient_id` or `self_service_id` must be provided.","schema":{"type":"string","minLength":1,"example":"SSI123456"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","description":"Billing summary for a guarantor account.","required":["id"],"properties":{"id":{"type":"string","description":"The unique identifier of the guarantor.","example":"2552"},"account_ids":{"type":"array","description":"List of EHR identifiers for the guarantor account.","items":{"type":"object","description":"An identifier with a type label.","required":["id","type"],"properties":{"id":{"type":"string","description":"Identifier value.","example":"E100001"},"type":{"type":"string","description":"Identifier type (e.g., EPI, MRN, CSN).","example":"EPI"}}}},"account_type":{"description":"The type of the guarantor account.","type":"object","properties":{"abbreviation":{"type":"string","description":"Short abbreviation for the category.","example":"P"},"number":{"type":"string","description":"Numeric code for the category.","example":"1"},"title":{"type":"string","description":"Full title of the category.","example":"Patient"}}},"billing_system":{"type":"string","description":"The billing system used for this account.","example":"Epic"},"credit_score":{"type":"string","description":"Credit score associated with the guarantor account.","example":"750"},"is_confidential_guarantor":{"type":"boolean","description":"Whether the guarantor is marked as confidential."},"is_paperless":{"type":"boolean","description":"Whether the guarantor is enrolled in paperless billing."},"owning_deployment_descriptor":{"type":"string","description":"Epic deployment descriptor that owns this account.","example":"MAIN"},"patient_is_guarantor":{"type":"boolean","description":"Whether the patient is also the guarantor."},"patients":{"type":"array","description":"List of patients associated with this guarantor account.","items":{"type":"object","description":"A patient associated with a guarantor billing account.","properties":{"date_of_birth":{"type":"string","format":"date","description":"Date of birth of the patient (yyyy-MM-dd).","example":"1980-04-15"},"legal_name":{"type":"string","description":"Legal name of the patient (Last, First format).","example":"Doe, John"},"preferred_name":{"type":"string","description":"Preferred name of the patient.","example":"John"},"legal_sex":{"description":"Legal sex of the patient.","type":"object","properties":{"abbreviation":{"type":"string","description":"Short abbreviation for the category.","example":"P"},"number":{"type":"string","description":"Numeric code for the category.","example":"1"},"title":{"type":"string","description":"Full title of the category.","example":"Patient"}}},"gender_identity":{"type":"string","description":"Gender identity of the patient.","example":"Male"},"ids":{"type":"array","description":"List of EHR identifiers for the patient.","items":{"type":"object","description":"An identifier with a type label.","required":["id","type"],"properties":{"id":{"type":"string","description":"Identifier value.","example":"E100001"},"type":{"type":"string","description":"Identifier type (e.g., EPI, MRN, CSN).","example":"EPI"}}}}}}},"professional_billing":{"description":"Professional (physician) billing section.","type":"object","properties":{"aging_summaries":{"type":"array","description":"List of aging bucket entries.","items":{"type":"object","description":"A single aging bucket entry.","properties":{"amount":{"type":"number","format":"double","description":"Balance amount for this aging bucket."},"display":{"type":"string","description":"Human-readable label for the aging bucket.","example":"0-30 days"}}}},"balance_summary":{"description":"Summary of balances for this billing section.","type":"object","properties":{"amount_due":{"type":"number","format":"double","description":"Total amount currently due."},"balance_not_on_payment_plan":{"type":"number","format":"double","description":"Balance not included in a payment plan."},"balance_on_payment_plan":{"type":"number","format":"double","description":"Balance covered by an active payment plan."},"charge_total":{"type":"number","format":"double","description":"Total charges."},"insurance_balance":{"type":"number","format":"double","description":"Balance owed by insurance."},"insurance_payment_adjustment_total":{"type":"number","format":"double","description":"Total insurance payment adjustments."},"patient_balance":{"type":"number","format":"double","description":"Balance owed by the patient."},"patient_payment_adjustment_total":{"type":"number","format":"double","description":"Total patient payment adjustments."},"total_balance":{"type":"number","format":"double","description":"Combined patient and insurance balance."}}},"last_payment":{"description":"Details of the most recent payment.","type":"object","properties":{"amount":{"type":"number","format":"double","description":"Payment amount."},"date":{"type":"string","format":"date","description":"Date the payment was made (yyyy-MM-dd).","example":"2026-03-01"},"description":{"type":"array","description":"Description of the payment.","example":["Patient payment"],"items":{"type":"string"}},"source":{"type":"string","description":"Source of the payment (e.g., Patient, Insurance)."},"code":{"type":"string","description":"Payment code."},"reference_number":{"type":"string","description":"Reference number for the payment."}}},"last_statement":{"description":"Details of the most recent billing statement.","type":"object","properties":{"balance":{"type":"number","format":"double","description":"Balance on the last statement."},"date":{"type":"string","format":"date","description":"Date the statement was issued (yyyy-MM-dd).","example":"2026-02-15"},"type":{"description":"Type of the statement.","type":"object","properties":{"abbreviation":{"type":"string","description":"Short abbreviation for the category.","example":"P"},"number":{"type":"string","description":"Numeric code for the category.","example":"1"},"title":{"type":"string","description":"Full title of the category.","example":"Patient"}}},"view_status":{"type":"string","description":"Indicates whether the statement has been viewed.","example":"Viewed"}}},"message":{"type":"string","description":"Optional message associated with this billing section."},"outstanding_account":{"description":"Outstanding account balance details. Populated for hospital billing and single billing office sections.","type":"object","properties":{"bad_debt_balance":{"type":"number","format":"double","description":"Balance in bad debt."},"insurance_balance":{"type":"number","format":"double","description":"Balance owed by insurance."},"last_self_pay_payment_date":{"type":"string","format":"date","description":"Date of the last self-pay payment (yyyy-MM-dd).","example":"2026-03-15"},"last_statement_date":{"type":"string","format":"date","description":"Date of the last statement (yyyy-MM-dd).","example":"2026-02-28"},"patient_balance":{"type":"number","format":"double","description":"Balance owed by the patient."},"self_pay_followup_level":{"description":"Follow-up level for self-pay collections.","type":"object","properties":{"abbreviation":{"type":"string","description":"Short abbreviation for the category.","example":"P"},"number":{"type":"string","description":"Numeric code for the category.","example":"1"},"title":{"type":"string","description":"Full title of the category.","example":"Patient"}}},"total_balance":{"type":"number","format":"double","description":"Total outstanding balance."}}},"payment_plan":{"description":"Active payment plan details, if any.","type":"object","properties":{"amount_due":{"type":"number","format":"double","description":"Current amount due under the payment plan."},"monthly_amount_due":{"type":"number","format":"double","description":"Monthly payment amount."},"next_due_date":{"type":"string","format":"date","description":"Date the next payment is due (yyyy-MM-dd).","example":"2026-05-01"},"number_of_payments_left":{"type":"string","description":"Number of remaining payments.","example":"6"},"original_amount":{"type":"number","format":"double","description":"Original total amount of the payment plan."},"remaining_amount":{"type":"number","format":"double","description":"Remaining balance of the payment plan."},"start_date":{"type":"string","format":"date","description":"Date the payment plan started (yyyy-MM-dd).","example":"2025-11-01"},"is_late":{"type":"boolean","description":"Whether the payment plan is past due."},"overdue_amount":{"type":"number","format":"double","description":"Amount overdue on the payment plan."}}}}},"hospital_billing":{"description":"Hospital billing section.","type":"object","properties":{"aging_summaries":{"type":"array","description":"List of aging bucket entries.","items":{"type":"object","description":"A single aging bucket entry.","properties":{"amount":{"type":"number","format":"double","description":"Balance amount for this aging bucket."},"display":{"type":"string","description":"Human-readable label for the aging bucket.","example":"0-30 days"}}}},"balance_summary":{"description":"Summary of balances for this billing section.","type":"object","properties":{"amount_due":{"type":"number","format":"double","description":"Total amount currently due."},"balance_not_on_payment_plan":{"type":"number","format":"double","description":"Balance not included in a payment plan."},"balance_on_payment_plan":{"type":"number","format":"double","description":"Balance covered by an active payment plan."},"charge_total":{"type":"number","format":"double","description":"Total charges."},"insurance_balance":{"type":"number","format":"double","description":"Balance owed by insurance."},"insurance_payment_adjustment_total":{"type":"number","format":"double","description":"Total insurance payment adjustments."},"patient_balance":{"type":"number","format":"double","description":"Balance owed by the patient."},"patient_payment_adjustment_total":{"type":"number","format":"double","description":"Total patient payment adjustments."},"total_balance":{"type":"number","format":"double","description":"Combined patient and insurance balance."}}},"last_payment":{"description":"Details of the most recent payment.","type":"object","properties":{"amount":{"type":"number","format":"double","description":"Payment amount."},"date":{"type":"string","format":"date","description":"Date the payment was made (yyyy-MM-dd).","example":"2026-03-01"},"description":{"type":"array","description":"Description of the payment.","example":["Patient payment"],"items":{"type":"string"}},"source":{"type":"string","description":"Source of the payment (e.g., Patient, Insurance)."},"code":{"type":"string","description":"Payment code."},"reference_number":{"type":"string","description":"Reference number for the payment."}}},"last_statement":{"description":"Details of the most recent billing statement.","type":"object","properties":{"balance":{"type":"number","format":"double","description":"Balance on the last statement."},"date":{"type":"string","format":"date","description":"Date the statement was issued (yyyy-MM-dd).","example":"2026-02-15"},"type":{"description":"Type of the statement.","type":"object","properties":{"abbreviation":{"type":"string","description":"Short abbreviation for the category.","example":"P"},"number":{"type":"string","description":"Numeric code for the category.","example":"1"},"title":{"type":"string","description":"Full title of the category.","example":"Patient"}}},"view_status":{"type":"string","description":"Indicates whether the statement has been viewed.","example":"Viewed"}}},"message":{"type":"string","description":"Optional message associated with this billing section."},"outstanding_account":{"description":"Outstanding account balance details. Populated for hospital billing and single billing office sections.","type":"object","properties":{"bad_debt_balance":{"type":"number","format":"double","description":"Balance in bad debt."},"insurance_balance":{"type":"number","format":"double","description":"Balance owed by insurance."},"last_self_pay_payment_date":{"type":"string","format":"date","description":"Date of the last self-pay payment (yyyy-MM-dd).","example":"2026-03-15"},"last_statement_date":{"type":"string","format":"date","description":"Date of the last statement (yyyy-MM-dd).","example":"2026-02-28"},"patient_balance":{"type":"number","format":"double","description":"Balance owed by the patient."},"self_pay_followup_level":{"description":"Follow-up level for self-pay collections.","type":"object","properties":{"abbreviation":{"type":"string","description":"Short abbreviation for the category.","example":"P"},"number":{"type":"string","description":"Numeric code for the category.","example":"1"},"title":{"type":"string","description":"Full title of the category.","example":"Patient"}}},"total_balance":{"type":"number","format":"double","description":"Total outstanding balance."}}},"payment_plan":{"description":"Active payment plan details, if any.","type":"object","properties":{"amount_due":{"type":"number","format":"double","description":"Current amount due under the payment plan."},"monthly_amount_due":{"type":"number","format":"double","description":"Monthly payment amount."},"next_due_date":{"type":"string","format":"date","description":"Date the next payment is due (yyyy-MM-dd).","example":"2026-05-01"},"number_of_payments_left":{"type":"string","description":"Number of remaining payments.","example":"6"},"original_amount":{"type":"number","format":"double","description":"Original total amount of the payment plan."},"remaining_amount":{"type":"number","format":"double","description":"Remaining balance of the payment plan."},"start_date":{"type":"string","format":"date","description":"Date the payment plan started (yyyy-MM-dd).","example":"2025-11-01"},"is_late":{"type":"boolean","description":"Whether the payment plan is past due."},"overdue_amount":{"type":"number","format":"double","description":"Amount overdue on the payment plan."}}}}},"single_billing_office":{"description":"Single billing office section, when combined billing applies.","type":"object","properties":{"aging_summaries":{"type":"array","description":"List of aging bucket entries.","items":{"type":"object","description":"A single aging bucket entry.","properties":{"amount":{"type":"number","format":"double","description":"Balance amount for this aging bucket."},"display":{"type":"string","description":"Human-readable label for the aging bucket.","example":"0-30 days"}}}},"balance_summary":{"description":"Summary of balances for this billing section.","type":"object","properties":{"amount_due":{"type":"number","format":"double","description":"Total amount currently due."},"balance_not_on_payment_plan":{"type":"number","format":"double","description":"Balance not included in a payment plan."},"balance_on_payment_plan":{"type":"number","format":"double","description":"Balance covered by an active payment plan."},"charge_total":{"type":"number","format":"double","description":"Total charges."},"insurance_balance":{"type":"number","format":"double","description":"Balance owed by insurance."},"insurance_payment_adjustment_total":{"type":"number","format":"double","description":"Total insurance payment adjustments."},"patient_balance":{"type":"number","format":"double","description":"Balance owed by the patient."},"patient_payment_adjustment_total":{"type":"number","format":"double","description":"Total patient payment adjustments."},"total_balance":{"type":"number","format":"double","description":"Combined patient and insurance balance."}}},"last_payment":{"description":"Details of the most recent payment.","type":"object","properties":{"amount":{"type":"number","format":"double","description":"Payment amount."},"date":{"type":"string","format":"date","description":"Date the payment was made (yyyy-MM-dd).","example":"2026-03-01"},"description":{"type":"array","description":"Description of the payment.","example":["Patient payment"],"items":{"type":"string"}},"source":{"type":"string","description":"Source of the payment (e.g., Patient, Insurance)."},"code":{"type":"string","description":"Payment code."},"reference_number":{"type":"string","description":"Reference number for the payment."}}},"last_statement":{"description":"Details of the most recent billing statement.","type":"object","properties":{"balance":{"type":"number","format":"double","description":"Balance on the last statement."},"date":{"type":"string","format":"date","description":"Date the statement was issued (yyyy-MM-dd).","example":"2026-02-15"},"type":{"description":"Type of the statement.","type":"object","properties":{"abbreviation":{"type":"string","description":"Short abbreviation for the category.","example":"P"},"number":{"type":"string","description":"Numeric code for the category.","example":"1"},"title":{"type":"string","description":"Full title of the category.","example":"Patient"}}},"view_status":{"type":"string","description":"Indicates whether the statement has been viewed.","example":"Viewed"}}},"message":{"type":"string","description":"Optional message associated with this billing section."},"outstanding_account":{"description":"Outstanding account balance details. Populated for hospital billing and single billing office sections.","type":"object","properties":{"bad_debt_balance":{"type":"number","format":"double","description":"Balance in bad debt."},"insurance_balance":{"type":"number","format":"double","description":"Balance owed by insurance."},"last_self_pay_payment_date":{"type":"string","format":"date","description":"Date of the last self-pay payment (yyyy-MM-dd).","example":"2026-03-15"},"last_statement_date":{"type":"string","format":"date","description":"Date of the last statement (yyyy-MM-dd).","example":"2026-02-28"},"patient_balance":{"type":"number","format":"double","description":"Balance owed by the patient."},"self_pay_followup_level":{"description":"Follow-up level for self-pay collections.","type":"object","properties":{"abbreviation":{"type":"string","description":"Short abbreviation for the category.","example":"P"},"number":{"type":"string","description":"Numeric code for the category.","example":"1"},"title":{"type":"string","description":"Full title of the category.","example":"Patient"}}},"total_balance":{"type":"number","format":"double","description":"Total outstanding balance."}}},"payment_plan":{"description":"Active payment plan details, if any.","type":"object","properties":{"amount_due":{"type":"number","format":"double","description":"Current amount due under the payment plan."},"monthly_amount_due":{"type":"number","format":"double","description":"Monthly payment amount."},"next_due_date":{"type":"string","format":"date","description":"Date the next payment is due (yyyy-MM-dd).","example":"2026-05-01"},"number_of_payments_left":{"type":"string","description":"Number of remaining payments.","example":"6"},"original_amount":{"type":"number","format":"double","description":"Original total amount of the payment plan."},"remaining_amount":{"type":"number","format":"double","description":"Remaining balance of the payment plan."},"start_date":{"type":"string","format":"date","description":"Date the payment plan started (yyyy-MM-dd).","example":"2025-11-01"},"is_late":{"type":"boolean","description":"Whether the payment plan is past due."},"overdue_amount":{"type":"number","format":"double","description":"Amount overdue on the payment plan."}}}}},"propensity_to_pay":{"description":"Propensity-to-pay category value for the guarantor.","type":"object","properties":{"abbreviation":{"type":"string","description":"Short abbreviation for the category.","example":"P"},"number":{"type":"string","description":"Numeric code for the category.","example":"1"},"title":{"type":"string","description":"Full title of the category.","example":"Patient"}}},"service_area":{"description":"The service area associated with the guarantor.","type":"object","properties":{"name":{"type":"string","description":"Name of the service area.","example":"Main Campus"},"ids":{"type":"array","description":"List of identifiers for the service area.","items":{"type":"object","description":"An identifier with a type label.","required":["id","type"],"properties":{"id":{"type":"string","description":"Identifier value.","example":"E100001"},"type":{"type":"string","description":"Identifier type (e.g., EPI, MRN, CSN).","example":"EPI"}}}}}}}},"examples":{"Guarantor billing summary":{"value":{"id":"2552","account_ids":[{"id":"E100001","type":"EPI"}],"account_type":{"abbreviation":"P","number":"1","title":"Patient"},"billing_system":"Epic","credit_score":"750","is_confidential_guarantor":false,"is_paperless":true,"owning_deployment_descriptor":"MAIN","patient_is_guarantor":true,"patients":[{"date_of_birth":"1980-04-15","legal_name":"Doe, John","preferred_name":"John","legal_sex":{"abbreviation":"M","number":"1","title":"Male"},"gender_identity":"Male","ids":[{"id":"MRN12345","type":"MRN"}]}],"professional_billing":{"aging_summaries":[{"amount":150,"display":"0-30 days"},{"amount":0,"display":"31-60 days"}],"balance_summary":{"amount_due":150,"balance_not_on_payment_plan":150,"balance_on_payment_plan":0,"charge_total":200,"insurance_balance":0,"insurance_payment_adjustment_total":50,"patient_balance":150,"patient_payment_adjustment_total":0,"total_balance":150},"last_payment":{"amount":50,"date":"2026-03-01","description":["Patient payment"],"source":"Patient","code":"PMNT","reference_number":"REF001"},"last_statement":{"balance":200,"date":"2026-02-15","type":{"abbreviation":"R","number":"2","title":"Regular"},"view_status":"Viewed"}},"hospital_billing":{"aging_summaries":[{"amount":300,"display":"0-30 days"}],"balance_summary":{"amount_due":300,"patient_balance":250,"total_balance":300},"outstanding_account":{"bad_debt_balance":0,"insurance_balance":50,"last_self_pay_payment_date":"2026-03-15","last_statement_date":"2026-02-28","patient_balance":250,"self_pay_followup_level":{"abbreviation":"L1","number":"1","title":"Level 1"},"total_balance":300}},"propensity_to_pay":{"abbreviation":"H","number":"3","title":"High"},"service_area":{"name":"Main Campus","ids":[{"id":"SA001","type":"Internal"}]}}}}}}},"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/{guarantor_id}/password-reset":{"post":{"tags":["HLS Providers"],"summary":"Reset guarantor password","description":"Send a password reset request to the guarantor's healthcare portal (e.g., MyChart).\nThis is a provider-agnostic endpoint that works across different EHR systems.\n\n**Prerequisites:**\n- A guarantor lookup must be performed first within the same interaction\n- The guarantor must have a healthcare portal account (e.g., MyChart) configured\n","operationId":"resetGuarantorPassword","security":[{"GA":["hls-guarantor-password-reset:write"]}],"parameters":[{"name":"guarantor_id","description":"The guarantor 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":["delivery_method"],"properties":{"delivery_method":{"type":"string","description":"The delivery method for the password reset link.","enum":["EMAIL","SMS"]}}},"example":{"delivery_method":"EMAIL"}}}},"responses":{"204":{"description":"No Content - Password reset request has been successfully submitted"},"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":{"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."}},"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."}}}}}},"424":{"description":"Failed Dependency - The upstream EHR provider returned an 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":{"Upstream Error":{"value":{"code":"1485020","message":"Upstream Error."}}}}}},"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"}}}}}},"examples":{"Too Many Requests":{"value":{"code":"1484290","message":"Too many requests."}}}}}},"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"}}}}}}}}}}}},"/provisioning/account/licenses":{"get":{"operationId":"GetAccountLicenses","summary":"Get account licenses","description":"Get the account licenses","x-internal":true,"security":[{"EarlyAccess":["licenses:read"]}],"tags":["Licenses 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 licenses per page. Defaults to 50.","required":false,"schema":{"type":"integer","minimum":1,"maximum":50,"default":50}},{"in":"query","name":"revision_status","description":"It allows filtering licenses based on the current revision status. Options:\n * `active` - Matches the revision licenses that are currently active. Current *datetime* is between *start_date* and *end_date* of a license.\n * `last` - Matches the licenses that have the higher revision.\n * `upcoming` - Matches revision licenses that will become active. Current *datetime* is before *start_date* of a licenses.\n * `all` - Matches all licenses\n","required":false,"schema":{"type":"string","default":"all","enum":["active","last","upcoming","all"]}},{"in":"query","name":"expand","description":"Enriches the response with additional product information","required":false,"schema":{"type":"boolean","default":false}},{"in":"query","name":"deleted","description":"Allows to include deleted license revisions. Not compatible with `active` value of **revision_status** query parameter","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Return a licenses list","content":{"application/json":{"schema":{"type":"object","required":["page","per_page","count","total","_links","_embedded"],"properties":{"page":{"type":"integer","description":"The current page","minimum":1,"maximum":1000000},"per_page":{"type":"integer","description":"The number of elements of licenses per Page","minimum":1,"maximum":50},"count":{"type":"integer","description":"The number of licenses present in the current Page","minimum":0,"maximum":1000000},"total":{"type":"integer","description":"The total number of licenses","minimum":0,"maximum":1000000},"_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":["licenses"],"properties":{"licenses":{"type":"array","description":"the results displayed in an array","items":{"allOf":[{"type":"object","required":["id","license_id","account_id","product_id","pricing","quantity","start_date","end_date","revision_start_date","revision","attributes","created_at"],"properties":{"id":{"type":"string","description":"Unique identifier for the license revision. Automatically generated."},"license_id":{"type":"string","description":"Uniquely identifies the acquisition of a specific product by a customer within an account."},"account_id":{"type":"string","description":"Talkdesk account identifier (Talkdesk ID)."},"product_id":{"type":"string","description":"Unique identifier of a product and the set of technical artifacts associated with it."},"pricing":{"type":"object","description":"The acquisition price for the specific product for this specific license revision. Could include amount and currency. (not used at the moment)"},"quantity":{"type":"integer","description":"Number of licenses acquired (also referred as seats in named model, and installations for apps).","minimum":0,"maximum":1000000},"start_date":{"type":"string","format":"date-time","description":"The date in which the account will be entitled to use this product."},"end_date":{"type":"string","format":"date-time","description":"The date in which the account will cease to be entitled to use this license."},"revision_start_date":{"type":"string","format":"date-time","description":"The moment in time this licenses revision becomes effective. From this date forward this license revision and all the properties it defines are effective. Each time a change is made for a specific license it creates a revision. This field is the date on which changes will be effective. Allows to perform changes in the future.\n"},"revision":{"type":"integer","description":"Revision is an incremental number that represents a version of the same license (same license_id). For every change made in this object the revision will be automatically incremented.","minimum":0,"maximum":1000000},"attributes":{"type":"object","description":"Metadata or extra properties that we want to assign to a specific License Revision."},"created_at":{"type":"string","format":"date-time"}}},{"type":"object","properties":{"_embedded":{"type":"object","required":["seats_in_use"],"properties":{"seats_in_use":{"type":"integer","description":"Total seats being used in a license","minimum":0,"maximum":1000000},"product":{"type":"object","description":"Product info","required":["id","name","family","manageable"],"properties":{"id":{"type":"string","description":"The unique identifier of a product on the Product Catalog Mapper."},"name":{"type":"string","description":"The name of the product."},"family":{"type":"string","description":"The family this product belongs to.","enum":["License","Add-On","Partner","Standalone"]},"model":{"type":"string","description":"The license model associated with the product.","enum":["Named"]},"manageable":{"type":"boolean","description":"Indicates if the seat manager is enabled for this product."},"apps":{"type":"array","description":"A dictionary array that represents an app installation is triggered whenever a license is provisioned for this product.","items":{"type":"object","required":["app_id","subscription_id"],"properties":{"app_id":{"type":"string","description":"The app identifier in app-connect (marketplace)"},"subscription_id":{"type":"string","description":"The subscription plan identifier to be used for the installation of the app"}}}},"connectors":{"type":"array","description":"An array of objects that contains all the connectors associated with this product.","items":{"type":"object","properties":{"type":{"type":"string","description":"Connector associated with a product."}}}}}}}}}}]}}}}}},"examples":{"Licenses without expand":{"value":{"page":2,"per_page":3,"count":3,"total":12,"_links":{"self":{"href":"https://api-docs.talkdesk.org/provisioning/account/licenses?page=2&per_page=3&revision_status=ALL"},"first":{"href":"https://api-docs.talkdesk.org/provisioning/account/licenses?page=1&per_page=3&revision_status=ALL"},"prev":{"href":"https://api-docs.talkdesk.org/provisioning/account/licenses?page=1&per_page=3&revision_status=ALL"},"next":{"href":"https://api-docs.talkdesk.org/provisioning/account/licenses?page=3&per_page=3&revision_status=ALL"},"last":{"href":"https://api-docs.talkdesk.org/provisioning/account/licenses?page=4&per_page=3&revision_status=ALL"}},"_embedded":{"licenses":[{"id":"56u780e37820b0c32dea550","license_id":"76a657e37820b0c32dea630","account_id":"608180e37820b0e474dea550","product_id":"118180a57832b0e474fda900","pricing":{"price":1212,"currency":"USD"},"quantity":1,"start_date":"2022-01-01T00:00:00.000Z","end_date":"2023-01-01T00:00:00.000Z","revision_start_date":"2022-03-01T00:00:00.000Z","revision":2,"attributes":{"free_units":100},"created_at":"2021-01-01T07:13:00.000Z"},{"id":"99u780e44563b0a32dea550","license_id":"79a657e37820b0c32dea330","account_id":"608180e37820b0e474dea550","product_id":"118180a32r322b0e474bce444","pricing":{"price":2000,"currency":"USD"},"quantity":5,"start_date":"2022-01-01T00:00:00.000Z","end_date":"2023-01-01T00:00:00.000Z","revision_start_date":"2022-06-19T00:00:00.000Z","revision":4,"attributes":{"free_units":400},"created_at":"2021-12-25T07:13:00.000Z"},{"id":"43u190f00820c2b55dab550","license_id":"11f334d44829a0c32aae965","account_id":"608180e37820b0e474dea550","product_id":"898232a32r463b0d474dde443","pricing":{"price":1200,"currency":"USD"},"quantity":2,"start_date":"2022-01-01T00:00:00.000Z","end_date":"2022-09-11T00:00:00.000Z","revision_start_date":"2022-05-01T00:00:00.000Z","revision":8,"attributes":{"free_units":600},"created_at":"2021-01-01T07:13:00.000Z"}]}}},"Licenses with expand":{"value":{"page":1,"per_page":50,"count":1,"total":1,"_links":{"self":{"href":"https://api-docs.talkdesk.org/provisioning/account/licenses?page=2&per_page=3&revision_status=ALL"}},"_embedded":{"licenses":[{"id":"56u780e37820b0c32dea550","license_id":"76a657e37820b0c32dea630","account_id":"6268273bcebab0e4fd3431c1","product_id":"8ad084a67c8caf3a017c9464a1ad3c21","pricing":{"price":225,"currency":"USD"},"quantity":1,"start_date":"2022-05-03T00:00:00.000Z","end_date":"2023-05-03T00:00:00.000Z","revision_start_date":"2022-05-03T00:00:00.000Z","revision":1,"attributes":{"free_units":0},"created_at":"2022-05-03T10:53:51.378Z","_embedded":{"seats_in_use":1,"product":{"id":"8ad084a67c8caf3a017c9464a1ad3c21","name":"Talkdesk Phone Add-On","family":"Add-On","model":"Named","manageable":true,"apps":[{"app_id":"58bab6011bbb42c58a189a2aa9802403","subscription_id":"93db5a754fd24d80b6d894ba22442bb0"}],"connectors":[{"type":"Salesforce"}]}}}]}}}}}}},"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":{"Bad Request":{"value":{"code":"2030400","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":"2030401","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":"2030403","message":"Forbidden"}}}}}}},"/provisioning/account/licenses/{license_id}/seats":{"get":{"operationId":"GetLicenseSeats","summary":"List seats for a license","description":"Returns a paged list of seats for a given license","x-internal":true,"security":[{"EarlyAccess":["seats:read"]}],"tags":["Seat Manager"],"parameters":[{"in":"path","name":"license_id","description":"Uniquely identifies the acquisition of a specific product by a customer within an account.","required":true,"schema":{"type":"string","minLength":1,"maxLength":255}},{"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 seats per page. Defaults to 50.","required":false,"schema":{"type":"integer","minimum":1,"maximum":50,"default":50}}],"responses":{"200":{"description":"Returns a paged list of seats for a given license. It also contains the license information","content":{"application/json":{"schema":{"type":"object","required":["page","per_page","count","total","_links","_embedded"],"properties":{"page":{"type":"integer","description":"The current page","minimum":1,"maximum":1000000},"per_page":{"type":"integer","description":"The number of elements of seats per Page","minimum":1,"maximum":50},"count":{"type":"integer","description":"The number of seats present in the current Page","minimum":0,"maximum":1000000},"total":{"type":"integer","description":"The total number of seats","minimum":0,"maximum":1000000},"_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":["seats","license"],"properties":{"seats":{"type":"array","description":"Seats assigned to a license, displayed in an array","items":{"type":"object","required":["id","account_id","license_id","user_id","created_at"],"properties":{"id":{"type":"string","description":"Unique identifier for the seat id. Automatically generated.","minLength":1,"maxLength":255},"account_id":{"type":"string","description":"Talkdesk account identifier (Talkdesk ID)","minLength":1,"maxLength":255},"license_id":{"type":"string","description":"Uniquely identifies the acquisition of a specific product by a customer within an account.","minLength":1,"maxLength":255},"user_id":{"type":"string","description":"Identifier for the user that the seat is assigned to","minLength":1,"maxLength":255},"created_at":{"type":"string","format":"date-time"}}}},"license":{"type":"object","required":["id","license_id","account_id","product_id","pricing","quantity","start_date","end_date","revision_start_date","revision","attributes","created_at"],"properties":{"id":{"type":"string","description":"Unique identifier for the license revision. Automatically generated."},"license_id":{"type":"string","description":"Uniquely identifies the acquisition of a specific product by a customer within an account."},"account_id":{"type":"string","description":"Talkdesk account identifier (Talkdesk ID)."},"product_id":{"type":"string","description":"Unique identifier of a product and the set of technical artifacts associated with it."},"pricing":{"type":"object","description":"The acquisition price for the specific product for this specific license revision. Could include amount and currency. (not used at the moment)"},"quantity":{"type":"integer","description":"Number of licenses acquired (also referred as seats in named model, and installations for apps).","minimum":0,"maximum":1000000},"start_date":{"type":"string","format":"date-time","description":"The date in which the account will be entitled to use this product."},"end_date":{"type":"string","format":"date-time","description":"The date in which the account will cease to be entitled to use this license."},"revision_start_date":{"type":"string","format":"date-time","description":"The moment in time this licenses revision becomes effective. From this date forward this license revision and all the properties it defines are effective. Each time a change is made for a specific license it creates a revision. This field is the date on which changes will be effective. Allows to perform changes in the future.\n"},"revision":{"type":"integer","description":"Revision is an incremental number that represents a version of the same license (same license_id). For every change made in this object the revision will be automatically incremented.","minimum":0,"maximum":1000000},"attributes":{"type":"object","description":"Metadata or extra properties that we want to assign to a specific License Revision."},"created_at":{"type":"string","format":"date-time"}}}}}}},"example":{"page":1,"per_page":50,"count":3,"total":3,"_links":{"self":{"href":"https://api-docs.talkdesk.org/provisioning/account/licenses?page=1&per_page=50&revision_status=ALL"},"first":{"href":"https://api-docs.talkdesk.org/provisioning/account/licenses?page=1&per_page=50&revision_status=ALL"},"last":{"href":"https://api-docs.talkdesk.org/provisioning/account/licenses?page=1&per_page=50&revision_status=ALL"}},"_embedded":{"seats":[{"id":"a10117b6-e162-4864-a80f-2f3d9a28354a","account_id":"608180e37820b0e474dea550","license_id":"43u190f00820c2b55dab550","user_id":"1234","created_at":"2022-07-26T09:00:00.000Z"},{"id":"7010d7e4-f6fc-4a6a-94ea-87a4ee8e3e88","account_id":"608180e37820b0e474dea550","license_id":"43u190f00820c2b55dab550","user_id":"2345","created_at":"2022-07-26T09:00:00.000Z"},{"id":"c722a599-813d-4b91-8d78-d8650b9f136c","account_id":"608180e37820b0e474dea550","license_id":"43u190f00820c2b55dab550","user_id":"3456","created_at":"2022-07-26T09:00:00.000Z"}],"license":{"id":"43u190f00820c2b55dab550","license_id":"11f334d44829a0c32aae965","account_id":"608180e37820b0e474dea550","product_id":"898232a32r463b0d474dde443","pricing":{"price":1200,"currency":"USD"},"quantity":2,"start_date":"2022-01-01T00:00:00.000Z","end_date":"2023-09-11T00:00:00.000Z","revision_start_date":"2022-05-01T00:00:00.000Z","revision":8,"attributes":{"free_units":600},"created_at":"2022-01-01T00:00:00.000Z"}}}}}},"400":{"description":"Bad request. See response examples","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Bad Request":{"value":{"code":"2030400","message":"Invalid data"}},"Too Many Operations":{"value":{"code":"2031400","message":"Too many operations to perform"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2030401","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":"2030403","message":"Forbidden"}}}},"404":{"description":"License not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2030404","message":"Not found"}}}}}},"post":{"operationId":"AssignLicenseSeat","summary":"Assign seat to user","description":"Assigns a seat to the specified user for the given license","x-internal":true,"security":[{"EarlyAccess":["seats:write"]}],"tags":["Seat Manager"],"parameters":[{"in":"path","name":"license_id","description":"Uniquely identifies the acquisition of a specific product by a customer within an account.","required":true,"schema":{"type":"string","minLength":1,"maxLength":255}},{"in":"query","name":"user_id","description":"User identifier that this operation will act on","required":true,"schema":{"type":"string","minLength":1,"maxLength":255}}],"responses":{"200":{"description":"The user had already an assigned seat for the given license, no new assigments were made","content":{"application/json":{"schema":{"type":"object","required":["id","account_id","license_id","user_id","created_at"],"properties":{"id":{"type":"string","description":"Unique identifier for the seat id. Automatically generated.","minLength":1,"maxLength":255},"account_id":{"type":"string","description":"Talkdesk account identifier (Talkdesk ID)","minLength":1,"maxLength":255},"license_id":{"type":"string","description":"Uniquely identifies the acquisition of a specific product by a customer within an account.","minLength":1,"maxLength":255},"user_id":{"type":"string","description":"Identifier for the user that the seat is assigned to","minLength":1,"maxLength":255},"created_at":{"type":"string","format":"date-time"}}},"example":{"id":"a10117b6-e162-4864-a80f-2f3d9a28354a","account_id":"608180e37820b0e474dea550","license_id":"43u190f00820c2b55dab550","user_id":"1234","created_at":"2022-07-26T09:00:00.000Z"}}}},"201":{"description":"A seat was assigned successfully to the specified user for the given license","content":{"application/json":{"schema":{"type":"object","required":["id","account_id","license_id","user_id","created_at"],"properties":{"id":{"type":"string","description":"Unique identifier for the seat id. Automatically generated.","minLength":1,"maxLength":255},"account_id":{"type":"string","description":"Talkdesk account identifier (Talkdesk ID)","minLength":1,"maxLength":255},"license_id":{"type":"string","description":"Uniquely identifies the acquisition of a specific product by a customer within an account.","minLength":1,"maxLength":255},"user_id":{"type":"string","description":"Identifier for the user that the seat is assigned to","minLength":1,"maxLength":255},"created_at":{"type":"string","format":"date-time"}}},"example":{"id":"a10117b6-e162-4864-a80f-2f3d9a28354a","account_id":"608180e37820b0e474dea550","license_id":"43u190f00820c2b55dab550","user_id":"1234","created_at":"2022-07-26T09:00:00.000Z"}}}},"400":{"description":"Bad request. See response examples","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Bad Request":{"value":{"code":"2030400","message":"Invalid data"}},"Too Many Operations":{"value":{"code":"2031400","message":"Too many operations to perform"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2030401","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":"2030403","message":"Forbidden"}}}},"404":{"description":"License not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2030404","message":"Not found"}}}},"409":{"description":"Conflict. See response examples","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"License Not Active":{"value":{"code":"2030409","message":"The license is not active"}},"No Available Seats":{"value":{"code":"2031409","message":"The license has no available seats"}}}}}}}},"delete":{"operationId":"RemoveLicenseSeat","summary":"Remove user's license seat","description":"Removes the specified user's seat for the given license","x-internal":true,"security":[{"EarlyAccess":["seats:write"]}],"tags":["Seat Manager"],"parameters":[{"in":"path","name":"license_id","description":"Uniquely identifies the acquisition of a specific product by a customer within an account.","required":true,"schema":{"type":"string","minLength":1,"maxLength":255}},{"in":"query","name":"user_id","description":"User identifier that this operation will act on","required":true,"schema":{"type":"string","minLength":1,"maxLength":255}}],"responses":{"204":{"description":"Seat assignment removed for the specified user. This response is also returned in case the seat does not exists or has already been removed."},"400":{"description":"Bad request. See response examples","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Bad Request":{"value":{"code":"2030400","message":"Invalid data"}},"Too Many Operations":{"value":{"code":"2031400","message":"Too many operations to perform"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2030401","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":"2030403","message":"Forbidden"}}}},"404":{"description":"License not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2030404","message":"Not found"}}}}}}},"/provisioning/account/licenses/{license_id}/seats/bulk":{"post":{"operationId":"BulkManageLicenseSeats","summary":"Manage License seats in Bulk","description":"Assigns and/or releases seats of multiple users for a given license.","x-internal":true,"security":[{"EarlyAccess":["seats:write"]}],"tags":["Seat Manager"],"parameters":[{"in":"path","name":"license_id","description":"Uniquely identifies the acquisition of a specific product by a customer within an account.","required":true,"schema":{"type":"string","minLength":1,"maxLength":255}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"remove":{"type":"array","description":"List of users to release seats. Although there is a limit of 10 000 users per operation.","items":{"type":"string","minLength":1,"maxLength":255}},"add":{"type":"array","description":"List of users to assign seats. Although there is a limit of 10 000 users per operation.","items":{"type":"string","minLength":1,"maxLength":255}}}},"example":{"remove":["25658ebbcdb24a58b942893b111ac4de","45658eb5cdb24a5fb942893b111ac4de"],"add":["95658eb8cdb24a58b94c893b111ac4ff"]}}}},"responses":{"200":{"description":"Operation completed successfully.","content":{"application/json":{"schema":{"type":"object","required":["available","assigned"],"properties":{"available":{"type":"integer","description":"Total number of available seats","minimum":0,"maximum":1000000},"assigned":{"type":"integer","description":"Total number of used seats","minimum":0,"maximum":1000000}}},"example":{"available":3,"assigned":7}}}},"400":{"description":"Bad request. See response examples","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Bad Request":{"value":{"code":"2030400","message":"Invalid data"}},"Too Many Operations":{"value":{"code":"2031400","message":"Too many operations to perform"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2030401","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":"2030403","message":"Forbidden"}}}},"404":{"description":"License not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2030404","message":"Not found"}}}},"409":{"description":"Conflict. See response examples","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"License Not Active":{"value":{"code":"2030409","message":"The license is not active"}},"No Available Seats":{"value":{"code":"2031409","message":"The license has no available seats"}}}}}}}}},"/provisioning/account/licenses/{license_id}/users":{"get":{"operationId":"GetLicenseUsers","summary":"List users with seat flag","description":"Returns a paged list of users with a flag indicating if the user has an assigned seat","x-internal":true,"security":[{"EarlyAccess":["seats:read"]}],"parameters":[{"in":"path","name":"license_id","description":"Uniquely identifies the acquisition of a specific product by a customer within an account.","required":true,"schema":{"type":"string","minLength":1,"maxLength":255}},{"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","description":"Allows filtering by using comparison and logical operators.

    There are 3 possibilities for comparing values:
    • For exact match on any data type, eq operator should be used.
    • To get all users that don't match a specific value, ne operator should be used.
    • To search parts of a string within a field of type string then the contains operator should be used.
      The syntax is the following: contains(field, 'value')
      • Important: operator contains can only be used with fields name, email and ring_groups.

    Logical operators are and and or.
    When using multiple ANDs and ORs, you should use parentheses to explicitly define the logical operators evaluation order.
    (note: this is recommended because the usual precedence rules aren't supported due to an implementation detail).

    Examples:
    • (contains(name, 'foo') or contains(email, 'bar')) and active eq true
    • contains(name, 'foobar') and ring_groups eq 'emergency'
    More information here","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024}},{"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.
    Examples:
    • name:desc
    • name
    • email:asc
    ","required":false,"schema":{"type":"string","default":"created_at desc","minLength":1,"maxLength":255}}],"tags":["Seat Manager"],"responses":{"200":{"description":"User List","content":{"application/json":{"schema":{"example":{"_embedded":{"users":[{"id":"5b34eb0cdcba1b000bdbd320","email":"paulo@talkdesk.com","name":"Paulo Omni","active":true,"created_at":"2018-06-28T14:05:00Z","role_id":"5b34eb0cdcba1b000bdbd320","role":"Administrator","confirmed":true,"team":"Test","team_id":"a3c4f5b549f84793900f7f668a7ce5c6","seat":true,"license_ids":["56u780e37820b0c32dea550"]}]},"count":1,"total":2,"page":1,"per_page":1,"total_pages":2,"_links":{"self":{"href":"http://api-docs.talkdesk.org/provisioning/account/licenses/{license_id}/users?page=1&per_page=20"},"next":{"href":"http://api-docs.talkdesk.org/provisioning/account/licenses/{license_id}/users?page=2&per_page=20"}}},"allOf":[{"type":"object","required":["count","total","page","per_page","total_pages"],"properties":{"count":{"type":"integer","description":"The number of users present in the current page","minimum":0,"maximum":1000000},"total":{"type":"integer","description":"The total number of users in the account","minimum":0,"maximum":1000000},"page":{"type":"integer","description":"The current page","minimum":1,"maximum":1000000},"per_page":{"type":"integer","description":"The number of elements of users per page","minimum":1,"maximum":250},"total_pages":{"type":"integer","description":"The number of the total result pages","minimum":0,"maximum":1000000},"_embedded":{"type":"object","required":["users"],"properties":{"users":{"type":"array","description":"The results displayed in an array","items":{"type":"object","required":["id","email","name","active","seat"],"properties":{"id":{"type":"string","minLength":1,"maxLength":255,"description":"The Id of the user"},"email":{"type":"string","minLength":1,"maxLength":255,"description":"The e-mail of the user"},"name":{"type":"string","minLength":1,"maxLength":255,"description":"The name of the user"},"active":{"type":"boolean","description":"The activation state of the user"},"created_at":{"type":"string","format":"date-time","description":"The date for the creation of the user"},"role_id":{"type":"string","minLength":1,"maxLength":255,"description":"The current role identifier of the user"},"role":{"type":"string","minLength":1,"maxLength":255,"description":"The current role of the user"},"confirmed":{"type":"boolean","description":"Indicates whether the user has confirmed the email or not"},"team":{"type":"string","minLength":1,"maxLength":255,"description":"The team to which the user belongs"},"team_id":{"type":"string","minLength":1,"maxLength":255,"description":"The team identifier of the user's team"},"seat":{"type":"boolean","description":"Indicates whether the user has an assigned seat or not"}}}}}},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","required":["href"],"description":"The link to the current page","properties":{"href":{"type":"string","description":"The hypertext reference describing this link"}}},"next":{"type":"object","required":["href"],"description":"The link to the next page","properties":{"href":{"type":"string","description":"The hypertext reference describing this link"}}},"prev":{"type":"object","required":["href"],"description":"The link to the previous page","properties":{"href":{"type":"string","description":"The hypertext reference describing this link"}}}}}}},{"type":"object"}],"properties":{"_embedded":{"type":"object","properties":{"users":{"type":"array","description":"The results displayed in an array","items":{"type":"object","required":["id","email","name","active","seat"],"properties":{"id":{"type":"string","minLength":1,"maxLength":255,"description":"The Id of the user"},"email":{"type":"string","minLength":1,"maxLength":255,"description":"The e-mail of the user"},"name":{"type":"string","minLength":1,"maxLength":255,"description":"The name of the user"},"active":{"type":"boolean","description":"The activation state of the user"},"created_at":{"type":"string","format":"date-time","description":"The date for the creation of the user"},"role_id":{"type":"string","minLength":1,"maxLength":255,"description":"The current role identifier of the user"},"role":{"type":"string","minLength":1,"maxLength":255,"description":"The current role of the user"},"confirmed":{"type":"boolean","description":"Indicates whether the user has confirmed the email or not"},"team":{"type":"string","minLength":1,"maxLength":255,"description":"The team to which the user belongs"},"team_id":{"type":"string","minLength":1,"maxLength":255,"description":"The team identifier of the user's team"},"seat":{"type":"boolean","description":"Indicates whether the user has an assigned seat or not"}}}}}}}}}}},"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":{"Invalid Account Id":{"value":{"code":"0040009","message":"Missing Account Information"}},"Query Parsing Failed":{"value":{"code":"0040013","message":"Query parsing failed"}},"Invalid Search Term Length":{"value":{"code":"0040014","message":"Invalid search term length"}}}}}},"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":"0040011","message":"Missing Authorization Header"}}}},"403":{"description":"Invalid scopes","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"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":"0040010","message":"Forbidden"}},"Invalid Token":{"value":{"code":"0040012","message":"Invalid Authorization Token"}}}}}},"404":{"description":"License not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2030404","message":"Not found"}}}},"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":"0040007","message":"Accept MIME type not supported"}}}}}}},"/provisioning/account/assets/{asset_type}/{asset_id}/seats/users":{"get":{"operationId":"GetAssetSeatUsers","summary":"List assigned seat users asset","description":"Returns a paged list of users with an assigned seat for a given asset","x-internal":true,"security":[{"EarlyAccess":["seats:read"]}],"parameters":[{"in":"path","name":"asset_type","description":"Identifies the type of asset we want to look up. Options:\n * `app` - It's an application asset.\n","required":true,"schema":{"type":"string","minLength":1,"maxLength":255,"enum":["app"]}},{"in":"path","name":"asset_id","description":"Identifies the specific asset we want to look up.","required":true,"schema":{"type":"string","minLength":1,"maxLength":255}},{"in":"query","name":"expand","description":"Enriches the response with additional license and product information","required":false,"schema":{"type":"boolean","default":false}},{"in":"query","name":"filter","description":"Allows filtering by using comparison and logical operators.

    Currently, we only support the operator in ( ) and the field user_id:
    • user_id in ('5b34eb0cdcba1b000bdbd320', '5b34eb0cdcba1b000bdbd321')
    ","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"x-operators":["( )"]}},{"in":"query","name":"page","schema":{"type":"integer","default":1,"minimum":1}},{"in":"query","name":"per_page","schema":{"type":"integer","default":50,"minimum":1,"maximum":200}}],"tags":["Seat Manager"],"responses":{"200":{"description":"Return Users List","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"type":"object","required":["count","total","page","per_page","total_pages"],"properties":{"count":{"type":"integer","description":"The number of users present in the current page","minimum":0,"maximum":1000000},"total":{"type":"integer","description":"The total number of users in the account","minimum":0,"maximum":1000000},"page":{"type":"integer","description":"The current page","minimum":1,"maximum":1000000},"per_page":{"type":"integer","description":"The number of elements of users per page","minimum":1,"maximum":250},"total_pages":{"type":"integer","description":"The number of the total result pages","minimum":0,"maximum":1000000},"_embedded":{"type":"object","required":["users"],"properties":{"users":{"type":"array","description":"The results displayed in an array","items":{"type":"object","required":["id","email","name","active","seat"],"properties":{"id":{"type":"string","minLength":1,"maxLength":255,"description":"The Id of the user"},"email":{"type":"string","minLength":1,"maxLength":255,"description":"The e-mail of the user"},"name":{"type":"string","minLength":1,"maxLength":255,"description":"The name of the user"},"active":{"type":"boolean","description":"The activation state of the user"},"created_at":{"type":"string","format":"date-time","description":"The date for the creation of the user"},"role_id":{"type":"string","minLength":1,"maxLength":255,"description":"The current role identifier of the user"},"role":{"type":"string","minLength":1,"maxLength":255,"description":"The current role of the user"},"confirmed":{"type":"boolean","description":"Indicates whether the user has confirmed the email or not"},"team":{"type":"string","minLength":1,"maxLength":255,"description":"The team to which the user belongs"},"team_id":{"type":"string","minLength":1,"maxLength":255,"description":"The team identifier of the user's team"},"seat":{"type":"boolean","description":"Indicates whether the user has an assigned seat or not"}}}}}},"_links":{"type":"object","required":["self"],"properties":{"self":{"type":"object","required":["href"],"description":"The link to the current page","properties":{"href":{"type":"string","description":"The hypertext reference describing this link"}}},"next":{"type":"object","required":["href"],"description":"The link to the next page","properties":{"href":{"type":"string","description":"The hypertext reference describing this link"}}},"prev":{"type":"object","required":["href"],"description":"The link to the previous page","properties":{"href":{"type":"string","description":"The hypertext reference describing this link"}}}}}}},{"type":"object"}],"properties":{"_embedded":{"type":"object","properties":{"users":{"type":"array","description":"The results displayed in an array","items":{"allOf":[{"type":"object","required":["id","email","name","active","seat"],"properties":{"id":{"type":"string","minLength":1,"maxLength":255,"description":"The Id of the user"},"email":{"type":"string","minLength":1,"maxLength":255,"description":"The e-mail of the user"},"name":{"type":"string","minLength":1,"maxLength":255,"description":"The name of the user"},"active":{"type":"boolean","description":"The activation state of the user"},"created_at":{"type":"string","format":"date-time","description":"The date for the creation of the user"},"role_id":{"type":"string","minLength":1,"maxLength":255,"description":"The current role identifier of the user"},"role":{"type":"string","minLength":1,"maxLength":255,"description":"The current role of the user"},"confirmed":{"type":"boolean","description":"Indicates whether the user has confirmed the email or not"},"team":{"type":"string","minLength":1,"maxLength":255,"description":"The team to which the user belongs"},"team_id":{"type":"string","minLength":1,"maxLength":255,"description":"The team identifier of the user's team"},"seat":{"type":"boolean","description":"Indicates whether the user has an assigned seat or not"}}},{"type":"object","properties":{"license_ids":{"type":"array","description":"List of license identifiers that granted the seat to this user.","items":{"type":"string"}}}}]}}}}}},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"licenses":{"type":"array","description":"List of licenses and products information","items":{"allOf":[{"type":"object","required":["id","license_id","account_id","product_id","pricing","quantity","start_date","end_date","revision_start_date","revision","attributes","created_at"],"properties":{"id":{"type":"string","description":"Unique identifier for the license revision. Automatically generated."},"license_id":{"type":"string","description":"Uniquely identifies the acquisition of a specific product by a customer within an account."},"account_id":{"type":"string","description":"Talkdesk account identifier (Talkdesk ID)."},"product_id":{"type":"string","description":"Unique identifier of a product and the set of technical artifacts associated with it."},"pricing":{"type":"object","description":"The acquisition price for the specific product for this specific license revision. Could include amount and currency. (not used at the moment)"},"quantity":{"type":"integer","description":"Number of licenses acquired (also referred as seats in named model, and installations for apps).","minimum":0,"maximum":1000000},"start_date":{"type":"string","format":"date-time","description":"The date in which the account will be entitled to use this product."},"end_date":{"type":"string","format":"date-time","description":"The date in which the account will cease to be entitled to use this license."},"revision_start_date":{"type":"string","format":"date-time","description":"The moment in time this licenses revision becomes effective. From this date forward this license revision and all the properties it defines are effective. Each time a change is made for a specific license it creates a revision. This field is the date on which changes will be effective. Allows to perform changes in the future.\n"},"revision":{"type":"integer","description":"Revision is an incremental number that represents a version of the same license (same license_id). For every change made in this object the revision will be automatically incremented.","minimum":0,"maximum":1000000},"attributes":{"type":"object","description":"Metadata or extra properties that we want to assign to a specific License Revision."},"created_at":{"type":"string","format":"date-time"}}},{"type":"object","required":["_embedded"],"properties":{"_embedded":{"type":"object","properties":{"product":{"type":"object","description":"Product info","required":["id","name","family","manageable"],"properties":{"id":{"type":"string","description":"The unique identifier of a product on the Product Catalog Mapper."},"name":{"type":"string","description":"The name of the product."},"family":{"type":"string","description":"The family this product belongs to.","enum":["License","Add-On","Partner","Standalone"]},"model":{"type":"string","description":"The license model associated with the product.","enum":["Named"]},"manageable":{"type":"boolean","description":"Indicates if the seat manager is enabled for this product."},"apps":{"type":"array","description":"A dictionary array that represents an app installation is triggered whenever a license is provisioned for this product.","items":{"type":"object","required":["app_id","subscription_id"],"properties":{"app_id":{"type":"string","description":"The app identifier in app-connect (marketplace)"},"subscription_id":{"type":"string","description":"The subscription plan identifier to be used for the installation of the app"}}}},"connectors":{"type":"array","description":"An array of objects that contains all the connectors associated with this product.","items":{"type":"object","properties":{"type":{"type":"string","description":"Connector associated with a product."}}}}}}}}}}]}}}}}}]},"examples":{"Users without expand":{"value":{"_embedded":{"users":[{"id":"5b34eb0cdcba1b000bdbd320","email":"paulo@talkdesk.com","name":"Paulo Omni","active":true,"created_at":"2018-06-28T14:05:00Z","role_id":"5b34eb0cdcba1b000bdbd320","role":"Administrator","confirmed":true,"team":"Test","team_id":"a3c4f5b549f84793900f7f668a7ce5c6","seat":true}]},"count":1,"total":2,"page":1,"per_page":1,"total_pages":2,"_links":{"self":{"href":"http://api-docs.talkdesk.org/provisioning/account/licenses/{license_id}/users?page=1&per_page=20"},"next":{"href":"http://api-docs.talkdesk.org/provisioning/account/licenses/{license_id}/users?page=2&per_page=20"}}}},"Users with expand":{"value":{"_embedded":{"users":[{"id":"5b34eb0cdcba1b000bdbd320","email":"paulo@talkdesk.com","name":"Paulo Omni","active":true,"created_at":"2018-06-28T14:05:00Z","role_id":"5b34eb0cdcba1b000bdbd320","role":"Administrator","confirmed":true,"team":"Test","team_id":"a3c4f5b549f84793900f7f668a7ce5c6","seat":true}],"licenses":[{"id":"56u780e37820b0c32dea550","license_id":"76a657e37820b0c32dea630","account_id":"6268273bcebab0e4fd3431c1","product_id":"8ad084a67c8caf3a017c9464a1ad3c21","pricing":{"price":225,"currency":"USD"},"quantity":1,"start_date":"2022-05-03T00:00:00.000Z","end_date":"2023-05-03T00:00:00.000Z","revision_start_date":"2022-05-03T00:00:00.000Z","revision":1,"attributes":{"free_units":0},"created_at":"2022-05-03T10:53:51.378Z","_embedded":{"product":{"id":"8ad084a67c8caf3a017c9464a1ad3c21","name":"Talkdesk Phone Add-On","family":"Add-On","model":"Named","manageable":true,"apps":[{"app_id":"58bab6011bbb42c58a189a2aa9802403","subscription_id":"93db5a754fd24d80b6d894ba22442bb0"}]}}}]},"count":1,"total":2,"page":1,"per_page":1,"total_pages":2,"_links":{"self":{"href":"http://api-docs.talkdesk.org/provisioning/account/licenses/{license_id}/users?page=1&per_page=20"},"next":{"href":"http://api-docs.talkdesk.org/provisioning/account/licenses/{license_id}/users?page=2&per_page=20"}}}}}}}},"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":{"Invalid Account Id":{"value":{"code":"0040009","message":"Missing Account Information"}},"Query Parsing Failed":{"value":{"code":"0040013","message":"Query parsing failed"}},"Invalid Search Term Length":{"value":{"code":"0040014","message":"Invalid search term length"}},"Unsupported filter":{"value":{"code":"2032400","message":"Unsupported filter"}}}}}},"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":"0040011","message":"Missing Authorization Header"}}}},"403":{"description":"Invalid scopes","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"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":"0040010","message":"Forbidden"}},"Invalid Token":{"value":{"code":"0040012","message":"Invalid Authorization Token"}}}}}},"404":{"description":"Not Found. See response examples","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Asset type not found":{"value":{"code":"2031404","message":"Asset type not found"}},"Asset not found":{"value":{"code":"2032404","message":"Asset not found"}},"Asset not found in account":{"value":{"code":"2033404","message":"Asset not found for account"}},"Manageable asset not found":{"value":{"code":"2035404","message":"Manageable asset not found"}}}}}},"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":"0040007","message":"Accept MIME type not supported"}}}}}}},"/provisioning/account/licenses/seats/{user_id}":{"delete":{"operationId":"RemoveUserSeats","summary":"Remove user's existing seats","description":"Removes the specified user's existing seats","x-internal":true,"security":[{"EarlyAccess":["seats:write"]}],"tags":["Seat Manager"],"parameters":[{"in":"path","name":"user_id","description":"Uniquely identifies a user within an account.","required":true,"schema":{"type":"string","minLength":1,"maxLength":255}}],"responses":{"204":{"description":"Seats assignment removed for the specified user. This response is also returned in case user has no assigned seats or they have already been removed"},"400":{"description":"Bad request. See response examples","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Bad Request":{"value":{"code":"2030400","message":"Invalid data"}},"Too Many Operations":{"value":{"code":"2031400","message":"Too many operations to perform"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2030401","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":"2030403","message":"Forbidden"}}}}}}},"/provisioning/account/licenses/seats":{"post":{"operationId":"AssignAccountSeats","summary":"Assign seats to users","description":"Assigns a seat for the given users in any available license","x-internal":true,"security":[{"EarlyAccess":["seats:write"]}],"tags":["Seat Manager"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["user_ids"],"properties":{"user_ids":{"type":"array","minItems":1,"maxItems":100,"description":"List of users to assign a seat","items":{"type":"string","minLength":1,"maxLength":255}}}},"example":{"user_ids":["user_1","user_2","user_3"]}}}},"responses":{"200":{"description":"Operation completed","content":{"application/json":{"schema":{"type":"object","required":["result"],"properties":{"result":{"type":"array","description":"List of users with the operation result value","items":{"type":"object","required":["user_id","success"],"properties":{"user_id":{"type":"string"},"success":{"type":"boolean"},"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}}}},"example":{"result":[{"user_id":"user_1","success":true},{"user_id":"user_2","success":true},{"user_id":"user_3","success":false,"error":{"code":"2031409","message":"No seats available"}}]}}}},"400":{"description":"Bad request. See examples.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"examples":{"Bad request":{"value":{"code":"2030400","message":"Bad Request"}},"Invalid size":{"value":{"code":"2030400","message":"Bad Request","fields":[{"name":"userIds"},{"description":"size must be between 1 and 100"}]}},"Invalid element":{"value":{"code":"2030400","message":"Bad Request","fields":[{"name":"userIds[0]"},{"description":"must not be blank"}]}},"Missing required parameter":{"value":{"code":"2030400","message":"Bad Request","fields":[{"name":"userIds"},{"description":"missing required parameter"}]}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"2030401","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":"2030403","message":"Forbidden"}}}}}}},"/billing/account/subscription":{"get":{"operationId":"GetAccountSubscription","x-internal":true,"summary":"Get subscription","description":"Retrieves the aggregated and simplified information of the account subscription, including the product plan name, agent license count, contract duration, and renewal status.","security":[{"EarlyAccess":["licenses:read"]}],"tags":["Billing"],"responses":{"200":{"description":"Aggregated subscription details for the account, including product plan, license count, and contract dates.","content":{"application/json":{"schema":{"type":"object","properties":{"account_id":{"type":"string","description":"The unique identifier for the account."},"subscription_product_name":{"type":"string","description":"The name of the subscription product plan (e.g., 'Enterprise', 'Professional')."},"agent_license_count":{"type":"number","description":"The total number of agent licenses included in the subscription."},"duration":{"type":"integer","description":"The duration of the subscription contract."},"duration_units":{"type":"string","description":"The unit of measure for the subscription duration (e.g., 'month')."},"start_at":{"type":"string","format":"date-time","description":"The start date of the subscription in ISO 8601 format."},"finish_at":{"type":"string","format":"date-time","description":"The end date of the subscription in ISO 8601 format."},"auto_renew":{"type":"boolean","description":"Whether the subscription automatically renews at the end of the current term."},"_links":{"type":"object","description":"The related links.","properties":{"self":{"type":"object","description":"The URI of the subscription details.","properties":{"href":{"type":"string","description":"The URI value."}}}}}}},"example":{"account_id":"5ea85c4add27ae00017585eb","subscription_product_name":"Enterprise","agent_license_count":10,"duration":12,"duration_units":"month","start_at":"2020-04-20T00:00:00.000Z","finish_at":"2021-04-20T00:00:00.000Z","auto_renew":true,"_links":{"self":{"href":"https://api-docs.talkdesk.org/billing/account/subscription/"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0120003","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":"0120043","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":"0120008","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":"0120050","message":"An error has occurred, please contact Talkdesk support"}}}}}}},"/billing/account/subscription/licenses":{"get":{"operationId":"GetAccountSubscriptionLicenses","x-internal":true,"summary":"List subscription licenses","description":"Retrieves all licenses associated with the account subscription. Each license includes pricing, seat usage, billing period, and product family information.","security":[{"EarlyAccess":["licenses:read"]}],"tags":["Billing"],"responses":{"200":{"description":"A list of all licenses associated with the account subscription, including pricing, seat usage, and billing details.","content":{"application/json":{"schema":{"type":"object","properties":{"_embedded":{"type":"object","properties":{"licenses":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for an account subscription license."},"friendly_name":{"type":"string","description":"A human-readable display name for the license."},"billing_period":{"type":"string","description":"The billing cycle frequency for this license.","enum":["MONTH","QUARTER","SEMI_ANNUAL","ANNUAL","TWO_YEAR","THREE_YEAR","FIVE_YEAR"]},"quantity":{"type":"integer","description":"The total number of seats purchased for this license."},"price":{"type":"integer","description":"The price per billing period for this license."},"self_service":{"type":"boolean","description":"Indicates whether the customer can make a self-service purchase of this license."},"product_family":{"type":"string","description":"The product family category for this license.","enum":["ADD_ON","LICENSE","THIRD_PARTY_APP_CONNECT"]},"next_billing_date":{"type":"string","format":"date-time","description":"The next billing date for this license in ISO 8601 format."},"seats_in_use":{"type":"integer","description":"The total number of seats currently in use for this license."},"manageable_seats":{"type":"boolean","description":"Indicates whether Seat Manager is enabled for this product."},"_links":{"type":"object","description":"The related links.","properties":{"self":{"type":"object","description":"The URI of the license details.","properties":{"href":{"type":"string","description":"The URI value."}}}}}}}},"account":{"type":"object","properties":{"currency":{"type":"string","description":"The currency used to charge the account that follows the ISO 4217"}}}}},"_links":{"type":"object","description":"The related links.","properties":{"self":{"type":"object","description":"The URI of the subscription licenses collection.","properties":{"href":{"type":"string","description":"The URI value."}}},"account":{"type":"object","description":"The URI of the billing account.","properties":{"href":{"type":"string","description":"The URI value."}}}}}}},"example":{"_embedded":{"licenses":[{"id":"601ad1d92eac5100015928d8","friendly_name":"CX Cloud Licenses","billing_period":"ANNUAL","quantity":10,"price":10000,"self_service":false,"product_family":"LICENSE","next_billing_date":"2022-03-21T00:00:00.000Z","seats_in_use":10,"manageable_seats":true,"_links":{"self":{"href":"https://api-docs.talkdesk.org/billing/account/subscription/licenses/601ad1d92eac5100015928d8"}}}],"account":{"currency":"USD"}},"_links":{"self":{"href":"https://api-docs.talkdesk.org/billing/account/subscription/licenses/"},"account":{"href":"https://api-docs.talkdesk.org/account/billing"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0120003","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":"0120043","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":"0120008","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":"0120050","message":"An error has occurred, please contact Talkdesk support"}}}}}}},"/billing/account/subscription/licenses/{id}":{"get":{"operationId":"GetAccountSubscriptionLicenseDetails","x-internal":true,"summary":"Get subscription license details","description":"Retrieves detailed information about a specific subscription license, including rate plan details, pricing, currency, and contract start and end dates.","security":[{"EarlyAccess":["licenses:read"]}],"parameters":[{"name":"id","in":"path","description":"The unique identifier for an account subscription license.","required":true,"schema":{"type":"string","example":"2c92c0f94d65a21d014d6ca280895ca8"}}],"tags":["Billing"],"responses":{"200":{"description":"Detailed information about a specific subscription license, including rate plan details, pricing, and contract dates.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for an account subscription license."},"product_rate_plan_id":{"type":"string","description":"The unique identifier of the product rate plan in the billing system."},"product_rate_plan_name":{"type":"string","description":"The name of the product rate plan (e.g., 'Annual Licenses - Enterprise')."},"friendly_name":{"type":"string","description":"A human-readable display name for the license."},"product_family":{"type":"string","description":"The product family category for this license.","enum":["ADD_ON","LICENSE","THIRD_PARTY_APP_CONNECT"]},"product_rate_plan_description":{"type":"string","description":"A detailed description of the product rate plan."},"billing_period":{"type":"string","description":"The billing cycle frequency for this license.","enum":["MONTH","QUARTER","SEMI_ANNUAL","ANNUAL","TWO_YEAR","THREE_YEAR","FIVE_YEAR"]},"quantity":{"type":"integer","description":"The total number of seats purchased for this license."},"price":{"type":"integer","description":"The price per billing period for this license, in the smallest currency unit (e.g., cents)."},"currency":{"type":"string","description":"The currency used to charge the account, following the ISO 4217 standard."},"self_service":{"type":"boolean","description":"Defines if the customer can make a self-service purchase of this license."},"start_at":{"type":"string","format":"date-time","description":"The start date of the license contract in ISO 8601 format."},"finish_at":{"type":"string","format":"date-time","description":"The end date of the license contract in ISO 8601 format."},"next_billing_date":{"type":"string","format":"date-time","description":"The next billing date for this license in ISO 8601 format."},"_links":{"type":"object","description":"The related links.","properties":{"self":{"type":"object","description":"The URI of the license details.","properties":{"href":{"type":"string","description":"The URI value."}}}}}}},"example":{"id":"2c92c0f94d65a21d014d6ca280895ca8","product_rate_plan_id":"2c92c0f94d65a21d014d6ca280895ca7","product_rate_plan_name":"Annual Licenses - Enterprise","friendly_name":"Talkdesk Licenses","product_family":"LICENSE","product_rate_plan_description":"A Talkdesk License Enterprise with an Annual billing period","billing_period":"ANNUAL","quantity":10,"price":10000,"currency":"USD","self_service":true,"start_at":"2021-03-20T00:00:00.000Z","finish_at":"2022-03-20T00:00:00.000Z","next_billing_date":"2022-03-21T00:00:00.000Z","_links":{"self":{"href":"https://api-docs.talkdesk.org/billing/account/subscription/licenses/604a712f265cbb0001579bd8"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}},"example":{"code":"0120003","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":"0120043","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":"0120008","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":"0120050","message":"An error has occurred, please contact Talkdesk support"}}}}}}}},"components":{"securitySchemes":{"GA":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://{account_name}.talkdeskid.com/oauth/authorize","tokenUrl":"https://{account_name}.talkdeskid.com/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-email-validation:read":"Identity Email Validation read access","identity-ip-validation:read":"Identity IP Validation read access","identity-phone-validation:read":"Identity Phone Validation read access","openid":"User info endpoint","recordings:read":"Get recording files","recordings:delete":"Delete 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","queues:read":"List CCAAS queues","queues:write":"Create/update CCAAS queues details","queues-users:read":"List users assigned to a CCAAS queue","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","do-not-call-lists:read":"Read entries in 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","role-permissions:skip":"Skip role permissions validation","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","erc-ecommerce-cart:write":"Sync e-commerce cart items","erc-ecommerce-products:read":"Search e-commerce catalog products","erc-ecommerce-orders:read":"Show e-commerce integrations orders info","erc-ecommerce-orders:write":"Update e-commerce integrations orders 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 (Deprecated - use hls-patient-password-reset:write)","hls-patient-password-reset:write":"Trigger patient password reset for healthcare portal","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","hls-guarantor-billing:read":"Read guarantor billing summary from providers","hls-guarantor-password-reset:write":"Trigger guarantor password reset for healthcare portal","hls-patient-billing:read":"Read patient billing details from providers","hls-interaction-overrides:write":"Write healthcare & life sciences interaction-specific configuration overrides","industries-workflows:read":"Read industries workflow schedules and workflows","industries-workflows:write":"Create, update, start, and delete industries workflow schedules and workflows"}}}},"Deprecated":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://{account_name}.talkdeskid.com/oauth/authorize","tokenUrl":"https://{account_name}.talkdeskid.com/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":"https://{account_name}.talkdeskid.com/oauth/authorize","tokenUrl":"https://{account_name}.talkdeskid.com/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","attachments:download":"Generate a download link that gives temporary access to the attachment data","studio-callbacks:read":"List studio callbacks","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","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-connection-execution:write":"Execute a digital connection action","digital-byob-webhook:write":"Reply, Escalate and Resolve Digital interactions via BYOB","digital-messaging-adapter:write":"Write or update Digital Messaging Adapter data","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","outbound-notifications:write":"Send outbound notification messages","campaign-message:write":"Send campaign message","licenses:read":"Get the account licenses","seats:read":"Get seats information of a license","seats:write":"Add or remove seats from a license"}}}}}},"tags":[{"name":"Accounts API","description":" Account related resources"},{"name":"Usage-Manager API","description":" Usage-Manager API"},{"name":"Apps API","description":" Apps API"},{"name":"Attachments","description":" Attachments API for public digital attachments"},{"name":"Attributes API","description":" API for managing attributes and attribute categories, including user-attribute assignments"},{"name":"Bulk Import API","description":" Bulk Import API"},{"name":"Ring Groups API","description":" API for managing ring groups and agent ring group assignments"},{"name":"Recordings API","description":" Recordings API"},{"name":"Callback API","description":" Callback API"},{"name":"Contacts API","description":" Contacts API"},{"name":"Omnichannel API","description":" Omnichannel API"},{"name":"Campaign Management API","description":" Campaign Management API"},{"name":"Events API","description":" Events API"},{"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 API","description":" Flows API"},{"name":"Flows Platform","description":" Trigger and manage automation flows"},{"name":"Guardian API","description":" Guardian API"},{"name":"Identity API","description":" Identity API"},{"name":"Messages","description":" "},{"name":"Numbers","description":" Numbers (legacy - DEPRECATED) listing and details resources"},{"name":"Authentication","description":" Authentication API"},{"name":"Record Lists API","description":" Record Lists API"},{"name":"Explore API","description":" Explore API"},{"name":"Live API","description":" Live API"},{"name":"Users API","description":" Users API"},{"name":"Presence","description":" "},{"name":"SCIM API","description":" SCIM API"},{"name":"FSI Integrations API","description":" FSI Integrations API"},{"name":"Automated Notifications","description":" "},{"name":"Financial Services Experience Cloud for Banking","description":" Financial Services Experience Cloud for Banking API"},{"name":"HLS Providers","description":" "},{"name":"Industries External Entity Mapper","description":" API responsible for mapping external entities"},{"name":"Appointment scheduling service","description":" "},{"name":"WFM","description":" "},{"name":"Scheduled Time Off API","description":" Scheduled Time Off API"},{"name":"Schedule Event Import API","description":" Schedule Event Import API"},{"name":"WFM Request Management API","description":" WFM Request Management API"},{"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":"Case API","description":" Case API"},{"name":"Digital Connect API","description":" Digital Connect API endpoints related to Conversations, create, update and manage conversations"},{"name":"Phone Details","description":" Phone details retrieval service"},{"name":"Financial Services Experience Cloud for Insurance","description":" Financial Services Experience Cloud for Insurance API"},{"name":"Feedback API","description":" API for collecting and managing customer feedback data"},{"name":"Schedule Callbacks","description":" Schedule Callbacks"},{"name":"Studio Callback","description":" APIs for querying and managing studio callback scheduling"},{"name":"HLS Payers","description":" "},{"name":"HLS Sycurio Integration","description":" "},{"name":"Proactive Outbound Client Custom Automations","description":" Provides record list custom automations for specific clients, based in proactive outbound events"},{"name":"Webhook Trigger API","description":" Manage webhook triggers for event-driven integrations"},{"name":"Billing Insights API","description":" Billing Insights API"},{"name":"EXPRESS API","description":" EXPRESS API"},{"name":"Simulated Email API","description":" Simulated Email API"},{"name":"Prompts API","description":" Rest API for audio prompts management"},{"name":"Retail Experience Cloud Integrations","description":" Endpoints of the ERC ECommerce Shopify Webhooks Handler and connections service"},{"name":"Retail Experience Cloud Bridge","description":" Retail Experience Cloud Bridge API endpoints"},{"name":"User Status API","description":" API for querying and updating agent availability status in the contact center"},{"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 API","description":" Rest API that will support industries-scheduler-admin-app"},{"name":"Industries Messaging Service","description":" API for managing messages"},{"name":"industries-workflows","description":" Schedule, start, and observe workflows for industries"},{"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":"Outbound Notifications API","description":" API responsible for sending outbound notification messages through multiple channels, utilizing various message types."},{"name":"Campaign Messages","description":" API responsible for sending bulk campaign messages through multiple channels."},{"name":"Dialer Integrations","description":" "},{"name":"Licenses Manager","description":" Responsible for managing the account's licenses"},{"name":"Seat Manager","description":" Responsible for managing the account's licenses seats"},{"name":"Billing","description":" "}],"externalDocs":{"description":"External Documentation","url":"https://api-docs.talkdeskapp.com/external_docs"}}